summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Kanakarakis <ivan.kanak@gmail.com>2014-02-24 11:48:17 +0200
committerIvan Kanakarakis <ivan.kanak@gmail.com>2014-02-24 11:53:41 +0200
commite447b22c94087c781c7f75ec09a38c7008771fa8 (patch)
treef7ac30c81f7545c14c8219570f800b6fa298affe
parent771b59355167a40c216de2460147cd182a5dcd78 (diff)
downloadgit-fat-e447b22c94087c781c7f75ec09a38c7008771fa8.tar.gz
Explain rsync with ssh authentication
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index fdd6322..3889ad2 100644
--- a/README.md
+++ b/README.md
@@ -38,8 +38,17 @@ Set a remote store for the fat objects by editing `.gitfat`.
This file should typically be committed to the repository so that others
will automatically have their remote set. This remote address can use
-any protocol supported by rsync. Most users will configure it to use
-remote ssh in a directory with shared access.
+any protocol supported by rsync.
+
+Most users will configure it to use remote ssh in a directory with shared
+access. To do this, set the `sshuser` and `sshport` variables in `.gitfat`
+configuration file. For example, to use rsync with ssh, with the default
+port (22) and authenticate with the user "_fat_", your configuration would
+look like this:
+
+ [rsync]
+ remote = your.remote-host.org:/share/fat-store
+ sshuser = fat
# A worked example