From 9645c483ca122f98343f3d045b8d68cb6a355648 Mon Sep 17 00:00:00 2001
From: Ludovic Cartier <ludovic.cartier@alterway.fr>
Date: Fri, 5 Aug 2022 21:06:11 +0200
Subject: [PATCH] update README and rm TODO

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 TODO      | 10 ----------
 2 files changed, 30 insertions(+), 11 deletions(-)
 delete mode 100644 TODO

diff --git a/README.md b/README.md
index a17f15f..f35c631 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,18 @@ The present role :
   - installs Docker on host
   - installs various services through containers and docker-compose manifest
 
-It has bienn tested on :
+It has been tested on :
   - Debian 9
   - Debian 10
   - Debian 11
 
+Available services
+------------------
+
+  - Traefik
+  - Watchtower
+  - Grafana
+
 Role variables
 ---------------
 
@@ -24,15 +31,18 @@ None.
 Example Playbook
 ----------------
 
+```
   - hosts: example
     ignore_errors: "{{ ansible_check_mode }}" # ignore errors only in check mode !
 
     roles:
       - { role: docker-services, tags: ['docker-services'] }
+```
 
 Example variables
 -----------------
 
+```
   ---
   docker_services:
     - traefik
@@ -41,10 +51,29 @@ Example variables
 
   traefik_domain: 'mydomain.com'
   traefik_letsencrypt_email: 'cert@mydomain.com'
+```
 
 TODO
 ----
 
+1. Traefik
+    1. add variables for basic auth in templates
+    2. choose between global auth vs service auth
+2. Grafana
+    1. Handle providers
+    2. Handle custom dashboards
+    3. Permit anonymous login and user login
+3. OpenVPN
+    1. needs to be implemented
+4. SSHPortal
+    1. needs to be implemented
+5. Loki
+    1. needs to be implemented
+6. Promtail
+    1. needs to be implemented
+7. Gitlab
+    1. needs to be implemented
+
 License
 -------
 
diff --git a/TODO b/TODO
deleted file mode 100644
index 1789f92..0000000
--- a/TODO
+++ /dev/null
@@ -1,10 +0,0 @@
-##### traefik
-template / vars for basic auth ? for each user / pass
--> several users OK ?
-global auth vs service auth ?
-
-#### grafana
-auth / pas auth ?
-push provisionner
-push dashboard
-