Merge pull request #6807 from betagouv/document-env-example

Amélioration de la description des variables d’environnement
2022-01-18 12:15:20 +01:00 · 2022-01-18 12:15:20 +01:00 · eb930ce9e2
commit eb930ce9e2
parent dbac42665b 75006c799e
2 changed files with 79 additions and 64 deletions
--- a/config/env.example
+++ b/config/env.example
@ -1,17 +1,20 @@
-# Nom d'hôte de l'appli
-#   * Pour du dev local: localhost:3000
-#   * pour de la preprod: preprod.ds.organisme.fr (par exemple)
-#   * pour de la prod: www.demarches-simplifiees.fr
+# Application host name
+#
+# Examples:
+# * For local development: localhost:3000
+# * For preproduction: staging.ds.organisme.fr
+# * For production: ds.organisme.fr
 APP_HOST="localhost:3000"

-# Utilisé pour les logs LogRage
-SOURCE="tps_local"
-
-# Clé de chiffrement de rails, cf https://api.rubyonrails.org/classes/Rails/Application.html
+# Rails key for signing sensitive data
+# See https://guides.rubyonrails.org/security.html
+#
+# For production you MUST generate a new key, and keep it secret.
+# Secrets must be long and random. Use bin/rails secret to get new unique secrets.
 SECRET_KEY_BASE="05a2d479d8e412198dabd08ef0eee9d6e180f5cbb48661a35fd1cae287f0a93d40b5f1da08f06780d698bbd458a0ea97f730f83ee780de5d4e31f649a0130cf0"
 SIGNING_KEY="aef3153a9829fa4ba10acb02927ac855df6b92795b1ad265d654443c4b14a017"

-# Clé de chiffrement OTP, pour 2FA
+# Secret key for One-Time-Password codes, used for 2-factors authentication
 OTP_SECRET_KEY=""

 # SAML IdP
@ -20,51 +23,51 @@ OTP_SECRET_KEY=""
 # SAML_IDP_SECRET_KEY="-----BEGIN RSA PRIVATE KEY-----\nblabla+blabla\n-----END RSA PRIVATE KEY-----\n"
 # SENDINBLUE_LOGIN_URL="https://app.sendinblue.com/account/saml/login/truc"

-# Database
+# Database credentials
 DB_DATABASE="tps_development"
 DB_HOST="localhost"
 DB_POOL=""
 DB_USERNAME="tps_development"
 DB_PASSWORD="tps_development"

-# Protection simple de l'instance par mot de passe (utile pour la pre-prod)
+# Protect access to the instance with a static login/password (useful for staging environments)
 BASIC_AUTH_ENABLED="disabled"
 BASIC_AUTH_USERNAME=""
 BASIC_AUTH_PASSWORD=""

-# Object Storage pour les pièces jointes
+# Object Storage for attachments
+FOG_ENABLED="disabled"
 FOG_OPENSTACK_API_KEY=""
 FOG_OPENSTACK_USERNAME=""
 FOG_OPENSTACK_URL=""
 FOG_OPENSTACK_REGION=""
-FOG_ENABLED="" # valeur attendue: enabled
 DS_PROXY_URL=""

-# Service externe: authentification France Connect
+# External service: authentication through France Connect
 FC_PARTICULIER_ID=""
 FC_PARTICULIER_SECRET=""
 FC_PARTICULIER_BASE_URL=""

-# Service externe: authentification Agent Connect
+# External service: authentication through Agent Connect
 AGENT_CONNECT_ID=""
 AGENT_CONNECT_SECRET=""
 AGENT_CONNECT_BASE_URL=""
 AGENT_CONNECT_JWKS=""
 AGENT_CONNECT_REDIRECT=""

-# Service externe: Support Utilisateur HelpScout | Spécifique démarches-simplifiées.fr
+# External service: integration with HelpScout (optional)
 HELPSCOUT_MAILBOX_ID=""
 HELPSCOUT_CLIENT_ID=""
 HELPSCOUT_CLIENT_SECRET=""
 HELPSCOUT_WEBHOOK_SECRET=""

-# Service externe: Supervision exterieure | Spécifique démarches-simplifiées.fr
+# External service: external supervision
 SENTRY_ENABLED="disabled"
 SENTRY_CURRENT_ENV="development"
 SENTRY_DSN_RAILS=""
 SENTRY_DSN_JS=""

-# Statistiques web
+# External service: Matomo web analytics
 MATOMO_ENABLED="disabled"
 MATOMO_ID="73"
 # Missing MATOMO_HOST (thus hardcoded)
@ -77,50 +80,61 @@ SENDINBLUE_CLIENT_KEY=""
 SENDINBLUE_SMTP_KEY=""
 SENDINBLUE_USER_NAME=""

