From 4c2f1e58f2fceae7fd1f16f4a7101505642a9388 Mon Sep 17 00:00:00 2001
From: shirenn <shirenn@crans.org>
Date: Thu, 22 Jul 2021 19:14:16 +0200
Subject: [PATCH] [critical/mail/services] Ajout de mail.md

---
 ROADMAP.md                     |  4 ++--
 critical/mail/services/mail.md | 38 ++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 critical/mail/services/mail.md

diff --git a/ROADMAP.md b/ROADMAP.md
index e8c9b6e..1752d53 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -21,7 +21,7 @@
 │   │   ├── postfix.md [shirenn]
 │   │   ├── roundcube.md
 │   │   └── services
-│   │       └── mail.md [shirenn]
+│   │       └── mail.md [DONE]
 │   ├── moinmoin.md
 │   ├── monitoring
 │   │   ├── grafana.md
@@ -36,7 +36,7 @@
 │   │   ├── nftables.md
 │   │   ├── radvd.md [DONE]
 │   │   └── services
-│   │       ├── dhcp.md [shirenn]
+│   │       ├── dhcp.md [DONE]
 │   │       ├── firewall.md
 │   │       └── prefix-delegation.md
 │   └── owncloud.md
diff --git a/critical/mail/services/mail.md b/critical/mail/services/mail.md
new file mode 100644
index 0000000..30b7ae9
--- /dev/null
+++ b/critical/mail/services/mail.md
@@ -0,0 +1,38 @@
+# Services Mail
+Le script de services mails permet de générer des fichiers d'alias et virtual 
+pour [/critical/mail/postfix](postfix) à partir de la base de données des 
+adhérents du crans. Actuellement celle ci est gérée par re2o donc on fait des 
+requêtes à l'API de re2o pour récupérer la liste des adresses, alias et 
+redirections mails.
+
+## Installation
+Pour installer le logiciel, il faut cloner le répertoire git 
+`https://gitlab.crans.org/nounous/mail.git` . Actuellement la convention veut 
+que les services soient placé sous le chemin `/var/local/services/` mais rien ne 
+l'impose. Pour tourner  le script a besoin du paquet `python3-jinja2`. Il faut 
+aussi crééer le dossier `generated` à la racine du dépot dans lequel seront 
+stocker les fichiers de bails générer. Il est aussi nécessaire de récupérer les 
+fichier `aliases` et `virtual` du dépot git 
+`https://gitlab.crans.org/nounous/mail_aliases.git` et de venir les mettre à la 
+racine du dépot sous les noms `aliases_local` et `virtual_local`.
+
+## Configuration
+### Re2o
+Pour récupérer la liste des adresses mails, le script a besoin de pouvoir parler 
+à l'API re2o. Pour ça on fournit au script les informations de connexions dans le 
+fichier de configuration `re2o-config.ini` à la racine du dépot :
+```
+[Re2o]
+hostname = 172.16.10.156
+username = services
+password = ynerant_aime_le_php
+```
+
+### mail.json
+Dans le fichier de configuration `mail.json` aussi présent à la racine, on 
+réalise le reste de la configuration du logiciel. Actuellement le script ne 
+prends pas d'options, on peut donc se contenter de lui passer le dictionnaire 
+vide en guise de configuration.
+```json
+{}
+```