diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 34 insertions, 1 deletions
@@ -6,11 +6,15 @@ All the configuration is done through the environment. ### HTTP Credentials +These are the credentials used to authenticate the HTTP dashboard + * `MUNIN_USER` * `MUNIN_PASSWORD` ### SMTP info for alerts +Email credentials used to send emails (like alerts) + * `SMTP_HOST` * `SMTP_PORT` * `SMTP_USERNAME` @@ -18,12 +22,17 @@ All the configuration is done through the environment. ### Alert target +Email addressed used for the alerts, require SMTP credentials. + * `ALERT_RECIPIENT` * `ALERT_SENDER` ### List of the nodes to check -* `NODES` format: `name1:ip1 name2:ip2 …` +The port is always optional, default is 4949 + +* `NODES` format: `name1:ip1[:port1] name2:ip2[:port2] …` +* `SNMP_NODES` format: `name1:ip1[:port1]` … ## Port @@ -37,3 +46,27 @@ For a bit of persistency * /var/lib/munin -> db * /var/run/munin -> lock and pid files * /var/cache/munin -> file deserved by HTTP + +## How to use the image + +``` +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_USER=http-user \ + -e MUNIN_PASSWORD=secret-password \ + -e SMTP_HOST=smtp.example.com \ + -e SMTP_PORT=587 \ + -e SMTP_USERNAME=smtp-username \ + -e SMTP_PASSWORD=smtp-password \ + -e ALERT_RECIPIENT=monitoring@example.com \ + -e ALERT_SENDER=alerts@example.com \ + -e NODES="server1:10.0.0.1 server2:10.0.0.2" \ + -e SNMP_NODES="router1:10.0.0.254:9999" + munin-server +``` + +You can now reach your munin-server on port 8080 of your host. |