README for mrtgindex
--------------------

$Id: README,v 1.3 2001/06/11 05:30:10 als Exp $

What does it do?

The mrtgindex script takes the mrtg.cfg file, parses it for targets and
target names and then builds a set of webpages from this data:
 - global index page, containing two lists
   - list of all services, as links to a page for each service
   - list of all hosts, as links to a page for each hosts,
 - set of service pages, one for each service, these pages contain the
   mrtg daily graph for all instances of this services,
 - set of host pages, one for each host, these pages contain the mrtg
   daily graph for all services of this host


For this to work you need to use a special naming convention for your
mrtg target names: $HOST-$SERVICE[-$OTHER] with the [..] part being
optional. Examples: mordor-dns mordor-disk-usr

Who do I configure it?

There are a few config options, directly in the script since you only
need to change them during the setup of this little tool. They are 
already set to useful defaults and might even work almos out of the box if
you happen to run Debian Linux. These options are:

You most likely need to change:

 - MRTG_CONF - where is the mrtg.cfg file,
 - MRTG_WEBROOT - path component of the URI to your mrtg directory,
 - MRTG_FILEROOT - where in the filesystem are the mrgt files (html),
 - COL_NUM - mrtgindex uses tables for layout, how many colums should
   be used? Default is 2, which needs a browser window which is
   apprx. 1100 pixel wide. Set to one if this is too wide. Only 1 and 2
   are supported.
 - HTML_STYLE - defines the style of the HTML being produced, currently
   supported are
   - 1 = the old style (hierarchical structure),
   - 2 = new style with an always available navigation bar to the left

You should not need to change:

 - GLOBAL_INDEX - name of index file mrtgindex generates, default is
   index.html
 - SERVICEFILE_NAMEBASE - how are the filenames for the service files 
   generated, default is "overview-service-" resulting in 
   "overview-service-$SERVICE.html" filenames
 - HOST_NAMEBASE - how are the filenames for the host files
   generated, default is "overview-host-" resulting in
   "overview-host-$HOSTNAME.html" filenames
 - BG_COLOR - background color for generated webpages, default is
   "#FDF6E6" which equals the X color oldlace, a color that is much
   nicer on the eyes than bright white

Who wrote this?

My name is Alexander Schreiber, my email address is als@thangorodrim.de
I hope this script is useful for you, it certainly is for me (thats
why I wrote it).

What it the original distribution site?

http://www-user.tu-chemnitz.de/~als/software/mrtgindex/

What license applies?

This script, mrtgindex and its accompanying documentation is distributed
under the Artistic license. For more about this license, please see the
included file Artistic.

Filelist:

Artistic    - Artistic license
README      - documentation (this file)
mrtgindex   - the script itself


