From b7ecc5699bc0d25da7945fae9682a275de162560 Mon Sep 17 00:00:00 2001 From: Lars Kruse Date: Thu, 8 Oct 2020 13:55:13 +0200 Subject: [PATCH] Update documentation --- README.md | 15 +++++++++------ RELEASE_CHECKLIST.md | 6 ++++++ 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 80df353..c63d992 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ does not require root privileges. # Project scope -Muninlite is supposed to be a minimal portable and shell-based +MuninLite is supposed to be a minimal portable and shell-based implementation of `munin-node`. It provides a small set of essential plugins suitable for basic monitoring of a host. Additionally external plugins can be used. @@ -124,11 +124,11 @@ help list df cpu if_eth0 if_eth1 if_err_eth0 if_err_eth1 load memory version -munins node on example.org version: 0.0.5 (munin-lite) +munins node on example.org version: 0.0.5 (muninlite) quit ``` -For inetd-test, try to telnet to munin port from allowed host. +An (x)inetd setup can be tested via telnet or netcat: ```shell # telnet localhost 4949 Trying 127.0.0.1... @@ -140,7 +140,7 @@ help list df cpu if_eth0 if_eth1 if_err_eth0 if_err_eth1 load memory version -munins node on example.org version: 0.0.5 (munin-lite) +munins node on example.org version: 0.0.5 (muninlite) quit Connection closed by foreign host. ``` @@ -179,8 +179,8 @@ as plugins. ## Munin master configuration -Configure your /etc/munin/munin.conf as you would for a regular -`muninnode`, if you configured MuninLite as a TCP service (e.g. via +Configure /etc/munin/munin.conf on you munin master as you would for a regular +`munin-node`. If you configured MuninLite as a TCP service (e.g. via inetd/xinetd): ``` @@ -197,6 +197,9 @@ service), you need to configure a transport and execute the script directly: use_node_name yes ``` +The ssh transport obviously requires the use of `authorized_keys` on +the host running MuninLite. + # License and copyright diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md index d4dccf5..3acddbe 100644 --- a/RELEASE_CHECKLIST.md +++ b/RELEASE_CHECKLIST.md @@ -11,3 +11,9 @@ git commit -m "Release $new_version" VERSION Changelog.md git tag -s "$new_version" -m "$new_version" make dist ``` + +## Downstream: OpenWrt + +Update the +[release references](https://github.com/openwrt/packages/blob/master/admin/muninlite/Makefile) +in OpenWrt.