Skip to content

Commit 5b28f6b

Browse files
alamminsaloalamminsalo
alamminsalo
authored and
alamminsalo
committed
add documentation for s3 uris
1 parent a5702fd commit 5b28f6b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/src/sources-files.md

+19
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,22 @@ martin /path/to/mbtiles/file.mbtiles /path/to/directory https://example.org/
1010

1111
You may also want to generate a [config file](config-file.md) using the `--save-config my-config.yaml`, and later edit
1212
it and use it with `--config my-config.yaml` option.
13+
14+
## S3 Uris
15+
16+
Martin supports authenticated S3 sources using environment variables.
17+
18+
Environment variables that need to be set:
19+
20+
- AWS_ACCESS_KEY_ID
21+
- AWS_SECRET_ACCESS_KEY
22+
- AWS_SESSION_TOKEN
23+
- AWS_REGION
24+
25+
Example configuration:
26+
27+
```
28+
pmtiles:
29+
sources:
30+
tiles: s3://bucket/path/to/tiles.pmtiles
31+
```

0 commit comments

Comments
 (0)