------------------------------------------------------------------------------

Extra Information on Installation (Beau Kuiper)
===============================================

There are 2 executables in the muddlestats package that require
configuration.

- muddlestats-gather.py

  This application scans a muddleftpd log file, and updates a database file
  using any new data from the log. Run this first on the logfile when you
  update your statistics. You can run this on the same log file day after
  day. The header for this program contains the following variables.

	database - set this to the path and filename where the muddleftpd
                   statistics database will be stored.
	muddle_log - set this to the path of the log file to scan.


- muddlestats.pl

  This is a front end to the statistics package. It generates a series of
  detailed html pages using the information from the statistics database.
  The files are placed in a given directory to be served via webserver.
  The following variables need to be set in the program header.

	database - set this to the same statistics file you used in
		   muddlestats-gather.py
	wwwroot	- set this to a directory where the webserver can
		  serve the files. It should be an empty directory
		  so it can output files like index.html into it.
	mainfile - set this to whatever the webserver uses as the 
		   default file in a directory.
	fileprefix - all files (except mainfile specfieid above) created
		     by muddlestats.pl will have this prefix.
	uploads_first - I have no idea what this does, I recommend just
			leaving it as is for now.
	bgcolor - sets the background colour for all pages generated.
	textcolor - sets the text colour for all pages generated.
	linkcolor - sets the link colour for all generated pages.
	tablecolor1
	tablecolor2 
	tableheader - not sure what colours these set, play with them.
	chartbgcolor - the background colour for all generated charts.

One way that muddleftpd statistics can be gathered are via logrotate.d.
Included is an example logrotate.d file that shows how to do it.

It can also be done via crontab if you don't rotate your logs usin
logrotate.

------------------------------------------------------------------------------

Basic Installation
==================

Not much for now. See the scripts' headers and the enclosed directory structures.

Oh. And one more thing... this program won't run without the 'python' interpreter v1.5+
