Configuration
Une installation auto-hébergée se configure via le .env situé à côté du compose.yaml. Cette
page classe les principales variables par usage. Le tableau complet et de référence se trouve
dans la section
Configuration du
README ; chaque variable est en outre commentée dans le .env.example.
Valeurs obligatoires
Section intitulée « Valeurs obligatoires »| Variable | Obligatoire | Signification |
|---|---|---|
GW_APP_URL |
oui | Adresse à laquelle l’application est joignable. Les liens de connexion et l’origine des passkeys en dépendent. |
GW_HOSTNAME |
pour tls |
Nom dans le certificat, transmis à Caddy. |
GW_VERSION |
oui | Tag de l’image : latest ou un numéro fixe comme 0.8.22. Figure dans le pied de page et dans /api/health. |
GW_APP_URL doit être exactement l’adresse affichée dans le navigateur. Si elle ne correspond
pas, les liens de connexion ouvrent la mauvaise adresse et l’éditeur en direct reste sans
connexion.
Envoi d’e-mails
Section intitulée « Envoi d’e-mails »Tu peux configurer l’envoi d’e-mails dans l’interface sous Envoi d’e-mails
(Envoi d’e-mails) ou dans le .env. L’environnement l’emporte champ par
champ ; l’interface marque ces champs avec depuis l’environnement.
| Variable | Quand | Signification |
|---|---|---|
GW_MAIL_TRANSPORT |
facultatif | smtp, graph, console ou none. Vide : les réglages de l’interface s’appliquent. |
SMTP_URL / SMTP_URL_FILE |
avec smtp |
URL du relais, directement ou depuis un fichier |
SMTP_FROM |
avec smtp |
Adresse d’expéditeur |
GW_GRAPH_TENANT_ID |
avec graph |
Locataire Microsoft 365, sous forme de domaine ou d’ID d’annuaire |
GW_GRAPH_CLIENT_ID |
avec graph |
ID d’application de l’enregistrement d’application |
GW_GRAPH_CLIENT_SECRET / GW_GRAPH_CLIENT_SECRET_FILE |
avec graph |
Secret de l’enregistrement, directement ou depuis un fichier |
GW_GRAPH_SENDER |
avec graph |
Boîte aux lettres depuis laquelle les e-mails sont envoyés |
Pour Microsoft Graph, il te faut un enregistrement d’application dans Entra ID avec
l’autorisation d’application Mail.Send (et non l’autorisation déléguée) et le consentement
administrateur.
Connexion et sessions
Section intitulée « Connexion et sessions »| Variable | Par défaut | Signification |
|---|---|---|
GW_RP_ID |
hôte de GW_APP_URL |
ID de relying party WebAuthn. Le modifier plus tard invalide chaque passkey. |
GW_SESSION_IDLE_DAYS |
14 |
Nombre de jours sans utilisation après lesquels une session expire |
GW_TRUSTED_PROXIES |
1 |
Nombre de proxys devant l’application. Uniquement pour la limitation de débit et les logs, jamais pour une autorisation. |
Premier compte admin
Section intitulée « Premier compte admin »Uniquement pour les installations mises en place par un script. La voie normale est /setup,
voir Installation.
| Variable | Signification |
|---|---|
GW_BOOTSTRAP_ADMIN_EMAIL |
Crée un admin au tout premier démarrage et imprime son lien |
GW_BOOTSTRAP_ADMIN_FIRST_NAME |
Prénom, facultatif |
GW_BOOTSTRAP_ADMIN_LAST_NAME |
Nom, facultatif |
Exploitation
Section intitulée « Exploitation »| Variable | Par défaut | Signification |
|---|---|---|
GW_TIMEZONE |
Europe/Berlin |
Fuseau horaire des dates dans l’interface. À définir explicitement pour que serveur et navigateur formatent pareil. |
GW_SECRET_KEY / GW_SECRET_KEY_FILE |
généré | Chiffre les identifiants d’e-mail saisis dans l’interface. À inclure dans la sauvegarde. |
GW_OPS_TOKEN |
vide | Rend /api/health détaillé avec l’en-tête x-ops-token : version, état des migrations, erreurs de pilote. |
GW_MIGRATE_ON_START |
désactivé | 1 fait migrer app avant le démarrage, pour des outils de mise à jour comme Watchtower |
GW_PORT, GW_COLLAB_PORT |
3000, 3001 |
Ports sur 127.0.0.1, si les valeurs par défaut sont occupées |
GW_COLLAB_URL, GW_COLLAB_INTERNAL_URL |
vide | Nécessaires uniquement si le service de collaboration ne se trouve pas sous /collab sur le même hôte |
Sans GW_OPS_TOKEN, /api/health ne répond qu’avec le statut et les noms des vérifications — le
point de terminaison est joignable publiquement. Ce qu’il en est de GW_SECRET_KEY et de
GW_MIGRATE_ON_START est expliqué sous Mettre à jour et sauvegarder.
Appliquer les modifications
Section intitulée « Appliquer les modifications »Après une modification du .env, relance la stack :
docker compose --profile tls up -dSans le profil tls (proxy propre, tunnel SSH), omets --profile tls, voir
HTTPS et reverse proxy.