summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-03-29 15:12:07 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-03-29 15:12:07 -0400
commite62f9816ab29dceb5489d520b9cf569ede2ffb52 (patch)
tree97563eafbe702e834a1f32b38f6218bd4a4c831e /doc
parent0a4c610b4fd78f7d1589117cb723d7d8c15c120c (diff)
doc update for S3
Diffstat (limited to 'doc')
-rw-r--r--doc/special_remotes/Amazon_S3.mdwn6
-rw-r--r--doc/walkthrough/using_Amazon_S3.mdwn20
2 files changed, 19 insertions, 7 deletions
diff --git a/doc/special_remotes/Amazon_S3.mdwn b/doc/special_remotes/Amazon_S3.mdwn
index 42c4a5453..c8e44b609 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 a99746c95..34c843b18 100644
--- a/doc/walkthrough/using_Amazon_S3.mdwn
+++ b/doc/walkthrough/using_Amazon_S3.mdwn
@@ -2,18 +2,26 @@ 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.
+**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"
+ # export ANNEX_S3_ACCESS_KEY_ID="08TJMT99S3511WOZEP91"
+ # export ANNEX_S3_SECRET_ACCESS_KEY="s3kr1t"
-Next, create the remote.
+Next, create the S3 remote.
- git annex initremote mys3 type=S3 encryption=none
+ # 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.**
+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.