summaryrefslogtreecommitdiff
path: root/doc/special_remotes/S3.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/special_remotes/S3.mdwn')
-rw-r--r--doc/special_remotes/S3.mdwn12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/special_remotes/S3.mdwn b/doc/special_remotes/S3.mdwn
index c7c6f76c5..59c1abed7 100644
--- a/doc/special_remotes/S3.mdwn
+++ b/doc/special_remotes/S3.mdwn
@@ -21,10 +21,14 @@ the S3 remote.
* `chunk` - Enables [[chunking]] when storing large files.
`chunk=1MiB` is a good starting point for chunking.
-* `partsize` - Specifies the largest object to attempt to store in the
- bucket. Multipart uploads will be used when storing larger objects.
- This is not enabled by default, but can be enabled or changed at any
- time. Setting `partsize=1GiB` is reasonable for S3.
+* `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; this will
+ cause multipart uploads to be done using parts up to 1GiB in size.
+
+ This is not enabled by default, since other S3 implementations may
+ not support multipart uploads, but can be enabled or changed at any
+ time.
* `keyid` - Specifies the gpg key to use for [[encryption]].