W3Perl 3.18
============

W3Perl is a free logfile analyzer for Web/FTP/Squid/Mail/DHCP and CUPS server.
W3Perl parse logfiles to produce HTML files. The package is designed
to be run within a web server, but it can works without (some features
won't be available).

No dependancy except Perl, no database needed or code insertion, 
and no other package is required (except if you want to install some plugins).

-------
Package
-------

Select the right package for your system. 
- Windows users should use an exe package (installation/configuration in one step)
     w3perl-iis for IIS, 
     w3perl-apache for Apache
     w3perl-abyss for Abyss and 
     w3perl.exe for people who doesn't run a webserver.
- Mac users should use the w3perl.dmg package
- Linux can use deb package on Debian/Ubuntu distrib or rpm

If you want to use the w3perl.tar.gz package, please read the following lines 
otherwise go to 'Configuration'
 
-------
Install
-------

You need to edit the install.pl script and change the following :
a) Perl path on the first line 

Most linux use /usr/bin/perl so you don't have to change anything

b) $pathcgi : Path to your w3perl's cgi-bin directory

W3Perl's scripts could be installed in a cgi-bin directory. Best is
to put the scripts in dedicated w3perl subdirectory. Some scripts
require to be called from a web interface (web admin/search tools...)
If you don't have any webserver running, you can still install the scripts
somewhere else.

c) $pathw3perl : Path to your w3perl's install

This is the directory from where you are reading this file.
Best is to uncompress the package in your web server tree as some
files (image/css/javascript) need to be called from a web interface.

Once the install have been run, your settings will be save in an upgrade.txt file.
On upgrade (run upgrade.pl), upgrade.txt will be use to upgrade the package.

See INSTALL for more informations (to install plugins ...)

-------------
Configuration
-------------

You need to build a configuration file to customize your stats.
Best is to use the web interface. Some predefined configuration files
are available. If you don't have a web server running, you can still use
the online tool on my website or edit one of the config files available
in the /config/ directory.

In a config file, you should define :
  - paths (output, logfile ...)
  - type of logfile, logfilename and logfile fields ...)
  - server (name, https ...)
  - filters (exclude/countries/domain ...)
  - output (language, precision ...)

-------
Running
-------

cron-w3perl.pl is the master script which launch others scripts.
(each script build specific reports like session/referer/browser/daily/weekly/error...)

Init :
Run cron-w3perl.pl -a to init all stats. Use -c <configfile> to load
your configuration file (default is to load a configfile named config.pl).
Use -d to parse the last few days or -r/-s to select a starting/ending date.
Best is to select only a few days on init to check your settings.

Upgrade:
Run cron-w3perl.pl -e to update the stats on a daily basis.
If you need hourly stats, run the cron-hour.pl script but it will
update only hourly report.

Help
====

You can ask for help in the forum or email me.
More documentation is available in HTML format in the docs directory.


This application is under GPL.

Enjoy !
Laurent Domisse.
domisse@w3perl.com
http://www.w3perl.com/
