Document in the README how to enable the Munin autoconfiguration.

1 files changed, 17 insertions, 1 deletions

diff --git a/README b/README
index a7f62a0..5086826 100644
--- a/README
+++ b/README
@@ -4,6 +4,21 @@ sitesummary
 More information is available from
 <URL: http://wiki.debian.org/DebianEdu/HowTo/SiteSummary >.
 
+Sitesummary generated Munin configuraiton
+-----------------------------------------
+
+Sitesummary can be used to generate Munin configuration to collect
+statistics from all sitesummary clients with the Munin packages
+installed.  To enable it, install the munin package and make sure
+/etc/sitesummary/collector.cfg inclue 'MUNINDIR=/etc/munin' to get
+sitesummary to replace the default munin configuration with the
+generated one.  Running these commands as root should do the trick.
+
+  aptitude install munin munin-node
+  echo MUNINDIR=/etc/munin >> /etc/sitesummary/collector.cfg
+  sitesummary-client
+  /etc/cron.daily/sitesummary
+
 Sitesummary generated Nagios configuration
 ------------------------------------------
 
@@ -12,10 +27,11 @@ generate Nagios configuration based on the collected information.  To
 enable this, install nagios3 and nagios-plugins-standard, edit
 /etc/default/nagios3 to include
 'NAGIOSCFG=/etc/nagios3/sitesummary.cfg' and run the sitesummary cron
-job.  These commands as root should do the trick.
+job.  Running these commands as root should do the trick.
 
   aptitude install nagios3 nagios-plugins-standard
   echo 'NAGIOSCFG="/etc/nagios3/sitesummary.cfg"' >> /etc/default/nagios3
+  sitesummary-client
   /etc/cron.daily/sitesummary
   /etc/init.d/nagios3 restart