Get started

1. Download Vector Tiles

Head over to the downloads page and download the vector tiles for your region or the planet.

wget https://.../zurich_switzerland.mbtiles

2. Run a Tileserver

To serve the tiles to your mobile or web client you need to choose a tileserver for your platform and configure it to serve the previously downloaded vector tiles.

  • Node.js
  • Docker
  • CDN

Using tileserver-gl you can immediately serve vector tiles including a web viewer and sample styles.
The light version tileserver-gl-light can be easily installed using npm.

npm install -g tileserver-gl-light

Now run tileserver-gl-light together with the previously downloaded vector tiles

tileserver-gl-light zurich_switzerland.mbtiles

Open in your web browser the local address http://localhost:8080.

Read the Tileserver GL tutorial for more in-depth information.

The full version of tileserver-gl has the capabilities to fall back to serve raster tiles for interoperability with other clients. The raster tiles are rendered on demand. This makes it harder to install, so we recommend usage of docker.

To install a tileserver serving both vector and raster tiles we recommend to use the offical Docker image of tileserver-gl. By launching the docker with the command bellow, you mount the active directory with the previously downloaded MBTiles file with vector tiles and expose the tile server to a local port 8080.
docker run -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl

Read the Tileserver GL tutorial for more in-depth information.

OpenMapTiles.com provides a free CDN for non-commercial and demonstration purposes. Once you sign in, you can create an access key and can use the TileJSON endpoint of the CDN in the rendering clients.

https://free.tilehosting.com/data/v3.json?key={access_key}

Read the CDN tutorial for more in-depth information.
If you need fast and reliable tile serving for your production applications OpenMapTiles.com also provides a paid CDN service and other complimentary services.

3. Choose a Style

Once you have your own vector tile server running you can choose one of the many styles supporting the OpenMapTiles schema.

After you downloaded the style, point the endpoint URL to your tileserver and embedd it in a mobile app or web viewer. You can also create your own styles using Maputnik.

K

OpenMapTiles.org is an open-source project from Klokan Technologies GmbH and OSM community
Share this page on