# ---------------------------------------------------------------------
# truc is a tool for requirement and use case tracking
# Copyright (C) 2006 ASDIS - http://sf.net/projects/truc
#
# (rth) Initial truc version based on rth
#       Copyright (C) 2005 George Holbrook - rth@lists.sourceforge.net
#
# This program is distributed under the terms and conditions of the GPL
# See the README and LICENSE files for details
#----------------------------------------------------------------------

INSTALLATION

The following details the basic steps for installation on any system.  The
instructions will work fine on a Linux or Windows systems.
Barring complications, it should take you about 10 minutes to install,
configure, and start using truc.

# --- Requirements ----------

* MySQL 5.0 and higher (may work on earlier version)
* PHP 5.0 and higher (may work on earlier version)
* a webserver

# --- Summary ---------------

1. Copy truc directory to web server document root.
2. Create a database for truc
3. Install truc
3. Edit configuration file

# --- Detail ----------------

1. First, transfer the file to your webserver using whatever method you like (ftp, scp, etc).
You will need to telnet/ssh into the server machine for the next steps.

2. untar/gunzip it to the web server document root.
The usual command is (1 step):

	tar zxvf <filename.tar.gz>

OR  (2 steps):

	gunzip <filename.tar.gz>
	tar xvf <filename.tar>


3. Create a Database
	Create an empty database called for example : truc
	and a user which can access it and create tables in it.

4. Run open the url to the truc-installation in your browser
   You'll be lead to your setup.php.
   
   Enter the name of the database you created and the database user which can access it. Don't use root here.
   Enter now the database password.
   
   Now the truc-admin password and the truc-project name is required. You can change both later again.
   
   Press "Install!". You will get the content of the config_inc.php, copy all from the horizontal line downwards and save it in config_inc.php in truc root directory.
   
   Now you can remove the setup.php.

   Fill in the details for your configuration. You will be able to configure the config_inc.php later, if its needed.
   But in usual cases, changes are not needed.
	1. Set web server settings
	2. Enter database information
	3. Set the file upload path.  This will be used to store docs
	4. Select Login Method.  (MD5 is default. LDAP has not been tested thoroughly.)
	5. Turn javascript ON or OFF
		truc does a check at login to find out if a user has javascript enabled.
		If you know that the majority of your users have javascript disabled, you
		may want to turn off all javascript functionality.
	6. Turn FCKeditor ON or OFF
		You must have javascript enabled if you want to use FCKeditor
		Turning this on will make all html textarea objects appear as a WYSIWYG object
	7. Set debug options
	8. Set e-mail options
		Set the e-mail administrator - user or group that receives e-mail from users
					     - see the admin link on the home page
		Set sendmail equal to true or false.  The system will send no mail if turned off.
		Select the smtp server name
		Note: the full e-mail functionality for bugs is not yet complete
5. Allow writing in the file_upload directory
   Run this command in the truc root directory.
   chmod 777 file_upload