summaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar Joey Hess <id@joeyh.name>2014-12-03 14:02:29 -0400
committerGravatar Joey Hess <id@joeyh.name>2014-12-03 14:10:52 -0400
commit69957946eaa066406a243edca8fd3e19e7febfee (patch)
tree7ce300577cd986f4f03b5f81446a188916e75097 /doc/special_remotes
parentab9bb79e8f0eaa8d951d46e82b321f8511ded942 (diff)
parent718932c895b38228ab8aed4477d7ce8bba205e5a (diff)
Merge branch 's3-aws'
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/S3.mdwn22
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/special_remotes/S3.mdwn b/doc/special_remotes/S3.mdwn
index fe46948b3..5d161c3b8 100644
--- a/doc/special_remotes/S3.mdwn
+++ b/doc/special_remotes/S3.mdwn
@@ -18,11 +18,11 @@ the S3 remote.
* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
See [[encryption]].
+* `keyid` - Specifies the gpg key to use for [[encryption]].
+
* `chunk` - Enables [[chunking]] when storing large files.
`chunk=1MiB` is a good starting point for chunking.
-* `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
the default when gpg encryption is enabled; the credentials are stored
@@ -33,7 +33,8 @@ the S3 remote.
embedcreds without gpg encryption.
* `datacenter` - Defaults to "US". Other values include "EU",
- "us-west-1", and "ap-southeast-1".
+ "us-west-1", "us-west-2", "ap-southeast-1", "ap-southeast-2", and
+ "sa-east-1".
* `storageclass` - Default is "STANDARD". If you have configured git-annex
to preserve multiple [[copies]], consider setting this to "REDUCED_REDUNDANCY"
@@ -46,11 +47,24 @@ the S3 remote.
so by default, a bucket name is chosen based on the remote name
and UUID. This can be specified to pick a bucket name.
+* `partsize` - Amazon S3 only accepts uploads up to a certian file size,
+ and storing larger files requires a multipart upload process.
+
+ Setting `partsize=1GiB` is recommended for Amazon S3 when not using
+ chunking; this will cause multipart uploads to be done using parts
+ up to 1GiB in size. Note that setting partsize to less than 100MiB
+ will cause Amazon S3 to reject uploads.
+
+ This is not enabled by default, since other S3 implementations may
+ not support multipart uploads or have different limits,
+ but can be enabled or changed at any time.
+ time.
+
* `fileprefix` - By default, git-annex places files in a tree rooted at the
top of the S3 bucket. When this is set, it's prefixed to the filenames
used. For example, you could set it to "foo/" in one special remote,
and to "bar/" in another special remote, and both special remotes could
then use the same bucket.
-* `x-amz-*` are passed through as http headers when storing keys
+* `x-amz-meta-*` are passed through as http headers when storing keys
in S3.