From b7c2aa69d128c7bbe752a105b14c360d9fc06b5a Mon Sep 17 00:00:00 2001
From: rick <rick@gnous.eu>
Date: Sat, 21 Jan 2023 20:12:30 +0100
Subject: [PATCH] add doc

---
 README.md                  | 22 ++++++++++++++--------
 roles/bubger/vars/main.yml | 10 +++++++++-
 vars/sites.yml             |  7 ++++++-
 3 files changed, 29 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 36ac2c2..3259518 100644
--- a/README.md
+++ b/README.md
@@ -9,23 +9,29 @@ Ils ont été écris afin d'être lancé sur Debian 10.
 
 `ansible-playbook main.yml -i inventaire.ini` pour lancer l'installation.
 
+Chaque dossier `vars` des différents rôles contient des variables pour indiquer
+le chemin du site, l'utilisateur, etc. Les variables propres à chaque rôle
+sont expliquées en commentaires.
+
+## Services
+
+ * bubger : permet de faire des archives html de mailing lists
+ * cgit : serveur web git (utilise gitolite pour gérer les dépôts)
+ * libretls : bibliothèque alternative pour pounce
+ * pounce : bouncer irc (contient litterbox, logger, et scooper, interface
+            graphique; installe aussi sqlite)
+ * site : mon site personnel (installe emacs)
+
 ## inventaire.ini
 
 Mettez ou l'ip ou le nom de la configuration SSH de votre machine distante.
 Ici, il s'agit du nom de la configuration SSH pour cacher l'IP de la machine
 de test.
 
-## vars
-
-* sites : Contient les différents noms de domains à utiliser.
-* cgit : variables pour cgit
-
 ## cgit
 
-Ces fichiers se trouvent dans `roles/cgit/` dans les dossiers `tasks`
-et `templates`.
+Ces fichiers se trouvent dans `roles/cgit/` dans le dossier `templates`.
 
-- cgit.yml : script ansible d'installation
 - config-cgit.conf : template de configuration pour la compilation de cgit. Ici,
                      tout est installé dans le même dossier (/home/git).
 - cgit-nginx : template pour la configuration nginx de cgit
diff --git a/roles/bubger/vars/main.yml b/roles/bubger/vars/main.yml
index bb4f28f..66fda05 100644
--- a/roles/bubger/vars/main.yml
+++ b/roles/bubger/vars/main.yml
@@ -1,8 +1,16 @@
 ---
-private_name: ""
+# nom du dossier des archives privées
+private_name: "perso"
+# chemin d'installation du binaire compilé
 path: "{{ home_user_default }}/bubger"
+# chemin où sera enregistré les fichiers HTML
 path_site: "/var/www/mailing_list"
+# chemins où seront lié par lien symbolique les dossiers public et private
 path_site_public: "{{ path_site }}/archives"
 path_site_private: "{{ path_site }}/{{ private_name }}"
+
+# dossiers contenant les fichiers HTML générés
+# les archives publiques
 public: "{{ path }}/archives"
+# les archives privées
 private: "{{ path }}/{{ private_name }}"
diff --git a/vars/sites.yml b/vars/sites.yml
index 9923358..ea25b10 100644
--- a/vars/sites.yml
+++ b/vars/sites.yml
@@ -1,8 +1,13 @@
 ---
+# contient les différents noms de domaines ainsi que les informations de base
+# de la machine qui peuvent être utilisées dans ni'mporte quel rôle.
+
+# nom-service_site
 site: ""
 cgit_site: ""
+pounce_site: ""
 
-user_default: "ubuntu"
+user_default: ""
 home_user_default: "/home/{{ user_default }}"
 ava: "/etc/nginx/sites-available"
 ena: "/etc/nginx/sites-enabled"