diff --git a/doc/special_remotes/Amazon_S3.mdwn b/doc/special_remotes/Amazon_S3.mdwn index 42c4a54534..c8e44b609c 100644 --- a/doc/special_remotes/Amazon_S3.mdwn +++ b/doc/special_remotes/Amazon_S3.mdwn @@ -8,7 +8,7 @@ See [[walkthrough/using_Amazon_S3]] for usage examples. A number of parameters can be passed to `git annex initremote` to configure the S3 remote. -* `encryption` - Either "none" to disable encryption, +* `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. Note that additional gpg keys can be given access to a remote by rerunning initremote with @@ -24,6 +24,10 @@ the S3 remote. * `host` and `port` - Specify in order to use a different, S3 compatable service. +* `bucket` - S3 requires that buckets have a globally unique name, + so by default, a bucket name is chosen based on the remote name + and UUID. This can be specified to pick a bucket name. + ## data security When encryption=none, there is **no** protection against your data being read diff --git a/doc/walkthrough/using_Amazon_S3.mdwn b/doc/walkthrough/using_Amazon_S3.mdwn index a99746c955..34c843b18f 100644 --- a/doc/walkthrough/using_Amazon_S3.mdwn +++ b/doc/walkthrough/using_Amazon_S3.mdwn @@ -2,19 +2,27 @@ git-annex extends git's usual remotes with some [[special_remotes]], that are not git repositories. This way you can set up a remote using say, Amazon S3, and use git-annex to transfer files into the cloud. -First, export your S3 credentials: - - export ANNEX_S3_ACCESS_KEY_ID="08TJMT99S3511WOZEP91" - export ANNEX_S3_SECRET_ACCESS_KEY="s3kr1t" - -Next, create the remote. - - git annex initremote mys3 type=S3 encryption=none - initremote (creating bucket mys3-291d2fdc-5990-11e0-909a-002170d25c55...) ok - **Note that encrypted buckets are not (yet) supported. Data sent to S3 is without encryption susceptible to snooping.** +First, export your S3 credentials: + + # export ANNEX_S3_ACCESS_KEY_ID="08TJMT99S3511WOZEP91" + # export ANNEX_S3_SECRET_ACCESS_KEY="s3kr1t" + +Next, create the S3 remote. + + # git annex initremote mys3 type=S3 encryption=none + initremote (creating bucket mys3-291d2fdc-5990-11e0-909a-002170d25c55...) ok + +The configuration for the S3 remote is stored in git. So to make a different +repository use the same S3 remote is easy: + + # cd /media/usb/annex + # git pull laptop master + # git annex initremote mys3 + initremote ok + Now the remote can be used like any other remote. # git annex copy my_cool_big_file --to mys3