Variables d'environnement¶

Avertissement

Depuis la version 0.4.0 de FitTrackee, le fichier Makefile.custom.config est remplacé par le fichier .env

Variables générales¶

Les variables d'environnements suivantes sont utilisées par l'application web de FitTrackee ou la librairie de gestion de la file d'attente des tâches. Elles ne sont pas toutes obligatoires selon la méthode de déploiement.

API_RATE_LIMITS¶: Ajouté dans la version 0.7.0.

Modifié dans la version 1.0.4: suppression de la valeur par défaut

Limites d'accès à l'API utilisées par Flask-Limiter, cf. Limitation d'accès à l'API.

APP_LOG¶

Ajouté dans la version 0.4.0.

Chemin du fichier de log

Modifié dans la version 1.0.4.

Si la valeur n'est pas définie, la sortie des logs est affichée uniquement sur la console.

APP_SECRET_KEY¶: clé secrète de FitTrackee, doit être initialisé sur un environnement de production.

Avertissement

Utiliser une clé secrète forte. Cette clé est utilisée pour la génération des jetons JWT.

APP_SETTINGS¶

Configuration de FitTrackee.

défaut:: fittrackee.config.ProductionConfig

APP_TIMEOUT¶

Ajouté dans la version 0.9.3.

timeout (en secondes) pour les workers lancés par Gunicorn (dans le cas du démarrage direct avec le point d’entrée de FitTrackee ou avec l'image Docker), voir la documentation de Gunicorn.

défaut:: 30

APP_WORKERS¶

Modifié dans la version 0.9.3: utilisé par le script du point d'entrée de l'image Docker

Nombre de workers lancés par Gunicorn (dans le cas du démarrage direct avec le point d’entrée de FitTrackee ou avec l'image Docker), voir la documentation de Gunicorn.

défaut:: 1

DATABASE_DISABLE_POOLING¶

Ajouté dans la version 0.4.0.

Supprimé dans la version 0.9.3.

Désactiver le pooling si nécessaire (dans le cas du démarrage direct avec le point d'entrée de FitTrackee et non avec Gunicorn), cf. la documentation de SqlAlchemy.

défaut:: false

DATABASE_URL¶: URL de la base de données avec le nom et le mot de passe de l'utilisateur, doit être initialisée sur les environnements de production.

Exemple pour un environnement de développement : postgresql://fittrackee:fittrackee@localhost:5432/fittrackee

Avertissement

Depuis la version 1.4+ de SQLAlchemy, l'URL doit commencé avec postgresql://.

DEFAULT_STATICMAP¶

Ajouté dans la version 0.4.9.

Si True, le serveur de tuile par défaut de Static Map 3 est conservé pour générer les images statiques de cartes (serveur de tuiles OSM).

Sinon, le serveur de tuiles configuré au niveau de la variable TILE_SERVER_URL sera utilisé.

Modifié dans la version 0.6.10.

Cette variable est maintenant insensible à la casse.

Si False, selon le serveur de tuile, les sous-domaines peuvent être obligatoires.

défaut:: False

DRAMATIQ_LOG¶: Ajouté dans la version 0.9.5.

Chemin du fichier de log de Dramatiq

EMAIL_URL¶

Ajouté dans la version 0.3.0.

URL du serveur d'envoi des courriels avec les informations de connexion, cf. Courriels.

Modifié dans la version 0.6.5.

défaut:: chaine de caractère vide

Danger

Si l'URL du serveur est vide, l'envoi des courriels sera désactivé.

Avertissement

Si l'URL du serveur est invalide, l'envoi des courriels sera désactivé.

ENABLE_GEOSPATIAL_FEATURES¶

Ajouté dans la version 1.0.0.

Supprimé dans la version 1.1.0.

Active les fonctionnalités géospatiales sur l'interface utilisateur.
Garder la valeur à False jusqu'à ce que toutes les séances aient été mises à jour pour ajouter les geométries (voir l'interface de ligne de commandes des séances).
Cette variable est insensible à la casse.

défaut:: False

Avertissement

Il s'agit d'un indicateur temporaire. Il sera supprimé dans la prochaine version, ce qui nécessitera la mise à jour de tous les séances.

FLASK_APP¶: Nom du module à importer au démarrage de Flask.

FLASK_APP doit contenir $(PWD)/fittrackee/__main__.py dans le cas de l'installation à partir des sources, sinon fittrackee.

HOST¶

Hôte FitTrackee.

défaut:: 127.0.0.1

LOG_LEVEL¶

Ajouté dans la version 1.0.4.

Niveau de log pour Gunicorn (dans le cas du démarrage direct avec le point d’entrée de FitTrackee ou avec l'image Docker), voir la documentation de Gunicorn.

défaut:: info

MAP_ATTRIBUTION¶

Ajouté dans la version 0.4.0.

Attribution de la carte (si une autre serveur de tuile est utilisé), cf. Serveur de tuiles.

défaut:: © <a href="http://www.openstreetmap.org/copyright" target="_blank" rel="noopener noreferrer">OpenStreetMap</a> contributors

NOMINATIM_URL¶

Ajouté dans la version 1.0.0.

URl du server Nominatim, permettant d'obtenir les coordonnées de la localisation saisie par l'utilisateur.

défaut:: https://nominatim.openstreetmap.org

OPEN_ELEVATION_API_URL¶: Ajouté dans la version 1.1.0.

URL du service OpenElevation (API publique ou auto-hébergée).

PORT¶

Port de l'application web FitTrackee.

défaut:: 5000

REDIS_URL¶

Ajouté dans la version 0.3.0.

Instance Redis utilisée par Dramatiq et Flask-Limiter.

défaut:: instance locale Redis (redis://)

SENDER_EMAIL¶: Ajouté dans la version 0.3.0.

Adresse électronique de l'expéditeur FitTrackee.

STATICMAP_CACHE_DIR¶

Ajouté dans la version 0.10.0.

Répertoire pour le cache de Static Map 3

défaut:: .staticmap_cache

Avertissement

Il s'agit de la variable par défaut de la bibliothèque, à modifier pour définir un autre répertoire

STATICMAP_SUBDOMAINS¶

Ajouté dans la version 0.6.10.

Certains serveurs de tuiles nécessitent un sous-domaine, cf. Serveur de tuiles.

Par exemple: "a,b,c" pour OSM France.

défaut:: chaine de caractère vide

TASKS_TIME_LIMIT¶

Ajouté dans la version 0.10.0.

Timeout en secondes pour l'exécution des tâches par Dramatiq pour éviter des exécutions trop longues

défaut:: 1800

TILE_SERVER_URL¶

Ajouté dans la version 0.4.0.

URl du serveur de tuiles (avec la clé de l'API si nécessaire), cf. Serveur de tuiles.

Depuis la version 0.4.9, il est également utiliser pour générer les images statiques des cartes (pour garder le serveur par défaut cf. DEFAULT_STATICMAP)

Modifié dans la version 0.7.23.

L'URL par défaut a été mise à jour : le serveur de tuiles OpenStreetMap ne nécessite plus de sous-domaines.

défaut:: https://tile.openstreetmap.org/{z}/{x}/{y}.png

UI_URL¶: URL de FitTrackee, nécessaire pour les liens dans les courriels et les mentions sur l'interface.

Avertissement

UI_URL doit contenir le schéma d'URI (https://).

UPLOAD_FOLDER¶

Ajouté dans la version 0.4.0.

Un chemin absolu vers le répertoire dans le répertoire uploads sera créé.

défaut:: <application_directory>/fittrackee

Danger

Dans le cas d'une installation avec PyPI, le répertoire sera localisé dans le répertoire de l'environnement virtuel Python si la variable n'est pas initialisée.

VALHALLA_API_URL¶: Ajouté dans la version 1.1.0.

URL du service Valhalla (API publique ou auto-hébergée).

VITE_APP_API_URL¶: Modifié dans la version 0.7.26: ⚠️ remplace VUE_APP_API_URL

URL de l'API de FitTrackee, nécessaire uniquement pour l'environnement de développement.

WEATHER_API_KEY¶: Modifié dans la version 0.4.0: ⚠️ remplace WEATHER_API

Clé d'API du fournisseur de données météo (non obligatoire), cf. WEATHER_API_PROVIDER.

WEATHER_API_PROVIDER¶: Ajouté dans la version 0.7.11.

Fournisseur de données météo (non obligatoire), cf. Données météo.

WORKERS_PROCESSES¶: Ajouté dans la version 0.3.0.

Nombre de processus utilisés par Dramatiq.

Docker Compose¶

Ajouté dans la version 0.8.13.

Modifié dans la version 0.11.2: Renommage des variables et ajout de HOST_STATICMAP_CACHE_DIR

HOST_APP_PORT¶: Port du conteneur de l'application.

HOST_DATABASE_DIR¶: Répertoire de l'hôte pour le volume des données PostgreSQL

POSTGRES_USER¶: Utilisateur de la base de données PostgreSQL

POSTGRES_PASSWORD¶: Mot de passe de l'utilisateur PostgreSQL

POSTGRES_DB¶: Nom de la base de données de l'application FitTrackee

HOST_REDIS_DIR¶: Répertoire de l'hôte pour le volume des données redis

HOST_LOG_DIR¶: Répertoire de l'hôte pour le volume des logs

HOST_UPLOAD_DIR¶: Répertoire de l'hôte pour le volume des fichiers téléversés

HOST_STATICMAP_CACHE_DIR¶: Répertoire de l'hôte pour le volume du cache de Static Map 3