56 lines
No EOL
2.5 KiB
Markdown
56 lines
No EOL
2.5 KiB
Markdown
|
|
|
|
|
|
# TileServer GL
|
|
[](https://travis-ci.org/klokantech/tileserver-gl)
|
|
[](https://hub.docker.com/r/klokantech/tileserver-gl/)
|
|
|
|
Vector and raster maps with GL styles. Server side rendering by Mapbox GL Native. Map tile server for Mapbox GL JS, Android, iOS, Leaflet, OpenLayers, GIS via WMTS, etc.
|
|
|
|
## Get Started
|
|
|
|
Make sure you have Node.js version **6** installed (running `node -v` it should output something like `v6.11.3`).
|
|
|
|
Install `tileserver-gl` with server-side raster rendering of vector tiles with npm
|
|
|
|
```bash
|
|
npm install -g tileserver-gl
|
|
```
|
|
|
|
Now download vector tiles from [OpenMapTiles](https://openmaptiles.org/downloads/).
|
|
|
|
```bash
|
|
curl -o zurich_switzerland.mbtiles https://openmaptiles.os.zhdk.cloud.switch.ch/v3.3/extracts/zurich_switzerland.mbtiles
|
|
```
|
|
|
|
Start `tileserver-gl` with the downloaded vector tiles.
|
|
|
|
```bash
|
|
tileserver-gl zurich_switzerland.mbtiles
|
|
```
|
|
|
|
Alternatively, you can use the `tileserver-gl-light` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization on the server side made with MapBox GL Native.
|
|
|
|
## Using Docker
|
|
|
|
An alternative to npm to start the packed software easier is to install [Docker](http://www.docker.com/) on your computer and then run in the directory with the downloaded MBTiles the command:
|
|
|
|
```bash
|
|
docker run --rm -it -v $(pwd):/data -p 8080:80 klokantech/tileserver-gl
|
|
```
|
|
|
|
This will download and start a ready to use container on your computer and the maps are going to be available in webbrowser on localhost:8080.
|
|
|
|
On laptop you can use [Docker Kitematic](https://kitematic.com/) and search "tileserver-gl" and run it, then drop in the 'data' folder the MBTiles.
|
|
|
|
## Documentation
|
|
|
|
You can read full documentation of this project at http://tileserver.readthedocs.io/.
|
|
|
|
## Offline development to fix styles
|
|
|
|
Tool and instructions: https://openmaptiles.org/docs/style/maputnik/
|
|
Run the `maputnik` executable to start a server on `localhost:8000`, open your browser and visit the address.
|
|
|
|
To inspect and make temporary changes to our styles you can load them using the live tileJSON URLs either for dev or prod.
|
|
To load the map data that we use make sure you use the live URL that points to the data OSM2Vector tileJSON. |