Merge pull request #4538 from mfaure/4537-Description-des-entrées-du-env.example

DOC ajout commentaires + explications pour env.example

config/env.example

@@ -1,20 +1,35 @@
+# 3 valeurs:
+#   * tps: environnement de production
+#   * tps_dev: environnement de pre-production
+#   * tps_local: machine de développeur
 APP_NAME="tps_local"
+
+# 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
 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
 SECRET_KEY_BASE="05a2d479d8e412198dabd08ef0eee9d6e180f5cbb48661a35fd1cae287f0a93d40b5f1da08f06780d698bbd458a0ea97f730f83ee780de5d4e31f649a0130cf0"
 SIGNING_KEY="aef3153a9829fa4ba10acb02927ac855df6b92795b1ad265d654443c4b14a017"
 
+# Database
 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)
 BASIC_AUTH_ENABLED="disabled"
 BASIC_AUTH_USERNAME=""
 BASIC_AUTH_PASSWORD=""
 
+# Object Storage pour les pièces jointes
 FOG_OPENSTACK_TENANT=""
 FOG_OPENSTACK_API_KEY=""
 FOG_OPENSTACK_USERNAME=""
@@ -22,29 +37,36 @@ FOG_OPENSTACK_URL=""
 FOG_OPENSTACK_IDENTITY_API_VERSION=""
 FOG_OPENSTACK_REGION=""
 FOG_DIRECTORY=""
-FOG_ENABLED=""
+FOG_ENABLED="" # valeur attendue: enabled
 DS_PROXY_URL=""
 
+# Service externe: authentification France Connect
 FC_PARTICULIER_ID=""
 FC_PARTICULIER_SECRET=""
 FC_PARTICULIER_BASE_URL=""
 
+# Service externe: Authentification pour manager (auth Github obligatoire), permet d'accéder à /manager
 GITHUB_CLIENT_ID=""
 GITHUB_CLIENT_SECRET=""
 
+# Service externe: Support Utilisateur HelpScout | Spécifique démarches-simplifiées.fr
 HELPSCOUT_MAILBOX_ID=""
 HELPSCOUT_CLIENT_ID=""
 HELPSCOUT_CLIENT_SECRET=""
 HELPSCOUT_WEBHOOK_SECRET=""
 
+# Service externe: Supervision exterieure | Spécifique démarches-simplifiées.fr
 SENTRY_ENABLED="disabled"
 SENTRY_CURRENT_ENV="development"
 SENTRY_DSN_RAILS=""
 SENTRY_DSN_JS=""
 
+# Statistiques web
 MATOMO_ENABLED="disabled"
 MATOMO_ID="73"
+# Missing MATOMO_HOST (thus hardcoded)
 
+# SMTP Provider: Send In Blue
 SENDINBLUE_BALANCING=""
 SENDINBLUE_BALANCING_VALUE=""
 SENDINBLUE_ENABLED=""
@@ -52,26 +74,34 @@ 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
 API_ENTREPRISE_KEY=""
 
+# Service externe: CRM de suivi de création d'administrateur  | Spécifique 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
 TRUSTED_NETWORKS=""
 
+# Service externe: mesure de performance d'appli Rails  | Spécifique démarches-simplifiées.fr
 SKYLIGHT_AUTHENTICATION_KEY=""
 
+# Activer ou non les logs LogRage
 LOGRAGE_ENABLED="disabled"
 
+# Service externe d'horodatage des changements de statut des dossiers (effectué quotidiennement)
 UNIVERSIGN_API_URL=""
 UNIVERSIGN_USERPWD=""