From ff07b53990935a34fef47e69c645585e026b78db Mon Sep 17 00:00:00 2001
From: "pulsar89.5" <pulsar89.5@ykn.fr>
Date: Thu, 8 Feb 2024 17:05:45 +0100
Subject: [PATCH] fix: Rewrite the readme

---
 README.md | 68 ++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 55 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 283a5b9..62d0365 100644
--- a/README.md
+++ b/README.md
@@ -4,25 +4,26 @@ Rôle de déploiement de podman.
 
 ## Pré-requis
 
-Ce rôle créer un utilisateur à l'aide de ce rôle qu'il faut donc installé lors de l'exécution d'un playbook.<br>
-Afin d'installer les deux rôles dans un playbook :
+Ce rôle créer un utilisateur dédié via [cet autre rôle](https://gitea.ykn.fr/ansible/role_users) dont il est dépendant.
+L'utilisation de ce rôle et de sa dépendance dans un playbook nécessite d'utilise ansible-galaxy en lui indiquant un fichier dont le contenu est le suivant :
 
 ```bash
 $ cd playbook_podman
-$ tee <<EOF
+$ tee requirements.yml <<EOF
 ---
 
-- name: users
-  scm: git
-  src: ssh://gitea@git.ykn.fr:12393/ansible/role_users.git
-  version: alpha
+roles:
+  - name: users
+    scm: git
+    src: ssh://gitea@git.ykn.fr:12393/ansible/role_users.git
+    version: alpha
 
-- name: podman
-  scm: git
-  src: ssh://gitea@git.ykn.fr:12393/ansible/role_podman.git
-  version: alpha
+  - name: podman
+    scm: git
+    src: ssh://gitea@git.ykn.fr:12393/ansible/role_podman.git
+    version: alpha
 EOF
-$ ansible-galaxy install -fr requirements_roles.yml 
+$ ansible-galaxy install -fr requirements.yml
 ```
 
 ## Variables
@@ -31,4 +32,45 @@ $ ansible-galaxy install -fr requirements_roles.yml
 
 Définition des conteneurs à déployer.
 
-<span style="text-decoration: underline">Valeur par défaut:</span> aucune
+<span style="text-decoration: underline">Valeur par défaut:</span> *aucune*
+
+## Utilisation
+
+Définir la variable `podman_containers` dans un fichier sous `host_vars` ou `group_vars` :
+
+```bash
+$ tee host_vars/lxd_podman_host.yml <<EOF
+---
+
+podman_containers:
+  - image: docker.io/wallabag/wallabag:latest
+    name: wallbag
+    userns: keep-id
+    volumes:
+      - wallbag-data:/var/www/wallabag/data
+      - wallbag-image:/var/www/wallabag/web/assets/images
+    ports:
+      - 80:80/tcp
+    environment_vars:
+      - SYMFONY__ENV__DOMAIN_NAME=https://wallbag.ykn.fr
+```
+
+Il est également possible de définir l'utilisateur via la variable `user`, comme ceci :
+
+```bash
+$ tee host_vars/lxd_podman_host.yml <<EOF
+---
+
+podman_containers:
+  - image: docker.io/wallabag/wallabag:latest
+    name: wallbag
+    user: un_utilisateur
+    userns: keep-id
+    volumes:
+      - wallbag-data:/var/www/wallabag/data
+      - wallbag-image:/var/www/wallabag/web/assets/images
+    ports:
+      - 80:80/tcp
+    environment_vars:
+      - SYMFONY__ENV__DOMAIN_NAME=https://wallbag.ykn.fr
+```