network jack - INSTALL
======================

  Version 2.0 rc 1 - 29 Novemeber 2002
  ------------------------------------
  http://www.the42.net/jack

  Requirements: 
    Web server able to run perl scripts.
    A web-browser 
    Perl 5.6
    Perl Modules:
      Net::DNS  (cpan or http://www.net-dns.org/)
      NetAddr::IP (cpan ; http://search.cpan.org/author/LUISMUNOZ/NetAddr-IP-3.14/)
      Net::DNSBL (http://www.the42.net/net-dnsbl)
    jwhois (ftp://ftp.gnu.org/gnu/jwhois/)
    
  Installation
    1) Install the requisites
    2) Patch the jwhois.conf file
        # default location is /usr/local/etc/jwhois.conf
        # in the directory with jwhois.conf:
             patch -p 0 < <networkjack src path>/jwhois.conf.3.2.0.patch
    3) Copy src directory to the appropriate directory to be access by your 
       web server
         # for example (if /usr/local/htdocs/jack did not exist):
             cp -rp src /usr/local/htdocs/jack   
    4) Make sure that the directory you copied the files to allows scripts 
       to be executed scripts to be executed
       For Apache, that means having ExecCGI enabled in the directory and
       having the cgi-script handler on for the .cgi extension
         # AddHandler cgi-script .cgi
    5) If you want, rename nj.cgi to index.cgi and (for apache) setup 
       DirectoryIndex to also use index.cgi 
         # DirectoryIndex index.html index.cgi index.php
    6) Modify networkjack/config.pm appropriatly to configure network jack.
         # if this is a new install, you'll need to rename or copy 
           networkjack/config.pm.dist to networkjack/config.pm
         # for upgrades, the INSTALL document will identify new / changes 
           settings that need to be added to your existing config.pm file.
   
  Recommendations
    o Insure that people do not have access to the ancillary files.
      For Apache, I typically setup the following:

      <Files ~ "(^\.ht|\.inc$|\.pm$|\.conf$)">
          Order allow,deny
          Deny from all
          Satisfy All
      </Files>

  Configuration (networkjack/config.pm)
    o $CONFIG{tools}{<module>} = '<description>';
      - don't change the <module> (unless you are adding new ones).  
      - The description can be changed to reflect what you want shown on the "toolbar" display.
    o $CONFIG{defaulttool} = 'digger';
      - module to use as the default (radio button is selected on the toolbar)
    o $CONFIG{order}{<order>} = '<module>';
      - What order do you want the modules displayed in the toolbar
      - To remove a module, remove it from this list
      - <module> must be a defined module in $CONFIG{tools}
    o $CONFIG{command}{<module>} = '<path/command>';
      - Full path to command line tools used by the module 
      - Currently, pinger, tracer, and whoser rely upon command line tools
        (ping, traceroute, and jwhois)
    o $CONFIG{nameserver} = '127.0.0.1';
      - IP address or Name of the name server to be used by the tools (primarily digger).
      - If a name is used, the server must be able to resolve the name
    o $CONFIG{html}{default}{maintaineremail} = 'jack@the42.net'
      - email address of the person who maintains this instance of network jack
    o $CONFIG{html}{default}{maintainer} = 'Network Jack'
      - Name of the individual who is responsble for this instance
    o $CONFIG{html}{default}{sitename} = 'Network Jack'
      - Name of this instance of network jack
    o $CONFIG{html}{default}{title} = 'Network Jack'
      - Text to display on the title bar
    o $CONFIG{html}{default}{siteserver} = 'http://www.the42.net'
      - site protocol / server name
    o $CONFIG{html}{default}{base} = '/jack'
      - base directory (from root of web server) of the script
    o $CONFIG{html}{default}{siteurl} = $CONFIG{html}{default}{siteserver} . $CONFIG{html}{default}{base}
      - full url to the base of the script
    o $CONFIG{html}{default}{imagedir} = $CONFIG{html}{default}{base} . '/images'
      - path to the images
    o $CONFIG{html}{default}{script} = 'nj.cgi' 
      - name of the script.  
      - nj.cgi is of course the default, but if your web server is setup to allow
        index.cgi (or something similar) as a DirectoryIndex, you can use '' as the script
        name (if you rename nj.cgi to index.cgi).
    o $CONFIG{html}{default}{bgcolor}    = '#000000'
      $CONFIG{html}{default}{text}       = '#999999'
      $CONFIG{html}{default}{link}       = '#FFFFFF'
      $CONFIG{html}{default}{vlink}      = '#D8D8BF'
      - colors to use by default
    o $CONFIG{html}{toolbar}{bgcolor}    = '#000000'
      $CONFIG{html}{toolbar}{text}       = '#999999'
      $CONFIG{html}{toolbar}{link}       = '#FFFFFF'
      $CONFIG{html}{toolbar}{vlink}      = '#D8D8BF'
      - colors to use in the toolbar.  if not specified, the default is used
    o $CONFIG{html}{toolbar}{background} = $CONFIG{html}{default}{imagedir} . '/bkg-blue.gif';
      - background image to display as part of the tool. 
    o $CONFIG{html}{toolbar}{submit}     = 'Jack It';
      - Text to display on the submit button of the toolbar
    o $CONFIG{html}{toolbar}{reset}      = 'Clear';
      - Text to display on the reset/clear button
    o $CONFIG{html}{toolbar}{comment}    = 'Network Jack';
      - text to display before the list of modules on the toolbar
    o $CONFIG{html}{toolbar}{query}      = 'Lookup';
      - text to display before the "text" field on the toolbar
    o $CONFIG{linker}{links}{<group>}{group}      = 'poweredby'
      - name of this group of links
      - <group> is a sortable field to determine the order this group is displayed
    o $CONFIG{linker}{links}{<group>}{description}      = 'Powered By'
      - Description of this group
    o $CONFIG{linker}{links}{<group>}{columns}{<column>}{<order>}{description}      = 'Perl'
      $CONFIG{linker}{links}{<group>}{columns}{<column>}{<order>}{link}             = 'http://www.cpan.org'
      - Description and url for this link
      - <column> is either '01' or '02' (for the first and second columns 
        of the link table)
      - <order> is the sortable identifier used to determine the order of 
        the links in the column
    o Additional "linker" information
      - there can be as many groups as you want
      - there can only be two (2) columns
      - there can be as many links as wanted in each column