Skip to content

versatiles-org/planetiler-shortbread

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docker Image: Planetiler + Shortbread + VersaTiles

Generate Shortbread‑schema vector tiles from any OpenStreetMap extract with a single command.

Docker Image Size Docker Image Pulls
Planetiler Version


🫵 We need your help!

Preview the latest tiles at https://planetiler.versatiles.org and let us know what you think.

We refresh the demo regularly. Once the config is stable we’ll upstream it to Planetiler.


📦 What’s inside?

Component Version Purpose
Planetiler Latest OSM → vector tiles compiler
Shortbread configuration 1.0 Styling / layer schema
VersaTiles Latest Converts .mbtiles.versatiles containers

The container first writes a Gzip‑compressed .mbtiles file, then automatically converts it to a Brotli‑compressed .versatiles archive.


💪 Supported platforms

linux/amd64 (Intel / AMD) • linux/arm64 (Apple Silicon, Raspberry Pi 4/5, AWS Graviton, …)
Multi‑arch manifests ensure Docker pulls the correct architecture for you.


🚀 Quick start

# Generate planet‑wide tiles
docker run --rm \
  -v "$(pwd)/data:/app/data" \
  versatiles/versatiles-planetiler:latest -a planet

All output is written to the mounted data folder. A full‑planet run needs roughly 300 GB of free disk space.

Command‑line options

Options:
  -h, --help          Show this help message
  -a, --area <name>   Area to process (e.g. "planet", "geofabrik:ukraine", "madrid")

Examples:

# Madrid only (fast)
docker run --rm -v "$(pwd)/data:/app/data" versatiles/versatiles-planetiler:latest -a madrid

📂 Output files

File Description
osm(-…).mbtiles Gzip‑compressed archive produced by Planetiler
osm(-…).versatiles Brotli‑compressed archive produced by VersaTiles

Serve either file with VersaTiles‑server or any compatible server.


🏷️ Image tags

  • latest – current build on main, always using the latest Planetiler release
  • <planetiler‑version> (e.g. 0.9.1) – pinned to that exact Planetiler release
# Pull a specific version
docker pull versatiles/versatiles-planetiler:0.9.1

About

Docker image combining Planetiler and VersaTiles for generating Shortbread vector tiles.

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors