summaryrefslogtreecommitdiff
path: root/doc/special_remotes
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
parent652f4069fc1ddc7b5cef4fa40865997210cf7a7a (diff)
update docs for changed initremote encryption syntax
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/S3.mdwn9
-rw-r--r--doc/special_remotes/bup.mdwn12
-rw-r--r--doc/special_remotes/directory.mdwn9
-rw-r--r--doc/special_remotes/glacier.mdwn9
-rw-r--r--doc/special_remotes/hook.mdwn13
-rw-r--r--doc/special_remotes/rsync.mdwn14
-rw-r--r--doc/special_remotes/webdav.mdwn11
7 files changed, 27 insertions, 50 deletions
diff --git a/doc/special_remotes/S3.mdwn b/doc/special_remotes/S3.mdwn
index e15361f3e..5291a4eb6 100644
--- a/doc/special_remotes/S3.mdwn
+++ b/doc/special_remotes/S3.mdwn
@@ -15,13 +15,10 @@ can read inside the local git repository.
A number of parameters can be passed to `git annex initremote` to configure
the S3 remote.
-* `encryption` - Required. Either "none" to disable encryption (not recommended),
- 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 access the encrypted data (use with caution).
+* `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]].
* `embedcreds` - Optional. Set to "yes" embed the login credentials inside
the git repository, which allows other clones to also access them. This is
diff --git a/doc/special_remotes/bup.mdwn b/doc/special_remotes/bup.mdwn
index f323237b1..f2d465e77 100644
--- a/doc/special_remotes/bup.mdwn
+++ b/doc/special_remotes/bup.mdwn
@@ -19,14 +19,10 @@ for example; or clone bup's git repository to further back it up.
These parameters can be passed to `git annex initremote` to configure bup:
-* `encryption` - Required. Either "none" to disable encryption of content
- stored in bup (ssh will still be used to transport it securely),
- 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 access the encrypted data (use with caution).
-
- Note that additional gpg keys can be given access to a remote by
- running enableremote with the new key id. See [[encryption]].
+* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
+ See [[encryption]].
+
+* `keyid` - Specifies the gpg key to use for [[encryption]].
* `buprepo` - Required. This is passed to `bup` as the `--remote`
to use to store data. To create the repository,`bup init` will be run.
diff --git a/doc/special_remotes/directory.mdwn b/doc/special_remotes/directory.mdwn
index 4f9263dc0..4d72e8bee 100644
--- a/doc/special_remotes/directory.mdwn
+++ b/doc/special_remotes/directory.mdwn
@@ -14,13 +14,10 @@ Instead, you should use a regular `git clone` of your git-annex repository.
These parameters can be passed to `git annex initremote` to configure the
remote:
-* `encryption` - Required. Either "none" to disable encryption,
- 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]].
* `chunksize` - Avoid storing files larger than the specified size in the
directory. For use on directories on mount points that have file size
diff --git a/doc/special_remotes/glacier.mdwn b/doc/special_remotes/glacier.mdwn
index d6dbad59a..b55b9adbb 100644
--- a/doc/special_remotes/glacier.mdwn
+++ b/doc/special_remotes/glacier.mdwn
@@ -21,13 +21,10 @@ can read inside the local git repository.
A number of parameters can be passed to `git annex initremote` to configure
the Glacier remote.
-* `encryption` - Required. Either "none" to disable encryption (not recommended),
- 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 access the encrypted data (use with caution).
+* `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]].
* `embedcreds` - Optional. Set to "yes" embed the login credentials inside
the git repository, which allows other clones to also access them. This is
diff --git a/doc/special_remotes/hook.mdwn b/doc/special_remotes/hook.mdwn
index d5c708e0a..eaea940a7 100644
--- a/doc/special_remotes/hook.mdwn
+++ b/doc/special_remotes/hook.mdwn
@@ -25,17 +25,14 @@ Can you spot the potential data loss bugs in the above simple example?
These parameters can be passed to `git annex initremote`:
-* `encryption` - Required. Either "none" to disable encryption,
- 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 access the encrypted data.
-
- Note that additional gpg keys can be given access to a remote by
- running enableremote with the new key id. See [[encryption]].
-
* `hooktype` - Required. This specifies a collection of hooks to use for
this remote.
+* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
+ See [[encryption]].
+
+* `keyid` - Specifies the gpg key to use for [[encryption]].
+
## hooks
Each type of hook remote is specified by a collection of hook commands.
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.
diff --git a/doc/special_remotes/webdav.mdwn b/doc/special_remotes/webdav.mdwn
index 383fddf75..251075b09 100644
--- a/doc/special_remotes/webdav.mdwn
+++ b/doc/special_remotes/webdav.mdwn
@@ -10,13 +10,10 @@ can read inside the local git repository.
A number of parameters can be passed to `git annex initremote` to configure
the webdav remote.
-* `encryption` - Required. Either "none" to disable encryption (not recommended),
- 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 access the encrypted data (use with caution).
+* `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]].
* `embedcreds` - Optional. Set to "yes" embed the login credentials inside
the git repository, which allows other clones to also access them. This is
@@ -42,4 +39,4 @@ the webdav remote.
Setup example:
- # WEBDAV_USERNAME=joey@kitenet.net WEBDAV_PASSWORD=xxxxxxx git annex initremote box.com type=webdav url=https://www.box.com/dav/git-annex chunksize=75mb encryption=joey@kitenet.net
+ # WEBDAV_USERNAME=joey@kitenet.net WEBDAV_PASSWORD=xxxxxxx git annex initremote box.com type=webdav url=https://www.box.com/dav/git-annex chunksize=75mb keyid=joey@kitenet.net