From ddb29c0547e1ff53d079abcbd1faa2a68faf4fce Mon Sep 17 00:00:00 2001
From: David Beniamine <david.beniamine@tetras-libre.fr>
Date: Mon, 26 Jun 2023 14:55:33 +0200
Subject: [PATCH] Documentation

---
 .env.sample |  4 ++++
 Readme      |  0
 Readme.md   | 15 +++++++++++++++
 3 files changed, 19 insertions(+)
 delete mode 100644 Readme
 create mode 100644 Readme.md

diff --git a/.env.sample b/.env.sample
index e69de29..451e827 100644
--- a/.env.sample
+++ b/.env.sample
@@ -0,0 +1,4 @@
+# Hosts to put down ex `dev.tetras-lab.io`,`reporting.tetras-lab.io`
+HOSTS=
+# Hosts to put down ex `127.0.0.1`,`109.190.86.26`
+IGNORE_IPS=`127.0.0.1`
diff --git a/Readme b/Readme
deleted file mode 100644
index e69de29..0000000
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..308269f
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,15 @@
+# Maintenance page
+
+## What is this
+
+When updating a docker based deployment one may want to block user out during the maintenance but still be able to access the service.
+
+This is a simple `docker-compose` service to use behind a traefik proxy that will take priority over other services.
+It will show a maintenance page for the configured hosts to all users but ignored IPs.
+
+## How to use it
+
+1. Clone this repository
+2. Copy `.env.sample` to `.env`
+3. Set the variable `HOSTS` : it should contain the list of HOSTS you want to put down, see [traefik's doc](https://doc.traefik.io/traefik/routing/routers/#rule) on `HOST`
+3. Set the variables `IGNORE_IPS` it should contain the list of IPs that can still access the service, see [traefik's doc](https://doc.traefik.io/traefik/routing/routers/#rule) on `ClientIP`
-- 
GitLab