* feat: replace formatQuality with formatOptions in config file formatQuality is more flexible and allows configuration of more than just quality for all formats. JPEG and WebP still have only their quality configurable. PNG has all the configuration options from the sharp library exposed. Signed-off-by: Nathan Reed <nathreed@gmail.com> * feat: update docs for new formatOptions Signed-off-by: Nathan Reed <nathreed@gmail.com> * feat: allow deprecated formatQuality with logged warning Signed-off-by: Nathan Reed <nathreed@gmail.com> --------- Signed-off-by: Nathan Reed <nathreed@gmail.com> |
||
---|---|---|
.github | ||
.husky | ||
docs | ||
public | ||
src | ||
test | ||
.dockerignore | ||
.eslintignore | ||
.eslintrc.cjs | ||
.gitattributes | ||
.gitignore | ||
.hadolint.yml | ||
.nvmrc | ||
.prettierignore | ||
.readthedocs.yaml | ||
commitlint.config.cjs | ||
docker-entrypoint_light.sh | ||
docker-entrypoint.sh | ||
Dockerfile | ||
Dockerfile_light | ||
Dockerfile_test | ||
ISSUE_TEMPLATE.md | ||
LICENSE.md | ||
lint-staged.config.cjs | ||
package-lock.json | ||
package.json | ||
prettier.config.cjs | ||
publish.js | ||
PUBLISHING.md | ||
README_light.md | ||
README.md |
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.
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 to be installed first.
Install tileserver-gl
with server-side raster rendering of vector tiles with npm.
npm install -g tileserver-gl
Once installed, you can use it like the following examples.
using a mbtiles file
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
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 on your computer and then run from the tileserver-gl directory
Example using a mbtiles file
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
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
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
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
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.