Fabio/tileserver-gl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: try to clarify

Browse source 
Signed-off-by: Andrew Calcutt <acalcutt@techidiots.net>
This commit is contained in:
Andrew Calcutt 2023-10-14 21:47:18 -04:00
parent 065b3742f0
commit d0ba661ad0
1 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/config.rst
View file

@ -16,7 +16,8 @@ Example:
"sprites": "sprites", "sprites": "sprites",
"icons": "icons", "icons": "icons",
"styles": "styles", "styles": "styles",
"mbtiles": "" "mbtiles": "",
"pmtiles": ""
}, },
"domains": [ "domains": [
"localhost:8080", "localhost:8080",
@ -210,45 +211,45 @@ You can link various data sources from the style JSON (for example even remote T
MBTiles MBTiles
------- -------
To specify that you want to use local mbtiles, use to following syntax: ``mbtiles://switzerland.mbtiles``. To specify that you want to use local mbtiles, use to following syntax: ``mbtiles://source1.mbtiles``.
The TileServer-GL will try to find the file ``switzerland.mbtiles`` in ``root`` + ``mbtiles`` path. The TileServer-GL will try to find the file ``source1.mbtiles`` in ``root`` + ``mbtiles`` path.
For example:: For example::
"sources": { "sources": {
"source1": { "source1": {
"url": "mbtiles://switzerland.mbtiles", "url": "mbtiles://source1.mbtiles",
"type": "vector" "type": "vector"
} }
} }
Alternatively, you can use ``mbtiles://{zurich-vector}`` to reference existing data object from the config. Alternatively, you can use ``mbtiles://{source1}`` to reference existing data object from the config.
In this case, the server will look into the ``config.json`` to determine what file to use by data id. In this case, the server will look into the ``config.json`` to determine what file to use by data id.
For the config above, this is equivalent to ``mbtiles://zurich.mbtiles``. For the config above, this is equivalent to ``mbtiles://source1.mbtiles``.
PMTiles PMTiles
------- -------
To specify that you want to use local pmtiles, use to following syntax: ``pmtiles://switzerland.pmtiles``. To specify that you want to use local pmtiles, use to following syntax: ``pmtiles://source2.pmtiles``.
To specify that you want to use a http based pmtiles, use to following syntax: ``pmtiles://https://foo.lan/switzerland.pmtiles``. To specify that you want to use a url based pmtiles, use to following syntax: ``pmtiles://https://foo.lan/source3.pmtiles``.
The TileServer-GL will try to find the file ``switzerland.pmtiles`` in ``root`` + ``pmtiles`` path. The TileServer-GL will try to find the file ``source2.pmtiles`` in ``root`` + ``pmtiles`` path.
For example:: For example::
"sources": { "sources": {
"source1": { "source2": {
"url": "pmtiles://switzerland.pmtiles", "url": "pmtiles://source2.pmtiles",
"type": "vector" "type": "vector"
}, },
"source2": { "source3": {
"url": "pmtiles://https://foo.lan/switzerland.pmtiles", "url": "pmtiles://https://foo.lan/source3.pmtiles",
"type": "vector" "type": "vector"
}, },
} }
Alternatively, you can use ``pmtiles://{zurich-vector}`` to reference existing data object from the config. Alternatively, you can use ``pmtiles://{source2}`` to reference existing data object from the config.
In this case, the server will look into the ``config.json`` to determine what file to use by data id. In this case, the server will look into the ``config.json`` to determine what file to use by data id.
For the config above, this is equivalent to ``pmtiles://zurich.mbtiles``. For the config above, this is equivalent to ``pmtiles://source2.mbtiles``.
Sprites Sprites
------- -------