0.0 ABOUT

   This file contains some basic documentation for the OverCR
   configuration file. One of the biggest criticisms of "Open Source"
   software is that it lacks good "free" documentation. (The Oreilly
   Effect) This is my feeble attempt at avoiding that. BTW: The OverCr
   Collector will reload its configuration file if it recieves a HUP
   signal.

   - Eric Molitor (eric@molitor.org)


1.0 LOCATION

   The OverCR collector looks for a config file in '/etc/collector.conf'.
   If a file is not found there it then checks the local directory for
   'collector.conf'. If a file is not found in either of those locations
   it then displays an error message and exits.

   If a configuration file is in both '/etc/collector.conf' and the local
   directory then the file in /etc takes precedence.


2.0 CONTENTS

   The OverCR configuration file is loosely based off of the configuration
   style of BIND 8.xx and higher. To the developers this seemed to be a
   good solution for a configuration file that was flexible, extensible,
   and easy to use.


2.1 SERVICES

   services {
      diskspace,
      uptime,
      load,
      postel,
      process,
      netstat,
      help
   };

   The allowed services are specified via a comma delimited list in the
   services section of the configuration file. If a service is NOT desired
   simply comment it out with a pound sign or remove it.

   EG:

      services {
         diskspace,
         uptime,
         load,
         #postel,
         process,
         netstat,
         #help
      };

   In this example both the postel function (RIP) and the help function 
   are disabled.


2.2 IP_ALLOW

   ip_allow {
      127.0.0.1,
      192.168.250.1,
      10.1.1.20
   }

   IP address' of machines allowed to access this server are specified via
   the ip_allow section. Similar to the services section this is a comma
   delimited list of ip addresses which are allowed to access OverCR. By
   default OverCR comes configured only to talk to the LOCAL HOST. Make
   sure you specify the IP Address of any machines which are to access
   the OverCR collector!

   EG:

      ip_allow {
         127.0.0.1,
         209.207.224.40
      }

   In this example the local host and the server located at 209.207.224.40
   (slashdot.org) will be able to access the OverCR collector on this
   machine.


2.3 TIMEOUT

   timeout = 5;

   The timeout setting configures how long the OverCR collector will wait
   for a command to be issued before disconnecting. Unless you know what
   your doing this should never be any higher then 5!


2.4 PORT

   port = 2000;

   This indicates what port the OverCR collector will run on. Root access
   is required on all ports under 1024, unless you know what you doing
   then leave it above 1024!


2.5 LOG_FILE

   log_file = '/var/log/collector.log';

   This statement indicates where the OverCR logfile is located. In
   general you should use a fully qualified path for this. If you get
   errors when running collector.pl saying to the effect that "You don't
   have permissions to access BLAH" Ooops, betcha that hurt! then you have
   configured the OverCR collector to log to a directory or file that it
   does not have permission to access. (Or you've exceeded quota, the disk
   is out of free space, etc.)
