BUG - Bandwidth Utilization Grapher
Copyright (C) 2005 Gregory E. Bailey 
All Rights Reserved.


LICENSE
========================================
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA  02111-1307, USA


REQUIREMENTS
========================================
To run BUG, you will need to have installed:

  o  MRTG (on most RedHat-based systems, this is available as an RPM)
  o  rrdtool (RPM packages from http://dag.wieers.com/packages/rrdtool/)
  o  Apache 2


INSTALLATION
========================================
To install BUG, you'll need to copy files from subdirectories in
this install tree to specific directories on your target system:

  LOCAL TREE                            TARGET DIRECTORY
  ------------------------------        ------------------------------
  config/*.cfg                    --->  /etc/bug/.
  crond/bug                       --->  /etc/cron.d/bug
  httpd/bug.conf                  --->  /etc/httpd/conf.d/bug.conf
  scripts/bug_collect             --->  /usr/bin/bug_collect
  scripts/bug_collect_cisco5300   --->  /usr/lib/bug/bug_collect_cisco5300
  scripts/bug_collect_router      --->  /usr/lib/bug/bug_collect_router
  mibs/*.mib                      --->  /usr/lib/bug/mibs/.
  cgi/bug_graph.cgi               --->  /var/www/cgi-bin/bug_graph.cgi

You'll next need to create a directory that will hold the data
collected by BUG.  This directory should be owned by "root":

  o  /var/spool/bug

     Various subdirectories will be automatically created under
     this directory as data is collected from the specified
     devices.

You'll next need to create some directories that will hold the
temporary images and cache information used by the CGI
application.  This directory should be owned by "apache" or
whatever user ID your webserver runs as:

  o  /var/cache/bug
  o  /var/cache/bug/images
  o  /var/cache/bug/routers

     Various subdirectories will be automatically created under
     this directory as data is collected from the specified
     devices.


USAGE
========================================
BUG is invoked from cron every 5 minutes, and data is sampled
from the devices specified in bug.cfg and stored in RRDtool
files.  These files are then used to generate graphs by the
bug_graph.cgi script.