Spam Vigilante Statistics Feature Pack (2006-07-22)
----------------------------------------
This add-on to the Spam Vigilante appliance that adds web-based mail statistics
through the use of amavis-stats and pflogstats.

When installed, graphical charts of pass/block statistics will be available
on the appliance at: http://<servername>/amavis-stats .  Per-user/per-domain
text statistics will be available at: http://<servername>/pflogstats .

----------------------------------------
INSTALLATION:

To install, login as root and unzip the update package.  Change into the
directory it creates and from there, run 'sh update.sh' to start.
The installation will take some time as many software components will be
downloaded and compiled, but is completely automated after executing
the update script.

Example:
# cd /tmp
# fetch http://www.path.to/sv_stats_fpack_<DATE>.zip
# unzip -o sv_stats_fpack_<DATE>.zip
# cd sv_stats_fpack_<DATE>
# sh update.sh

VIEWING:
To view the statistics, navigate to:
http://<servername>/amavis-stats (Graphical)
http://<servername>/pflogstats (Text)

The pflogstats page output can be adjusted by passing a query parameter of
the format type.  The default type is 'treeview.'  Allowed types are 'treeview'
and 'txttable'.

Example:
http://<server>/pflogstats?txttable

----------------------------------------
DOWNLOADING:
To download the update into the appliance directly use "fetch."
E.g. 'fetch http://www.path.to/sv_stats_fpack_<DATE>.zip'

To copy the update package remotely use a command like: 
'scp sv_stats_fpack_<DATE>.zip root@filter.my.domain:/usr/home/spamviewer/'

On Windows, one can use "pscp," part of the Putty SSH suite, or WinSCP to
copy the files to the filter.

----------------------------------------
STATISTICS NOTES:
amavis-stats:
The method used of averaging the statistics for output is not always accurate when
the time span is very broad and the entries have low counts.  Because of this
the stats at the various scopes (daily, weekly, monthly, and yearly) may
not tally perfectly.  It is not an error.

pflogstats:
The pflogstats statistics are for the length of the configured maillog archive,
by default this is eight (8) days: seven (7) days of archive and the current day.
Because gathering statistics for individual users can be complex, encountering 
a delay when loading the page is normal.  If it is important that the processing time
used for these calculations not be spent unnecessarily, it is recommended to configure
authentication on that page of the site to prevent unauthorized access.  Cf.
http://httpd.apache.org/docs/2.0/howto/auth.html .