tileserver-gl/docs/installation.rst
Andrew Calcutt 2a94190bd1
Update Maplibre-Native to v5.3.0 (#1124)
* update to maplibre-gl-native 5.3.0-pre.0

* use ubuntu:jammy

* use node 20 in docker image

* update max node version to 20

* update docs to reflect new requirements

* fix: update workflows to ubuntu-22.04

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

* chore: update to maplibre-gl-native 5.3.0

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

* chore: update version

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

* docs: update OS/package information

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

* fix: require node-addon-api ^7

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

* fix: update package-lock.json

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>

---------

Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>
2024-01-15 17:46:22 -05:00

65 lines
2.0 KiB
ReStructuredText

============
Installation
============
Docker
======
When running docker image, no special installation is needed -- the docker will automatically download the image if not present.
Just run ``docker run --rm -it -v $(pwd):/data -p 8080:8080 maptiler/tileserver-gl``.
Additional options (see :doc:`/usage`) can be passed to the TileServer GL by appending them to the end of this command. You can, for example, do the following:
* ``docker run ... maptiler/tileserver-gl --file my-tiles.mbtiles`` -- explicitly specify which mbtiles to use (if you have more in the folder)
* ``docker run ... maptiler/tileserver-gl --verbose`` -- to see the default config created automatically
npm
===
npm is supported on the following platforms with `Native Dependencies <#id1>`_ installed.
- Operating systems:
- Ubuntu 22.04 (x64/arm64)
- macOS 12 (x64/arm64)
- Windows (x64)
- Node.js 18,20
Install globally from npmjs.
------------------------------
::
npm install -g tileserver-gl
tileserver-gl
Install locally from source
-------------------
::
git clone https://github.com/maptiler/tileserver-gl.git
cd tileserver-gl
npm install
node .
Native dependencies
-------------------
Ubuntu 22.04 (x64/arm64)
~~~~~~~~~~~~~~~~~~~~~~~~~~
- apt install build-essential pkg-config xvfb libglfw3-dev libuv1-dev libjpeg-turbo8 libicu70 libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev gir1.2-rsvg-2.0 librsvg2-2 librsvg2-common libcurl4-openssl-dev libpixman-1-dev libpixman-1-0
MacOS 12 (x64/arm64)
~~~~~~~~~~~~~~~~~~~~~~
- brew install pkg-config cairo libpng jpeg giflib
Windows (x64)
~~~~~~~~~~~~~~~~~~~~~~~~~
- `Microsoft Visual C++ 2015-2022 Redistributable <https://aka.ms/vs/17/release/vc_redist.x64.exe>`_
``tileserver-gl-light`` on npm
==============================
Alternatively, you can use ``tileserver-gl-light`` package instead, which is pure javascript (does not have any native dependencies) and can run anywhere, but does not contain rasterization features.