From a5a203391805c81041d683e54ed83ca419764a7c Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 16 Sep 2020 13:01:15 +0200 Subject: [PATCH] API & Client - update map attribution to match tile server - fix #54 --- CHANGELOG.md | 11 ++ Makefile.custom.config.example | 1 + docs/_sources/changelog.md.txt | 11 ++ docs/_sources/installation.rst.txt | 52 +++++-- docs/changelog.html | 146 ++++++++++-------- docs/index.html | 1 + docs/installation.html | 39 +++-- docs/searchindex.js | 2 +- docsrc/source/installation.rst | 52 +++++-- .../fittrackee_api/activities/activities.py | 12 +- .../fittrackee_api/application/models.py | 5 + fittrackee_api/fittrackee_api/config.py | 15 +- .../fittrackee_api/tests/conftest.py | 2 + .../tests/test_app_config_api.py | 5 + .../tests/test_app_config_model.py | 5 + .../Activity/ActivityDisplay/ActivityMap.jsx | 6 +- 16 files changed, 242 insertions(+), 123 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b9a3f80..189058d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Change log +## Version 0.x.x (unreleased) + +### Issues Closed + +#### New Features + +* [#54](https://github.com/SamR1/Fittrackee/issues/54) - Tile server can be changed + +In this release 1 issue weas closed. + + ## Version 0.3.0 - Administration (2020/07/15) This version introduces some major changes: diff --git a/Makefile.custom.config.example b/Makefile.custom.config.example index 7463bcaa..e936c562 100644 --- a/Makefile.custom.config.example +++ b/Makefile.custom.config.example @@ -2,6 +2,7 @@ WORKERS_PROCESSES = 1 export REACT_APP_API_URL= export TILE_SERVER_URL= +export MAP_ATTRIBUTION= export WEATHER_API= export UI_URL= export EMAIL_URL= diff --git a/docs/_sources/changelog.md.txt b/docs/_sources/changelog.md.txt index 5b9a3f80..189058d3 100644 --- a/docs/_sources/changelog.md.txt +++ b/docs/_sources/changelog.md.txt @@ -1,5 +1,16 @@ # Change log +## Version 0.x.x (unreleased) + +### Issues Closed + +#### New Features + +* [#54](https://github.com/SamR1/Fittrackee/issues/54) - Tile server can be changed + +In this release 1 issue weas closed. + + ## Version 0.3.0 - Administration (2020/07/15) This version introduces some major changes: diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 71cb86b4..d0851c74 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -185,22 +185,23 @@ The following environment variables must be defined in **Makefile.custom.config* .. cssclass:: table-bordered table-striped -===================================== ======================================== ==================================== -variable description app default value -===================================== ======================================== ==================================== -``REACT_APP_API_URL`` Fittrackee API URL no default value, must be initialized -``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 (*deprecated in 0.3.0*) -``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB (*deprecated in 0.3.0*) -``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB (*deprecated in 0.3.0*) -``REACT_APP_ALLOW_REGISTRATION`` allows users to register true (*deprecated in 0.3.0*) -``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key (*deprecated*, use ``TILE_SERVER_URL`` instead) -``TILE_SERVER_URL`` Tile server URL (with api key if needed) ``https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`` -``UI_URL`` application URL no default value, must be initialized -``EMAIL_URL`` email URL with credentials no default value, must be initialized (see below) -``SENDER_EMAIL`` application sender email address no default value, must be initialized -``REDIS_URL`` Redis instance used by Dramatiq local Redis instance -``WORKERS_PROCESSES`` number of process used by Dramatiq no default value, must be initialized -===================================== ======================================== ==================================== +===================================== ============================================== ==================================== +variable description app default value +===================================== ============================================== ==================================== +``REACT_APP_API_URL`` Fittrackee API URL no default value, must be initialized +``REACT_APP_GPX_LIMIT_IMPORT`` max. number of gpx file in zip archive 10 (*deprecated in 0.3.0*) +``REACT_APP_MAX_SINGLE_FILE_SIZE`` max. size of a gpx or picture file 1MB (*deprecated in 0.3.0*) +``REACT_APP_MAX_ZIP_FILE_SIZE`` max. size of a zip archive 10MB (*deprecated in 0.3.0*) +``REACT_APP_ALLOW_REGISTRATION`` allows users to register true (*deprecated in 0.3.0*) +``REACT_APP_THUNDERFOREST_API_KEY`` ThunderForest API key (*deprecated in 0.x.x*, use ``TILE_SERVER_URL`` **and** ``MAP_ATTRIBUTION`` instead) +``TILE_SERVER_URL`` Tile server URL (with api key if needed) ``https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`` +``MAP_ATTRIBUTION`` Map attribution (if using another tile server) ``© OpenStreetMap contributors`` +``UI_URL`` application URL no default value, must be initialized +``EMAIL_URL`` email URL with credentials no default value, must be initialized (see below) +``SENDER_EMAIL`` application sender email address no default value, must be initialized +``REDIS_URL`` Redis instance used by Dramatiq local Redis instance +``WORKERS_PROCESSES`` number of process used by Dramatiq no default value, must be initialized +===================================== ============================================== ==================================== .. warning:: Since FitTrackee 0.3.0, some applications parameters are now stored in database. @@ -208,9 +209,26 @@ variable description a Emails ^^^^^^ +*new in 0.3.0* To send emails, a valid ``EMAIL_URL`` must be provided: - with an unencrypted SMTP server: ``smtp://username:password@smtp.example.com:25`` - with SSL: ``smtp://username:password@smtp.example.com:465/?ssl=True`` -- with STARTTLS: ``smtp://username:password@smtp.example.com:587/?tls=True`` \ No newline at end of file +- with STARTTLS: ``smtp://username:password@smtp.example.com:587/?tls=True`` + + +Map tile server +^^^^^^^^^^^^^^^ +*new in 0.x.x* + +Default tile server is now **OpenStreetMap**'s standard tile layer (if environment variables are not initialized). +The tile server can be changed by updating ``TILE_SERVER_URL`` and ``MAP_ATTRIBUTION`` variables (`list of tile servers `__). + +To keep using ThunderForest Outdoors, the configuration is: + +- ``TILE_SERVER_URL=https://{s}.tile.thunderforest.com/outdoors/{z}/{x}/{y}.png?apikey=XXXX`` where **XXXX** is ThunderForest API key +- ``MAP_ATTRIBUTION=© Thunderforest, © OpenStreetMap contributors`` + +.. note:: + Check the terms of service of tile provider for map attribution \ No newline at end of file diff --git a/docs/changelog.html b/docs/changelog.html index 3e0fff0a..0682565b 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -76,67 +76,74 @@ role="menu" aria-labelledby="dLabelLocalToc">