-# Service externe: Fournisseur de tchat pour administrateur  | Spécifique démarches-simplifiées.fr
-CRISP_ENABLED="disabled"
-CRISP_CLIENT_KEY=""
-
-# Service externe: rattrapage de mails envoyés, utile en préprod  | Spécifique démarches-simplifiées.fr
-MAILTRAP_ENABLED="disabled"
-MAILTRAP_USERNAME=""
-MAILTRAP_PASSWORD=""
-
 # SMTP Provider: Mailjet
 MAILJET_API_KEY=""
 MAILJET_SECRET_KEY=""

-# API Entreprise https://api.gouv.fr/api/api-entreprise.html
+# External service: live chat for admins (specific to démarches-simplifiées.fr)
+CRISP_ENABLED="disabled"
+CRISP_CLIENT_KEY=""
+
+# External service: mail catcher for staging environments (specific to démarches-simplifiées.fr)
+MAILTRAP_ENABLED="disabled"
+MAILTRAP_USERNAME=""
+MAILTRAP_PASSWORD=""
+
+# API Entreprise credentials
+# https://api.gouv.fr/api/api-entreprise.html
 API_ENTREPRISE_KEY=""

-# Service externe: CRM de suivi de création d'administrateur  | Spécifique démarches-simplifiées.fr
+# External service: CRM for following admin accounts pipeline (specific to démarches-simplifiées.fr)
 PIPEDRIVE_KEY=""

-# Liste des réseaux qui passent outre la génération de token pour identifier un device, ainsi que le throttling par rack-attack
+# Networks bypassing the email login token that verifies new devices, and rack-attack throttling
 TRUSTED_NETWORKS=""

-# Service externe: mesure de performance d'appli Rails  | Spécifique démarches-simplifiées.fr
+# External service: mesuring performance of the Rails app (specific to démarches-simplifiées.fr)
 SKYLIGHT_AUTHENTICATION_KEY=""

-# Activer ou non les logs LogRage
+# Enable or disable Lograge logs
 LOGRAGE_ENABLED="disabled"

-# Service externe d'horodatage des changements de statut des dossiers (effectué quotidiennement)
+# Logs source for Lograge
+#
+# Examples:
+# * For local development: tps_local
+# * For preproduction: tps_staging
+# * For production: tps_prod
+SOURCE="tps_local"
+
+# External service: timestamping a daily archive of dossiers status changes
 UNIVERSIGN_API_URL="https://ws.universign.eu/tsa/post/"
 UNIVERSIGN_USERPWD=""

-# API Geo / Adresse
+# External service: API Geo / Adresse
 API_ADRESSE_URL="https://api-adresse.data.gouv.fr"
 API_GEO_URL="https://geo.api.gouv.fr"

-# API Education
+# External service: API Education
 API_EDUCATION_URL="https://data.education.gouv.fr/api/records/1.0"

-# Modifier le nb de tentatives de relance de job si echec
+# Change the maximum number of times a job is retried
 # MAX_ATTEMPTS_JOBS=25
 # MAX_ATTEMPTS_API_ENTREPRISE_JOBS=5

-# Clé de chriffrement des données sensibles en base
+# Encryption key for sensitive columns in the database
 ENCRYPTION_SERVICE_SALT=""

+# Salt for invisible_captcha session data.
+# Must be the same value for all app instances behind a load-balancer.
 INVISIBLE_CAPTCHA_SECRET="kikooloool"
--- a/config/env.example.optional
+++ b/config/env.example.optional
@ -1,24 +1,24 @@
+# Optional environment variables

-# Variables d'environnement optionnelles
-
-# Les paramètres pour l'affichage du nom l'application, et pour la génération des liens
+# Application name, for display and generating links
 APPLICATION_NAME="demarches-simplifiees.fr"
 APPLICATION_SHORTNAME="d-s.fr"
 APPLICATION_BASE_URL="https://www.demarches-simplifiees.fr"

+# If defined to "staging", tell the app that it's running on a staging instance
 DS_ENV="staging"

-# Utilisation de France Connect
-# FRANCE_CONNECT_ENABLED="disabled" # "enabled" par défaut
+# France Connect usage
+# FRANCE_CONNECT_ENABLED="disabled" # "enabled" by default

-# Utilisation de Agent Connect
-# AGENT_CONNECT_ENABLED="disabled" # "enabled" par défaut
+# Agent Connect usage
+# AGENT_CONNECT_ENABLED="disabled" # "enabled" by default

-# Personnalisation d'instance - URLs des CGU et des mentions légales
+# Instance customization: URLs for GTS and legal mentions
 # CGU_URL=""
 # MENTIONS_LEGALES_URL=""

