Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Sam
2022-07-13 13:02:12 +02:00
parent 6e53e4f3bf
commit cb70e8c458
6 changed files with 108 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docsrc/source/installation.rst
View File

@ -175,6 +175,16 @@ deployment method.
:default: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`
.. envvar:: STATICMAP_SUBDOMAINS 🆕
.. versionadded:: 0.6.10
| Some tile servers require a subdomain, see `Map tile server <installation.html#map-tile-server>`__.
| For instance: "a,b,c" for OSM France.
:default: empty string
.. envvar:: MAP_ATTRIBUTION
.. versionadded:: 0.4.0
@ -184,11 +194,17 @@ deployment method.
:default: `&copy; <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors`
.. envvar:: DEFAULT_STATICMAP 🆕
.. envvar:: DEFAULT_STATICMAP
.. versionadded:: 0.4.9
If `True`, it keeps using default tile server to generate static maps.
| If `True`, it keeps using default tile server to generate static maps (Komoot.de tile server).
| Otherwise, it uses the tile server set in `TILE_SERVER_URL <installation.html#envvar-TILE_SERVER_URL>`__.
.. versionchanged:: 0.6.10
| This variable is now case-insensitive.
| If `False`, depending on tile server, `subdomains <installation.html#envvar-STATICMAP_SUBDOMAINS>`__ may be mandatory.
:default: False
@ -256,6 +272,20 @@ To keep using **ThunderForest Outdoors**, the configuration is:
.. note::
| Check the terms of service of tile provider for map attribution
.. versionchanged:: 0.6.10
Since the tile server can be used for static map generation, some servers require a subdomain.
For instance, to set OSM France tile server, the expected values are:
- ``TILE_SERVER_URL=https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png``
- ``MAP_ATTRIBUTION=fond de carte par <a href="http://www.openstreetmap.fr/mentions-legales/" target="_blank" rel="nofollow noopener">OpenStreetMap France</a>, sous&nbsp;<a href="http://creativecommons.org/licenses/by-sa/2.0/fr/" target="_blank" rel="nofollow noopener">licence CC BY-SA</a>``
- ``STATICMAP_SUBDOMAINS=a,b,c``
The subdomain will be chosen randomly.
Installation
~~~~~~~~~~~~