Skip to content

Commit

Permalink
Adds documentation on how to use config paths with docker, closes sys…
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-j-h committed May 15, 2024
1 parent b89b0eb commit c170a53
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,23 @@ See an example of a vector tile map produced by tilemaker at [tilemaker.org](htt
We provide a ready-to-use docker image that gets you started without having to compile tilemaker from source:

1. Go to http://download.geofabrik.de/europe.html and download the `monaco-latest.osm.pbf` snapshot of OpenStreetMap
2. Run tilemaker on the OpenStreetMap snapshot to generate [Protomaps](https://protomaps.com) vector tiles (see below)
3. Check out what's in the vector tiles e.g. by using the debug viewer [here](https://protomaps.github.io/PMTiles/)

2. Run tilemaker on the OpenStreetMap snapshot to generate [Protomaps](https://protomaps.com) vector tiles:
To run tilemaker with its default configuration

docker run -it --rm -v (pwd):/data ghcr.io/systemed/tilemaker:master /data/monaco-latest.osm.pbf --output /data/monaco-latest.pmtiles
```bash
docker run -it --rm --pull always -v $(pwd):/data ghcr.io/systemed/tilemaker:master /data/monaco-latest.osm.pbf --output /data/monaco-latest.pmtiles
```

3. Check out what's in the vector tiles e.g. by using the debug viewer [here](https://protomaps.github.io/PMTiles/)
To run tilemaker with custom configuration for coastlines and landcover you have two options
1. In the config.json use absolute paths such as `/data/coastline/water_polygons.shp` or
2. Use the docker workdir option `-w /data` with relative paths such as `coastline/water_polygons.shp` (see below)

```bash
docker run -it --rm --pull always -v $(pwd):/data -w /data ghcr.io/systemed/tilemaker:master /data/monaco-latest.osm.pbf --output /data/monaco-latest.pmtiles --config /data/config-
coastline.json --process /data/process-coastline.lua
```

## Installing

Expand Down

0 comments on commit c170a53

Please sign in to comment.