$Id: INSTALL,v 1.4 2005/04/19 22:50:22 bhockney Exp $

INSTALLATION

Installation is straightforward using the configure script and simple make
commands.  NOTE: You MUST run the configure script and make even if you are
not installing the syslog parser.

The configure script has many options.  Run configure with --help to see a
list of them.  Some useful ones are discussed below.

Installation directories:
  --sysconfdir=DIR           The directory where webfwlog.conf will be
                             installed.  Linux users may want to change this
                             to /etc.
                             Default: ${prefix}/etc

  --with-html-doc-root=DIR   document directory of your web server where you
                             want to install webfwlog.  configure will attempt
                             to determine automatically the document root
                             if you have apache installed, otherwise you must
                             specify it here.  This is a required value.

The following parameters relate to the syslog parser:
  --enable-syslog          build syslog parser

  --with-mysql[=DIR]       build MySQL support [library base directory DIR]
  --with-pgsql[=DIR]       build PostgreSQL support [library base directory DIR]

Database support is only used by the syslog parser to resolve host names and
service names.  This is optional, and you only need to include support for the
database server you are using.  You must have the shared libraries for your
database server installed, and configure will attempt to locate them
automatically.  Otherwise you will need to specify the location of the library
base directory with DIR. 

To install simply give these commands from the top level directory.

./configure <configure options>
make
make install (as superuser)

You should then look at the README file in the mysql or pgsql directory
for information on setting up your database server for use with webfwlog.

You should also review the example webfwlog.conf file and adjust the settings
to suit your installation.

UPGRADING

Install will not overwrite an existing webfwlog.conf file, but will install
webfwlog.conf as webfwlog.conf.new.  You should review webfwlog.conf.new as
new settings have been added to the configuration file.

If you are upgrading to 0.9x from 0.8x you will need to add two parameters
to your config file in order to use syslog files:
  wfwl_syslog=/path/to/wfwl_syslog executable
  syslog_dir=/path/to/logfiles

allow_show_sql is deprecated and has been changed to allow_be_verbose.

See the example webfwlog.conf file, which is well-commented.

Versions >= 0.84 have the ability to sort the reports on the main page, and
you should add a 'report_order' parameter to the config file.

Versions >= 0.83 use the client-side instead of server-side filesystem for
importing and exporting report definitions, and the report_def_dir setting
in the config file is ignored.

Versions >= 0.82 have a 'db' parameter in the config file.  You should add
this manually if upgrading.