From d6e30533d7730331452c5f61a98c9d1eec486a0b Mon Sep 17 00:00:00 2001
From: "Suren A. Chilingaryan" <csa@suren.me>
Date: Wed, 28 Aug 2019 19:43:26 +0200
Subject: OpenShift support

---
 README.md | 39 +++++++++++++--------------------------
 1 file changed, 13 insertions(+), 26 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index cc39d1b..7ab1cc7 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,17 @@
 # Docker image for munin server
 
+## Note
+The package is based on the original Scalingo docker image which was modified to run OpenShift platform. 
+Major modifications:
+ * Runs under non-privileged user
+ * Based on Alpine Linux 
+ * Database and lockfiles can be mounted as a single volume
+ * Authentication support is dropped, email notifications are not checked
+ 
 ## Configuration
 
 All the configuration is done through the environment.
 
-### HTTP Credentials 
-
-These are the credentials used to authenticate the HTTP dashboard; both take a space-delimited list
-
-* `MUNIN_USERS`
-* `MUNIN_PASSWORDS`
-
 ### SMTP info for alerts
 
 Email credentials used to send emails (like alerts)
@@ -46,10 +47,10 @@ Container is listening on the port 8080
 
 For a bit of persistency
 
-* /var/log/munin   -> logs
-* /var/lib/munin   -> db
-* /var/run/munin   -> lock and pid files
-* /var/cache/munin -> file deserved by HTTP
+* /minin                -> everything: configuration, database, locks, and log files
+* /munin/db             -> db
+* /munin/run            -> locks
+* /munin/log            -> log files
 
 ## How to use the image
 
@@ -57,12 +58,7 @@ For a bit of persistency
 docker build -t munin-server .
 docker run -d \
   -p 8080:8080 \
-  -v /var/log/munin:/var/log/munin \
-  -v /var/lib/munin:/var/lib/munin \
-  -v /var/run/munin:/var/run/munin \
-  -v /var/cache/munin:/var/cache/munin \
-  -e MUNIN_USERS='http-user another-user' \
-  -e MUNIN_PASSWORDS='secret-password other-users-password' \
+  -v /var/lib/munin:/munin \
   -e SMTP_HOST=smtp.example.com \
   -e SMTP_PORT=587 \
   -e SMTP_USERNAME=smtp-username \
@@ -76,12 +72,3 @@ docker run -d \
   -e SNMP_NODES="router1:10.0.0.254:9999" \
   munin-server
 ```
-
-You can now reach your munin-server on port 8080 of your host. It will display at the first run:
-
-```
-Munin has not run yet. Please try again in a few moments.
-```
-
-Every 5 minutes munin-server will interrogate its nodes and build the graphs and store the data.
-That's only after the first data fetching operation that the first graphs will appear.
-- 
cgit v1.2.3