-# Personnalisation d'instance - Adresses Email de l'application et téléphone
+# Instance customization: support emails addresses and phone
 # CONTACT_EMAIL=""
 # EQUIPE_EMAIL=""
 # TECH_EMAIL=""
@ -26,61 +26,62 @@ DS_ENV="staging"
 # OLD_CONTACT_EMAIL=""
 # CONTACT_PHONE=""

-# Personnalisation d'instance - Adresses postale de l'opérateur de l'instance
+# Instance customization: postal address of the instance operator
 # CONTACT_ADDRESS="Incubateur de Services Numériques / beta.gouv.fr\nServices du Premier Ministre, 20 avenue de Ségur, 75007 Paris"

-# Personnalisation d'instance - URL pour la création de compte administrateur sur l'instance
+# Instance customization: URL for creating an admin account on the instance
 # DEMANDE_INSCRIPTION_ADMIN_PAGE_URL=""

-# Personnalisation d'instance - URL du site web de documentation
+# Instance customization: URL of the documentation website
 # DOC_URL="https://doc.demarches-simplifiees.fr"

-# Personnalisation d'instance - URL du site web FAQ
+# Instance customization: URL of the documentation support website
 # FAQ_URL="https://faq.demarches-simplifiees.fr"

-# Personnalisation d'instance - URL de la déclaration d'accessibilité
+# Instance customization: URL of the accessibility statement
 # ACCESSIBILITE_URL=""

-# Personnalisation d'instance - Page externe "Disponibilité" (status page)
+# Instance customization: URL of the availability/status webpage
 # STATUS_PAGE_URL=""

-# Personnalisation d'instance - Favicons ---> à placer dans "app/assets/images"
+# Instance customization: Favicons ---> to be put in "app/assets/images"
 # FAVICON_16PX_SRC="favicons/16x16.png"
 # FAVICON_32PX_SRC="favicons/32x32.png"
 # FAVICON_96PX_SRC="favicons/96x96.png"

-# Personnalisation d'instance - Logo de l'application ---> à placer dans "app/assets/images"
+# Instance customization: Application logo ---> to be put in "app/assets/images"
 # HEADER_LOGO_SRC="marianne.png"
 # HEADER_LOGO_ALT=""
 # HEADER_LOGO_WIDTH="65"
 # HEADER_LOGO_HEIGHT="56"

-# Personnalisation d'instance - Logo dans l'entête des emails ---> à placer dans "app/assets/images"
+# Instance customization: Emails header logo ---> to be put in "app/assets/images"
 # MAILER_LOGO_SRC="mailer/instructeur_mailer/logo.png"

-# Personnalisation d'instance - Logo dans le pied de page des emails ---> à placer dans "app/assets/images"
+# Instance customization: Emails footer logo ---> to be put in "app/assets/images"
 # MAILER_FOOTER_LOGO_SRC="mailer/instructeur_mailer/logo-beta-gouv-fr.png"

-# Personnalisation d'instance - Logo par défaut d'une procédure  ---> à placer dans "app/assets/images"
+# Instance customization: Procedure default logo  ---> to be put in "app/assets/images"
 # PROCEDURE_DEFAULT_LOGO_SRC="republique-francaise-logo.svg"

-# Personnalisation d'instance - Logo dans le PDF d'export d'un dossier  ---> à placer dans "app/assets/images"
+# Instance customization: PDF export logo ---> to be put in "app/assets/images"
 # DOSSIER_PDF_EXPORT_LOGO_SRC="app/assets/images/header/logo-ds-wide.svg"

-# Personnalisation d'instance - fichier utilisé pour poser un filigrane sur les pièces d'identité
+# Instance customization: watermark for identity documents
 # WATERMARK_FILE=""

-# Active le mode maintenance
+# Enabling maintenance mode
 # MAINTENANCE_MODE="true"

-# Active la localisation
+# Enabling localization
 # LOCALIZATION_ENABLED="true"

-# Désactivé l'OTP pour SuperAdmin
+# Disabling 2FA for Super-Admins
 # SUPER_ADMIN_OTP_ENABLED = "disabled" # "enabled" par défaut

-# API Particulier https://api.gouv.fr/les-api/api-particulier
+# API Particulier
+# https://api.gouv.fr/les-api/api-particulier
 # API_PARTICULIER_URL="https://particulier.api.gouv.fr/api"

-# Les instructeurs et administrateurs peuvent changer leur email vers ces domaines
+# Admins and instructeurs can freely change their email to these domains
 # LEGIT_ADMIN_DOMAINS = "domaine_1.com;domaine_2.com"