summaryrefslogtreecommitdiff
path: root/doc/special_remotes/rsync.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-09-04 23:46:50 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-09-04 23:46:50 -0400
commit2f3b108d49c534e828cec8adceef7defc942b67f (patch)
treea900acd6ed02e6342b76f1fe11294c889e62ff08 /doc/special_remotes/rsync.mdwn
parent652f4069fc1ddc7b5cef4fa40865997210cf7a7a (diff)
update docs for changed initremote encryption syntax
Diffstat (limited to 'doc/special_remotes/rsync.mdwn')
-rw-r--r--doc/special_remotes/rsync.mdwn14
1 files changed, 5 insertions, 9 deletions
diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn
index 581ac6b96..b2a9d23f5 100644
--- a/doc/special_remotes/rsync.mdwn
+++ b/doc/special_remotes/rsync.mdwn
@@ -2,26 +2,22 @@ This special remote type rsyncs file contents to somewhere else.
Setup example:
- # git annex initremote myrsync type=rsync rsyncurl=rsync://rsync.example.com/myrsync encryption=joey@kitenet.net
+ # git annex initremote myrsync type=rsync rsyncurl=rsync://rsync.example.com/myrsync keyid=joey@kitenet.net
# git annex describe myrsync "rsync server"
Or for using rsync over SSH
- # git annex initremote myrsync type=rsync rsyncurl=ssh.example.com:/myrsync encryption=joey@kitenet.net
+ # git annex initremote myrsync type=rsync rsyncurl=ssh.example.com:/myrsync keyid=joey@kitenet.net
# git annex describe myrsync "rsync server"
## configuration
These parameters can be passed to `git annex initremote` to configure rsync:
-* `encryption` - Required. Either "none" to disable encryption of content
- stored on the remote rsync server,
- or a value that can be looked up (using gpg -k) to find a gpg encryption
- key that will be given access to the remote, or "shared" which allows
- every clone of the repository to decrypt the encrypted data.
+* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
+ See [[encryption]].
- Note that additional gpg keys can be given access to a remote by
- running enableremote with the new key id. See [[encryption]].
+* `keyid` - Specifies the gpg key to use for [[encryption]].
* `rsyncurl` - Required. This is the url or `hostname:/directory` to
pass to rsync to tell it where to store content.