INSTALLING SQUINT

	INSTALLING SQUINT
	$Id: INSTALL,v 1.5 2004/01/07 08:55:50 andrewm Exp
	REQUIREMENTS
	. Squid proxy server
	. Perl (/usr/bin/perl)
	. Apache (to view documents), or a local web browser
	. Lotsa CPU time (it is very inefficient) (did I mention that it
	is inefficient?)
	INSTALLATION
	# tar -zxvf squint.tgz
	I hope this part is easy enough
	# cp squint.pl squint.cron.sh /usr/local/bin
	Install the binaries in a nice place
	# squint.cron.sh init
	This creates a place for the reports in /usr/local/httpd/htdocs (or
	whereever the htdocs directory is found). It installs a crontab entry
	to run the report daily, weekly and monthly. You may wish to edit the
	crontab entry first -- the system has not been optimised for security,
	and runs (unnecessarily) as the user root, rather than the user squid.
	# squint.cron.sh all
	Create current daily, weekly and monthly reports -- don't do this
	twice! -- the reports get rotated every time you run the task, so
	things can get a little messy.
	# squint.cron.sh regen
	Recreate all the reports for your initial system, and also
	for when the program manges to mess things up.
	# ---------------------------------------------------------------------------
	# Jan Henkins of Obsidian (obsidian.co.za) contributed these instructions,
	# which may or may not correspond to the current version of squint.
	Install Squint
	==============
	First things first:
	-------------------
	[ Update: REPORTS has been removed - important environment variables are now
	BASEDIR (reports) and LOGDIR (squid logs) ]
	After you have unpacked the squint-xxxxxxxx.tar.gz file, go into the
	directory that was created. Before you install squint, check and edit
	the squint.cron.sh file to reflect the correct paths to where you want
	things to be put. Pay special attention to the REPORTS variable (line 3)
	for a valid path to your HTML document root, and the "find" statement on
	line 45 to point to the correct directory where your squid stores it's
	logs.
	Installing the software:
	------------------------
	Simply run "make install", and make will put things in /usr/local/bin
	Installing the crontab entry:
	-----------------------------
	Normally you can do this yourself, but the Makefile allows you to install
	it automatically by running "make init". This will add an entry to the
	bottom of the /etc/crontab file, as well as run the squint analyzer to
	create you your first set of files in the HTML directory you have specified.
	Your crontab entry should look something like this:
	# squint squid reports
	30 14 * * Fri root /usr/local/bin/squint.cron.sh weekly
	00 01 * 1 * root /usr/local/bin/squint.cron.sh monthly
	00 01 * * * root /usr/local/bin/squint.cron.sh daily
	Have fun!