Update environment variables documentation by descripting variables usages

README.md

@@ -21,7 +21,7 @@ Accompagnement dans la gestion du Règlement Général à la Protection des Donn
 - [Maintenance applicative & montées de versions](doc/maintenance-applicative)
     - [Pré-requis pour lancer l'installation de MADIS](doc/maintenance-applicative/1-pre-requis.md)
     - [Réaliser une montée/descente de version de MADIS](doc/maintenance-applicative/2-realiser-une-montee-de-version.md)
-    - [Modifier les variables d'environnement de Symfony](doc/maintenance-applicative/4-variables-environement-symfony.md)
+    - [Descriptif des variables d'environnement de Symfony](doc/maintenance-applicative/4-descriptif-variables-environement-symfony.md)
     - [Problèmes possibles et connus lors de mises à jour](doc/maintenance-applicative/3-problemes-possible-lors-de-mises-a-jour.md)
     
 - [[DEVELOPPEURS] Documentation technique](doc/developpement)

doc/index.md

@@ -16,6 +16,7 @@ MADIS - Documentation
 - [Maintenance applicative & montées de versions](maintenance-applicative)
     - [Pré-requis pour lancer l'installation de MADIS](maintenance-applicative/1-pre-requis.md)
     - [Réaliser une montée/descente de version de MADIS](maintenance-applicative/2-realiser-une-montee-de-version.md)
+    - [Descriptif des variables d'environnement de Symfony](maintenance-applicative/4-descriptif-variables-environement-symfony.md)
     - [Problèmes possibles et connus lors de mises à jour](maintenance-applicative/3-problemes-possible-lors-de-mises-a-jour.md)
     
 - [[DEVELOPPEURS] Documentation technique](developpement)

doc/maintenance-applicative/4-descriptif-variables-environement-symfony.md

+Descriptif des variables d'environnement Symfony
+================================================
+
+Vous avez une certaine flexibilité dans la configuration de votre application MADIS.
+Pour cela, vous pouvez modifier les variables d'environnement,
+généralement trouvable dans le fichier `.env` de votre application.
+
+Vous trouverez ci-dessous une liste exhaustive des variables de ce fichier ainsi que des explications de ses dernières 
+
+```bash
+# APP_MAIL_RECEIVER_DEV : redirige tous les mails envoyés sur un seul destinataire (ça écrase la liste des destinataires pour celle-ci)
+APP_MAIL_RECEIVER_DEV=~
+
+# APP_IMPERSONATE_CREATOR_IS_ADMIN : défini si l'admin doit être identifié comme le créateur d'un élément lors de subrogation. Si à 0, l'utiliasteur est utilisé.
+APP_IMPERSONATE_CREATOR_IS_ADMIN=0
+
+DOCTRINE
+========
+# URL de votre base de données
+# cf. doc pour le format à utiliser http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+DATABASE_URL=mysql://user:user_pass@db:3306/madis
+
+APPLICATIF MADIS
+================
+# Ces variables d'environnement existent, mais vous ne devriez pas y toucher sans connaissance de cause
+APP_ENV=dev
+APP_MAIL_RECEIVER_DEV=~
+
+CONFIGURATION OBLIGATOIRE MADIS
+===============================
+
+# ATTENTION : Modifiez impérativement cette valeur lors de votre première installation
+# Chaine de caractère qui est utilisée dans la sécurité de votre application
+APP_SECRET=a98f56b9ea67f189df8ed6a39c548503
+
+CONFIGURATION MADIS
+===================
+# Nom de l'application
+APP_APPLICATION_NAME="Madis"
+
+# Temps d'inactivité pour un utilisateur (en secondes).
+# Une fois le temps écoulé, l'utilisateur est automatiquement déconnecté, même si le cookie est encore valide.
+APP_COOKIE_IDLE_TIMEOUT=5400
+
+# Durée de vie du cookie (en secondes)
+APP_COOKIE_LIFETIME=14400
+
+# Nom du référent RGPD (DPO/DPD) par défaut
+APP_DEFAULT_REFERENT="Référent RGPD"
+
+# Adresse du DPO par défaut.
+# Si vous êtes une structure mutualisante assurant le rôle de DPD, saisissez votre adresse
+APP_DPO_ADDRESS_CITY="Saintes"
+APP_DPO_ADDRESS_STREET="2 rue des Rochers"
+APP_DPO_ADDRESS_ZIP_CODE="17100"
+APP_DPO_CIVILITY=m
+APP_DPO_FIRST_NAME=Michaël
+APP_DPO_LAST_NAME=Edlich
+APP_DPO_COMPANY=Soluris
+APP_DPO_JOB="Chargé de mission Solutions Documentaires Electroniques"
+APP_DPO_MAIL=m.edlich@soluris.fr
+APP_DPO_PHONE_NUMBER=0546923905
+
+# Configuration du FOOTER du site (URL et nom de la structure mutualisante)
+APP_FOOTER_PROVIDER_NAME=SOLURIS
+APP_FOOTER_PROVIDER_URL="https://example.fr"
+
+# Configuration des images MADIS
+# Favicon
+APP_IMAGE_FAVICON_PATH="favicon.ico"
+# Lien utilisé lors du clic sur l'image dans la sidebar
+APP_IMAGE_SIDEBAR_BOTTOM_TARGET_URL="htpps//example.fr"
+# Lien vers l'image utilisée dans la sidebar lorsqu'elle est étendue
+# (chemin à configurer à partir du dossier `public` présent à la racine du projet)
+APP_IMAGE_SIDEBAR_BOTTOM_PATH="images/soluris-logo-white.png"
+# Lien vers l'image utilisée dans la sidebar lorsqu'elle est réduite 
+# (chemin à configurer à partir du dossier `public` présent à la racine du projet)
+APP_IMAGE_SIDEBAR_REDUCED_PATH="images/icon-32x32.png"
+
+# Défini si l'admin doit être identifié comme le créateur d'un élément lors de subrogation.
+# Si à 0, ce sera le nom de l'utilisateur subrogé qui apparaitra
+# Si à 1, ce sera le nom de l'administrateur qui subroge qui apparaitra
+APP_IMPERSONATE_CREATOR_IS_ADMIN=0
+
+# Adresse email qui apparaitra dans les mails envoyés par MADIS
+APP_MAIL_SENDER_EMAIL=ne-pas-repondre@example.fr
+# Nom de l'expéditeur qui apparaitra dans les mails envoyés par MADIS
+APP_MAIL_SENDER_NAME="Madis"
+
+# URL vers le mailer que doit utiliser MADIS
+###> symfony/swiftmailer-bundle ###
+# Pour GMAIL, utiliser: "gmail://username:password@localhost"
+# Pour un SMTP générique, utiliser: "smtp://localhost:25?encryption=&auth_mode="
+# Pour désactiver les mails, utiliser: "null://localhost"
+MAILER_URL=gmail://username:password@localhost
+```

doc/maintenance-applicative/4-variables-environement-symfony.md

-### Variables du .env
-
-```.env
-# APP_MAIL_RECEIVER_DEV : redirige tous les mails envoyés sur un seul destinataire (ça écrase la liste des destinataires pour celle-ci)
-APP_MAIL_RECEIVER_DEV=~
-
-# APP_IMPERSONATE_CREATOR_IS_ADMIN : défini si l'admin doit être identifié comme le créateur d'un élément lors de subrogation. Si à 0, l'utiliasteur est utilisé.
-APP_IMPERSONATE_CREATOR_IS_ADMIN=0
-
-```
\ No newline at end of file

doc/maintenance-applicative/index.md

@@ -6,5 +6,5 @@ Pour cela, les manipulations à effectuer sont décrites dans cet espace de docu
 
 - [Pré-requis pour lancer l'installation de MADIS](1-pre-requis.md)
 - [Réaliser une montée/descente de version de MADIS](2-realiser-une-montee-de-version.md)
-- [Modifier les variables d'environnement de Symfony](doc/maintenance-applicative/4-variables-environement-symfony.md)
+- [Descriptif des variables d'environnement de Symfony](4-descriptif-variables-environement-symfony.md)
 - [Problèmes possibles et connus lors de mises à jour](3-problemes-possible-lors-de-mises-a-jour.md)