Skip to content

Update README.md #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stevage wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ npm install @mapbox/tilelive-s3
- libpng
- node >= 0.10

Parameters
==========

Tilelive-S3's behaviour can be tweaked by passing through extra URL parameters. For example: `s3://mybucket/path?timeout=10000`

* `timeout`: sets the HTTP timeout in milliseconds (default 2000)
* `acl`: sets the AWS access control (default `private`). Choose `public-read` for publicly readable objects.
* `region`: sets the partition region (eg `cn-north-1`)
* `events`: if `true`, causes events to be emitted
* `sse`, `ssekmid`, `expires`, `cacheControl`: passed onto URI object

Tests
=====

Expand Down