mirror of
https://github.com/maptiler/tileserver-gl.git
synced 2024-09-11 12:05:41 +03:00
416d78356e
* Update package-lock.json run npm audit fix * chore: Update maplibre-gl-js to v4.5.0 * chore: Update maplibre-gl-inspect to v1.7.0 * Update package-lock.json run npm audit fix * chore: put back old docs url which now works * chore: Update version
89 lines
3.7 KiB
Markdown
89 lines
3.7 KiB
Markdown
|
|
|
|
# TileServer GL
|
|
[](https://github.com/maptiler/tileserver-gl/actions/workflows/pipeline.yml)
|
|
[](https://hub.docker.com/r/maptiler/tileserver-gl/)
|
|
|
|
Vector and raster maps with GL styles. Server-side rendering by MapLibre GL Native. Map tile server for MapLibre GL JS, Android, iOS, Leaflet, OpenLayers, GIS via WMTS, etc.
|
|
|
|
Download vector tiles from [OpenMapTiles](https://data.maptiler.com/downloads/planet/).
|
|
## Getting Started with Node
|
|
|
|
Make sure you have Node.js version **18.17.0** or above installed. Node 20 is recommended. (running `node -v` it should output something like `v20.x.x`). Running without docker requires [Native dependencies](https://maptiler-tileserver.readthedocs.io/en/latest/installation.html#npm) to be installed first.
|
|
|
|
Install `tileserver-gl` with server-side raster rendering of vector tiles with npm.
|
|
|
|
```bash
|
|
npm install -g tileserver-gl
|
|
```
|
|
|
|
Once installed, you can use it like the following examples.
|
|
|
|
using a mbtiles file
|
|
```bash
|
|
wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/zurich_switzerland.mbtiles
|
|
tileserver-gl --file zurich_switzerland.mbtiles
|
|
[in your browser, visit http://[server ip]:8080]
|
|
```
|
|
|
|
using a config.json + style + mbtiles file
|
|
```bash
|
|
wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/test_data.zip
|
|
unzip test_data.zip
|
|
tileserver-gl
|
|
[in your browser, visit http://[server ip]:8080]
|
|
```
|
|
|
|
Alternatively, you can use the `tileserver-gl-light` npm 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 Maplibre GL Native.
|
|
|
|
## Getting Started with Docker
|
|
|
|
An alternative to npm to start the packed software easier is to install [Docker](https://www.docker.com/) on your computer and then run from the tileserver-gl directory
|
|
|
|
Example using a mbtiles file
|
|
```bash
|
|
wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/zurich_switzerland.mbtiles
|
|
docker run --rm -it -v $(pwd):/data -p 8080:8080 maptiler/tileserver-gl --file zurich_switzerland.mbtiles
|
|
[in your browser, visit http://[server ip]:8080]
|
|
```
|
|
|
|
Example using a config.json + style + mbtiles file
|
|
```bash
|
|
wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/test_data.zip
|
|
unzip test_data.zip
|
|
docker run --rm -it -v $(pwd):/data -p 8080:8080 maptiler/tileserver-gl
|
|
[in your browser, visit http://[server ip]:8080]
|
|
```
|
|
|
|
Example using a different path
|
|
```bash
|
|
docker run --rm -it -v /your/local/config/path:/data -p 8080:8080 maptiler/tileserver-gl
|
|
```
|
|
replace '/your/local/config/path' with the path to your config file
|
|
|
|
|
|
Alternatively, you can use the `maptiler/tileserver-gl-light` docker image 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 Maplibre GL Native.
|
|
|
|
## Getting Started with Linux cli
|
|
|
|
Test from command line
|
|
```bash
|
|
wget https://github.com/maptiler/tileserver-gl/releases/download/v1.3.0/test_data.zip
|
|
unzip -q test_data.zip -d test_data
|
|
xvfb-run --server-args="-screen 0 1024x768x24" npm test
|
|
```
|
|
|
|
Run from command line
|
|
```bash
|
|
xvfb-run --server-args="-screen 0 1024x768x24" node .
|
|
```
|
|
|
|
## Documentation
|
|
|
|
You can read the full documentation of this project at https://tileserver.readthedocs.io/en/latest/.
|
|
|
|
## Alternative
|
|
|
|
Discover MapTiler Server if you need a [map server with easy setup and user-friendly interface](https://www.maptiler.com/server/).
|
|
|