Skip to content

Commit 868d514

Browse files
authored
Adds documentation on how to use config paths with docker, closes #720 (#722)
1 parent 94c0040 commit 868d514

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,36 @@ See an example of a vector tile map produced by tilemaker at [tilemaker.org](htt
1212

1313
We provide a ready-to-use docker image that gets you started without having to compile tilemaker from source:
1414

15-
1. Go to http://download.geofabrik.de/europe.html and download the `monaco-latest.osm.pbf` snapshot of OpenStreetMap
16-
17-
2. Run tilemaker on the OpenStreetMap snapshot to generate [Protomaps](https://protomaps.com) vector tiles:
15+
1. Go to [Geofabrik](http://download.geofabrik.de/europe.html) and download the `monaco-latest.osm.pbf` snapshot of OpenStreetMap
16+
2. Run tilemaker on the OpenStreetMap snapshot to generate [Protomaps](https://protomaps.com) vector tiles (see below)
1817

1918
```
2019
docker run -it --rm -v $(pwd):/data ghcr.io/systemed/tilemaker:master /data/monaco-latest.osm.pbf --output /data/monaco-latest.pmtiles
2120
```
2221

2322
3. Check out what's in the vector tiles e.g. by using the debug viewer [here](https://protomaps.github.io/PMTiles/)
2423

24+
To run tilemaker with its default configuration
25+
26+
```bash
27+
docker run -it --rm --pull always -v $(pwd):/data \
28+
ghcr.io/systemed/tilemaker:master \
29+
/data/monaco-latest.osm.pbf \
30+
--output /data/monaco-latest.pmtiles
31+
```
32+
33+
To run tilemaker with a custom configuration using coastlines and landcover you have two options
34+
1. In the config.json use absolute paths such as `/data/coastline/water_polygons.shp` or
35+
2. Set the docker workdir `-w /data` with relative paths `coastline/water_polygons.shp` (see below)
36+
37+
```bash
38+
docker run -it --rm --pull always -v $(pwd):/data -w /data \
39+
ghcr.io/systemed/tilemaker:master \
40+
/data/monaco-latest.osm.pbf \
41+
--output /data/monaco-latest.pmtiles \
42+
--config /data/config-coastline.json \
43+
--process /data/process-coastline.lua
44+
```
2545

2646
## Installing
2747

0 commit comments

Comments
 (0)