$Id: README,v 1.7 2004/05/13 18:00:07 kevinspicer Exp $
Quickstart Documentation....

Basically you install this (using rpm or the install.pl script in the tarball),
maybe edit /etc/MailScanner/mailscanner-mrtg.conf, and go... No Problem[tm]!

	To install using the install.pl script run it as...
	perl install.pl [options]
	(see below)

If you are using the install.pl script it is most important that you carefully
review the settings to ensure that it is being configured according to the 
location of things on your system.  The defaults are fine for many Linux
distributions but probably won't work on Solaris and some other systems.  Run
perl install.pl --help to see a list of options.

You need to make sure that you have a working snmpd running for some of the
graphs (see the README.SNMP file in this directory for help).

Configuration file is in /etc/MailScanner/mailscanner-mrtg.conf. The
file is fairly well documented. If something doesn't seem right look
there.

If you are upgrading you could use upgrade_MailScanner_conf to upgrade the 
mailscanner-mrtg.conf file.

Configuration file for MRTG is in /etc/mrtg/mailscanner-mrtg.cfg.

The main executable is /usr/sbin/mailscaner-mrtg with modules in 
/usr/lib/MailScanner-MRTG/MSMRTG.  It is a perl script that returns the 
output MRTG needs to graph. If one of your graphs doesn't seem to be working 
correctly you might look through there to find out why (probably the problem
lies in the Data.pm module).  If you make changes to this perl script please 
send them to us so we can include them for everyone to use!

We add a file to /etc/cron.d to make MRTG run with the 
/etc/mrtg/mailscanner-mrtg.cfg config file every 5 minutes - you don't want to
change this value because internally the script expects to run at this 
interval.

More documentation can be found in the man page (man mailscanner-mrtg) or
POD documentation embedded in the main script 
(pod2text /usr/sbin/mailscanner-mrtg)
