diff options
author | Joey Hess <joey@kitenet.net> | 2013-04-26 18:22:44 -0400 |
---|---|---|
committer | Joey Hess <joey@kitenet.net> | 2013-04-26 18:22:52 -0400 |
commit | 8d7348fe1be96f95eda6c8cf386b54825e0b69fd (patch) | |
tree | 30cd1c58fcd6766573892873a2cd7f9fa999c196 /doc | |
parent | ee51adad7bdad29e77e5d51a192c8de5653fd06e (diff) |
To enable an existing special remote, the new enableremote command must be used. The initremote command now is used only to create new special remotes.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/encryption.mdwn | 4 | ||||
-rw-r--r-- | doc/git-annex.mdwn | 37 | ||||
-rw-r--r-- | doc/special_remotes/S3.mdwn | 2 | ||||
-rw-r--r-- | doc/special_remotes/bup.mdwn | 2 | ||||
-rw-r--r-- | doc/special_remotes/directory.mdwn | 2 | ||||
-rw-r--r-- | doc/special_remotes/glacier.mdwn | 2 | ||||
-rw-r--r-- | doc/special_remotes/hook.mdwn | 2 | ||||
-rw-r--r-- | doc/special_remotes/rsync.mdwn | 4 | ||||
-rw-r--r-- | doc/special_remotes/webdav.mdwn | 2 |
9 files changed, 41 insertions, 16 deletions
diff --git a/doc/encryption.mdwn b/doc/encryption.mdwn index 5349e8c7a..d93bee9d2 100644 --- a/doc/encryption.mdwn +++ b/doc/encryption.mdwn @@ -31,10 +31,10 @@ non-empty remote. The [[encryption_design|design/encryption]] allows additional encryption keys to be added on to a special remote later. Once a key is added, it is able to access content that has already been stored in the special remote. -To add a new key, just run `git annex initremote` again, specifying the +To add a new key, just run `git annex enableremote` specifying the new encryption key: - git annex initremote myremote encryption=788A3F4C + git annex enableremote myremote encryption=788A3F4C Note that once a key has been given access to a remote, it's not possible to revoke that access, short of deleting the remote. See diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 05ca4474a..8cab00ac8 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -236,15 +236,40 @@ subdirectories). * initremote name [param=value ...] - Sets up a special remote. The remote's - configuration is specified by the parameters. If a remote - with the specified name has already been configured, its configuration - is modified by any values specified. In either case, the remote will be - added to `.git/config`. + Creates a new special remote, and adds it to `.git/config`. + + The remote's configuration is specified by the parameters. Different + types of special remotes need different configuration values. The + command will prompt for parameters as needed. + + All special remotes support encryption. You must either specify + encryption=none to disable encryption, or use encryption=keyid + (or encryption=emailaddress) to specify a gpg key that can access + the encrypted special remote. Example Amazon S3 remote: - initremote mys3 type=S3 encryption=none datacenter=EU + git annex initremote mys3 type=S3 encryption=me@example.com datacenter=EU + +* enableremote name [param=value ...] + + Enables use of an existing special remote in the current repository, + which may be a different repository than the one in which it was + originally created with the initremote command. + + The name of the remote is the same name used when origianlly + creating that remote with "initremote". Run "git annex enableremote" + with no parameters to get a list of special remote names. + + Some special remotes may need parameters to be specified every time. + For example, the directory special remote requires a directory= parameter. + + This command can also be used to modify the configuration of an existing + special remote, by specifying new values for parameters that were originally + set when using initremote. For example, to add a new gpg key to the keys + that can access an encrypted remote: + + git annex initremote mys3 encryption=friend@example.com * trust [repository ...] diff --git a/doc/special_remotes/S3.mdwn b/doc/special_remotes/S3.mdwn index 5a7ecc25b..e15361f3e 100644 --- a/doc/special_remotes/S3.mdwn +++ b/doc/special_remotes/S3.mdwn @@ -21,7 +21,7 @@ the S3 remote. 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 - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[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 ec444912c..f323237b1 100644 --- a/doc/special_remotes/bup.mdwn +++ b/doc/special_remotes/bup.mdwn @@ -26,7 +26,7 @@ These parameters can be passed to `git annex initremote` to configure bup: 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 - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[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 7fdfdfca0..d23c1ae26 100644 --- a/doc/special_remotes/directory.mdwn +++ b/doc/special_remotes/directory.mdwn @@ -16,7 +16,7 @@ remote: every clone of the repository to decrypt the encrypted data. Note that additional gpg keys can be given access to a remote by - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[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 79c3c38b1..d6dbad59a 100644 --- a/doc/special_remotes/glacier.mdwn +++ b/doc/special_remotes/glacier.mdwn @@ -27,7 +27,7 @@ the Glacier remote. 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 - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[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 6867edb8f..d17fae4c8 100644 --- a/doc/special_remotes/hook.mdwn +++ b/doc/special_remotes/hook.mdwn @@ -31,7 +31,7 @@ These parameters can be passed to `git annex initremote`: every clone of the repository to access the encrypted data. Note that additional gpg keys can be given access to a remote by - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[encryption]]. * `hooktype` - Required. This specifies a collection of hooks to use for this remote. diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn index f98c80a83..641faf474 100644 --- a/doc/special_remotes/rsync.mdwn +++ b/doc/special_remotes/rsync.mdwn @@ -21,7 +21,7 @@ These parameters can be passed to `git annex initremote` to configure rsync: every clone of the repository to decrypt the encrypted data. Note that additional gpg keys can be given access to a remote by - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[encryption]]. * `rsyncurl` - Required. This is the url or `hostname:/directory` to pass to rsync to tell it where to store content. @@ -31,7 +31,7 @@ These parameters can be passed to `git annex initremote` to configure rsync: setups, but not with some hosting providers that do not expose rsynced filenames to the shell. You'll know you need this option if `git annex get` from the special remote fails with an error message containing a single - quote (`'`) character. If that happens, you can re-run initremote + quote (`'`) character. If that happens, you can run enableremote setting shellescape=no. The `annex-rsync-options` git configuration setting can be used to pass diff --git a/doc/special_remotes/webdav.mdwn b/doc/special_remotes/webdav.mdwn index 570b6f949..383fddf75 100644 --- a/doc/special_remotes/webdav.mdwn +++ b/doc/special_remotes/webdav.mdwn @@ -16,7 +16,7 @@ the webdav remote. 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 - rerunning initremote with the new key id. See [[encryption]]. + running enableremote with the new key id. See [[encryption]]. * `embedcreds` - Optional. Set to "yes" embed the login credentials inside the git repository, which allows other clones to also access them. This is |