Merge pull request #626 from transloadit/doc/s3-opts

doc: Document AwsS3 pass-thru options.
This commit is contained in:
Artur Paikin 2018-02-14 17:39:16 -05:00 committed by GitHub
commit 3ffcd2c77d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -43,6 +43,18 @@ When using a POST upload with a policy document, this should be the root URL of
The `fields` field is an object with form fields to send along with the upload request.
For presigned PUT uploads, this should be empty.
### `timeout: 30 * 1000`
When no upload progress events have been received for this amount of milliseconds, assume the connection has an issue and abort the upload. This is passed through to [XHRUpload](/docs/xhrupload#timeout-30-1000); see its documentation page for details.
Set to `0` to disable this check.
The default is 30 seconds.
### `limit: 0`
Limit the amount of uploads going on at the same time. This is passed through to [XHRUpload](/docs/xhrupload#limit-0); see its documentation page for details.
Set to `0` to disable limiting.
## S3 Bucket configuration
S3 buckets do not allow public uploads by default.