From aedc2aaca07df9d834dc7a5118352d1e5d780461 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 28 Dec 2022 15:19:58 +0100 Subject: [PATCH] Docs - update installation documentation --- docsrc/source/features.rst | 2 +- docsrc/source/installation.rst | 26 ++++++++++++++++++++++++-- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docsrc/source/features.rst b/docsrc/source/features.rst index 8e3d3123..5c0555c9 100644 --- a/docsrc/source/features.rst +++ b/docsrc/source/features.rst @@ -43,7 +43,7 @@ Workouts | Ascent and descent can also be provided (*new in 0.7.10*). - | A workout with a gpx file can be displayed with map and charts (speed and elevation). | Controls allow full screen view and position reset (*new in 0.5.5*). -- | If DarkSky API key is provided, weather is displayed in workout detail. +- | If **DarkSky API** or **Visual Crossing** (*new in 0.7.11*) API key is provided, weather is displayed in workout detail. | Wind is displayed, with arrow indicating direction (a tooltip can be displayed with the direction that the wind is coming **from**) (*new in 0.5.5*). - Segments can be displayed. - Workout gpx file can be downloaded (*new in 0.5.1*) diff --git a/docsrc/source/installation.rst b/docsrc/source/installation.rst index 5b33d773..32b79d2e 100644 --- a/docsrc/source/installation.rst +++ b/docsrc/source/installation.rst @@ -28,7 +28,7 @@ Prerequisites - optional - Redis for task queue (if email sending is enabled) and API rate limits - SMTP provider (if email sending is enabled) - - API key from `Dark Sky `__ (deprecated, DarkSky will stop on March 31st, 2023) + - API key from a `weather data provider `__ - `Poetry `__ (for installation from sources only) - `Yarn `__ (for development only) - Docker and Docker Compose (for development or evaluation purposes) @@ -229,7 +229,14 @@ deployment method. .. versionchanged:: 0.4.0 ⚠️ replaces ``WEATHER_API`` - **Dark Sky** API key for weather data (not mandatory). + Weather API key (not mandatory), see ``WEATHER_API_PROVIDER``. + + +.. envvar:: WEATHER_API_PROVIDER + + .. versionadded:: 0.7.11 + + Provider for weather data (not mandatory), see `Weather data `__. .. envvar:: VUE_APP_API_URL @@ -338,6 +345,21 @@ API rate limits 🆕 limits Enumerate details about all routes with rate limits +Weather data +^^^^^^^^^^^^ +.. versionchanged:: 0.7.11 + +The following weather data providers are supported by **FitTrackee**: + +- `Dark Sky `__ (deprecated, will stop on March 31st, 2023) +- `Visual Crossing `__ (**note**: historical data are provided on hourly period) + +To configure a weather provider, set the following environment variables: + +- ``WEATHER_API_PROVIDER``: ``darksky`` for **Dark Sky** or ``visualcrossing`` for **Visual Crossing** +- ``WEATHER_API_KEY``: the key to the corresponding weather provider + + Installation ~~~~~~~~~~~~