Variables d'environnement
Les familles de variables d'environnement et leur utilisation.
Les noms de variables de cette page sont des propositions (TODO : à aligner avec le code du backend avant publication).
Convention de nommage
Toutes les variables propres à UniFam sont préfixées par UNIFAM_ et regroupées par famille :
| Préfixe | Famille |
|---|---|
UNIFAM_APP_ | Application : URL publique, port, environnement |
UNIFAM_DB_ | Base de données |
UNIFAM_AUTH_ | Authentification et sessions |
UNIFAM_LICENSE_ | Mode Suite et clé d'activation |
UNIFAM_STANDALONE_ | Compte unique du mode Standalone |
UNIFAM_OCR_ | Extension OCR locale |
UNIFAM_LOG_ | Journalisation |
Exemple minimal (Suite)
UNIFAM_APP_URL=https://unifam.example.com
UNIFAM_APP_PORT=3000
UNIFAM_DB_URL=<url-de-connexion-a-la-base>
UNIFAM_AUTH_SECRET=<secret-genere>
UNIFAM_LICENSE_KEY=<cle-d-activation>Exemple minimal (Standalone)
UNIFAM_APP_URL=http://localhost:3000
UNIFAM_STANDALONE_EMAIL=vous@example.com
UNIFAM_STANDALONE_PASSWORD=<mot-de-passe-solide>En Standalone, aucune clé d'activation n'est nécessaire et le compte est défini ici plutôt que par inscription.
Générer un secret
openssl rand -hex 32Utilisez une valeur différente pour chaque secret, et ne la réutilisez pas ailleurs.
Secrets avec Docker
Pour éviter d'écrire un secret en clair dans .env, vous pouvez utiliser les secrets Docker ou un gestionnaire de secrets. TODO : préciser si l'application supporte la lecture depuis un fichier (suffixe _FILE).
Valider la configuration
Au démarrage, le backend vérifie les variables obligatoires. S'il en manque une ou si une valeur est invalide, le conteneur s'arrête avec un message d'erreur explicite (TODO : à confirmer). Consultez les journaux :
docker compose logs backendÉtapes suivantes
Retrouvez chaque option, son type et sa valeur par défaut dans la référence des variables.