Hawk Version 0.6

Greg Heim <gregheim@mindspring.com>


What is Hawk?
-------------

   Hawk is a web based utility for monitoring and comparing hosts 
   on your network with what's in DNS.  Hosts that are answering 
   pings but are not in dns may be unauthorized, and hosts that are 
   in DNS, but are not answering may be able to be reclaimed.  Hawk 
   monitors all hosts on the networks you specify and lets you view
   them via a web page.

   Hawk consists of a backend written in perl that monitors hosts by
   icmp pings and writes the status to a mysql database.  The frontend
   is in php and lets you select which network to view, and how to view
   it.


Where do I get Hawk?
------------------

   Well, apparently you already have!  But if you haven't, you can get
   the latest download information from iphawk.sourceforge.net.


License
-------

   Hawk is covered under the GNU Public License.  See the COPYING file.



Requirements & Installation
---------------------------

   Requirements:

      Perl 5 - may work with other versions.
      Perl Modules - the following modules will be required
         Net::Netmask
         Net::Ping
         DBI
         DBD::mysql
      Mysql - This was initially writting running 3.23.37.  It would 
         probably be trivial with perl DBI to switch to another database.  
         The PHP would probably be easy as well.
      PHP - Was written with 4.0.6 under Apache 1.3.22
      phpMyAdmin - not necessary, but sure is handy for managing the database


   Installation:

      1. Make sure above software or equivalent is available
      2. Unpack (tar, gunzip) software at a location accessible by web server

            ./daemon                 - directory for perl backend monitor
            ./daemon/hawk            - the monitor
            ./daemon/hawk.conf       - config file for hawk deamon
            ./php                    - directory for php interface
            ./php/hawk.conf.inc      - php interface config file
            ./php/hawk.css           - style sheet for hawk
            ./php/hawk.php           - hawk php frontend
            ./php/images             - directory for hawk images

      3. Create the mysql database and table for Hawk.  This sql should do it.

            create database hawk;
            create table ip (
               ip char(16) NOT NULL default '0',
               hostname char(255) default NULL,
               lastping int(10) default NULL,
               PRIMARY KEY  (ip),
               UNIQUE KEY ip (ip),
               KEY ip_2 (ip)
            ) TYPE=MyISAM COMMENT='Table for last ping time of hosts';

      4. Modify ./daemon/hawk.conf file with your configuration/preferences
      5. Modify ./php/hawk.conf.inc file with your configuration/preferences
      6. Create a startup script for launching hawk monitor upon boot
      7. Modify web server so hawk.php is accessible
      8. Start hawk (watch logfile (debug level = 2) to confirm proper
         operation)
      9. Launch hawk.php from browser




Support, Suggestions, & Contributions
-------------------------------------

   If you find bugs, have suggestions for improvement, or would like
   to contribute, please contact me at the address below.  If you use
   Hawk and like it, or want me to let you know about updates, let me
   know.

   If you have all the required packages installed, installation should
   be pretty it straight forward.  But if you do have problems, I will
   try to answer whatever questions I can.


Contact
------

   Greg Heim <gregheim@mindspring.com>
