Aller au contenu principal

Configuration

L'API lit sa configuration dans les variables d'environnement (ou dans un fichier .env de son répertoire de travail ; l'environnement l'emporte). Cette page liste les variables à renseigner sur la plupart des installations.

Liste complète : référence de configuration.

Authentification​

VariableDescription
OIDC_PROVIDERmicrosoft (par défaut), keycloak ou generic
CLIENT_ID, CLIENT_SECRETClient OAuth 2.0 déclaré chez le fournisseur
REDIRECT_URIURL publique de l'API ; le retour se fait sur <REDIRECT_URI>/openid-connect/redirect
SCOPEScopes OAuth, par exemple openid email profile
TENANT_ID, APPLICATION_IDMicrosoft Entra ID uniquement
KEYCLOAK_URL, KEYCLOAK_REALMKeycloak uniquement
OIDC_DISCOVERY_URLFournisseur générique uniquement

Sécurité et réseau​

VariableDescription
FRONT_URLURL de l'interface web : seule origine acceptée par CORS, le contrôle CSRF et le WebSocket
COOKIE_SECRETSecret de signature des cookies de session, 32 caractères minimum
PASSWORD_SECRETObligatoire au démarrage, inutilisé dans la version actuelle
TRUSTED_PROXIESSous-réseau de votre reverse proxy, autorisé à fixer X-Forwarded-For

Stockage​

VariableDéfautDescription
DATA_DIR./dataUtilisateurs, clés API, tâches planifiées (fichiers JSON). /app/data dans l'image
API_LOG_DIR./logRépertoire de audit.log. /app/log dans l'image

Modules facultatifs​

Chaque module est désactivé par défaut. Activez-le, puis renseignez ses variables.

ModuleInterrupteurGuide
Sites webHOSTING_ENABLED=true (exige aussi HOSTING_TRAEFIK_NETWORK)Sites web
Comptes SFTPSFTP_ENABLED=true (exige aussi SFTP_DIRECTORY, SFTP_API_URL, SFTP_API_KEY)SFTP
Services managésSERVICES_ENABLED=trueServices managés
Fonctions (travail en cours)FUNCTIONS_ENABLED=true (nécessite aussi HOSTING_STACKS_DIRECTORY)Module Fonctions
Réseaux privésToujours disponiblesRéseaux privés

Vérifications au démarrage​

L'API vérifie chaque variable à son démarrage. Au moindre problème, elle refuse de démarrer et les journalise tous d'un coup (invalid configuration, une ligne par variable) :

  • une variable obligatoire absente, un type ou une plage de valeurs incorrects, un COOKIE_SECRET de moins de 32 caractères ;
  • une variable inconnue portant un préfixe connu (OIDC_, SFTP_, HOSTING_, SERVICES_, FUNCTIONS_, NETWORKS_, CRON_, COOKIE_, KEYCLOAK_, TRUSTED_) : presque toujours une faute de frappe, et le message propose le nom le plus proche ;
  • une variable supprimée : le message indique ce qui la remplace.

Les valeurs ne sont jamais écrites dans les logs. Seules les vérifications d'installation des modules services et fonctions (chemins, montages, Docker) désactivent le module concerné sans arrêter l'API.

Bon à savoir​

  • Toute modification de variable nécessite de redémarrer le conteneur de l'API.
  • Les variables du conteneur de l'interface (API_URL, WS_URL, personnalisation) sont listées dans Installation.