
                   Gnatsweb - web front-end to gnats

                           Installation Guide


Quick start for the impatient
=============================

    0. Install gnatsd, the gnats network server.  Gnatsweb doesn't run
       without it.

    1. If your gnats server is on the same host as your web server, 
       skip this step.  Otherwise, read gnatsweb.pl, and follow the
       directions for creating a site configuration file,
       'gnatsweb-site.pl', containing the gnats host and port number.

    2. Run the tests to make sure everything is OK.  Specify a
       username/password/database_name on the command line like so:

           make test USERNAME=anon PASSWORD=pw DATABASE=db_alias

       The specified user must have at least 'viewconf' permissions,
       because the tests read the first 50 PR's in your database (of
       course they don't modify any) and some of those PR's may be
       marked Confidential.

       If you don't see the message "All tests passed", investigate.

    3. Install gnatsweb.pl (and gnatsweb-site.pl if you created one)
       into a CGI-enabled directory on your web server.  For example, on
       Red Hat Linux with Apache:

           make install CGI_DIR=/home/httpd/cgi-bin


Known problems and solutions
============================

    1. Problem: Email is going to the wrong place, e.g. to 'joe' instead
       of 'joe@my.org'.

       Solution: Fix all the email addresses in
       $GNATS_ROOT/gnats-adm/responsible.
