WASSAIL Installation Instructions


Introduction
======================================
WASSAIL is not simply a drop-in program.  There is no package compiling or 
OS configuration necessary, but there are a couple steps necessary to ensure 
WASSAIL can operate properly.  Before starting, please ensure your system has 
met the system requirements.

======================================
= System Requirements
======================================
- Linux OS
	- Tested on SuSE 10, Ubuntu 8.10
- PHP 5.1.2
	- Will likely work on PHP 5.0 - 5.11
	- Will NOT work on PHP4
- Apache
	- Or compatible web server
	- mod_rewrite enabled
- MySQL 5+
	- May work on 4.x, but hasn't been tested

======================================
= User Requirements
======================================
Installing WASSAIL requires a certain level of technical expertise and system
access.

- Must have root access to change ownership of directories
- Must have access to your database (via command line or phpMyAdmin, etc)
	- Must be comfortable manually running queries
- Be able to modify variables in a PHP file


======================================
= Installation Steps
======================================


Expand package:
---------------
+ Uncompress the wassail.package.tgz file inside the folder in which you 
want WASSAIL to run.


Setup database
--------------
+ Create a database for WASSAIL to use.  The query to create a database named
"wassail" is: 

	CREATE DATABASE 
		`wassail`

+ Create a database user for WASSAIL to use.  The following query will create
the user "wassailuser" with the password "wassailpwd", and allow that user 
access to the"wassail" database on the local host:

	GRANT ALL ON 
		wassail.* 
	TO 
		'wassailuser'@'localhost' 
	IDENTIFIED BY
		'wassailpwd'

+ Import the wassail.sql file into your WASSAIL database. The wassail.sql file 
should be found in the root WASSAIL directory. From the command line, this 
command will import the file:

	mysql -u wassailuser -pwassailpwd wassail < wassail.sql

Of course, substitute your database user, password, and database name 
as appropriate


Update configuration
--------------------
+ Open include/classes/dbi.php and change the $db, $username, $password, and 
$host variables in the __construct() method to allow WASSAIL to connect to 
your database.  The variables are defined starting on line 49

+ Open include/config.inc
	- Update SYSADMIN_EMAIL if necessary
	- Find the line for UPLOAD_DIR.  By default it's set to 
	  /srv/www/uploads/ - which may not necessarily exist.  This is the
	  directory used to store uploaded CSV files that contain response
	  data.  Update this value to the server path of the directory you 
	  will use


Update filesystem
-----------------
+ As a server administrator (typically 'root'), change the ownership of the 
include/templates/compiled/ directory to whichever user the webserver runs 
as.  This will allow WASSAIL to display properly.

[ To determine the user the webserver runs as, load up "webserveruser.php" in 
  your browser. ]

+ As a server administrator, change the ownership of include/helpimages
to whichever user the webserver runs as. This will allow you to upload images
for the help screens.

+ As a server administrator, create the directory specified by UPLOAD_DIR in
include/config.inc and set the ownership to whichever user the webserver runs as.


Rename htaccess
---------------
+ Rename the 'htaccess' file to '.htaccess'.  This will provide the URL
rewriting to allow internal linking to function properly.


Finished
--------
That's it.  You should be able to login with the default user of "wassail" 
(no quotes) and the password "infolit".  IT IS HIGHLY RECOMMENDED that you 
change that password once you login.  You can do so by clicking on the 
"Accounts" tab, then clicking the keys icon beside the "wassail" user.