added documentation for using the Internet Archive as a remote via S3

Renamed Amazon_S3 page to just S3.

1 files changed, 37 insertions, 0 deletions

diff --git a/doc/special_remotes/S3.mdwn b/doc/special_remotes/S3.mdwn
new file mode 100644
index 000000000..35397dc2a
--- /dev/null
+++ b/doc/special_remotes/S3.mdwn
@@ -0,0 +1,37 @@
+This special remote type stores file contents in a bucket in Amazon S3
+or a similar service, such as 
+[Archive.org's S3 API](http://www.archive.org/help/abouts3.txt).
+
+See [[walkthrough/using_Amazon_S3]] for usage examples.
+
+## configuration
+
+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. Note that additional gpg
+  keys can be given access to a remote by rerunning initremote with
+  the new key id. See [[encryption]].
+
+* `datacenter` - Defaults to "US". Other values include "EU",
+  "us-west-1", and "ap-southeast-1".
+
+* `storageclass` - Default is "STANDARD". If you have configured git-annex
+  to preserve multiple [[copies]], consider setting this to "REDUCED_REDUNDANCY"
+  to save money.
+
+* `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.
+
+The standard environment variables `ANNEX_S3_ACCESS_KEY_ID` and 
+`ANNEX_S3_SECRET_ACCESS_KEY` can be used to supply login credentials
+for Amazon. When encryption is enabled, they are stored in encrypted form
+by `git annex initremote`, so you do not need to keep the environment
+variables set after the initial initalization of the remote.