1. Prequesites
------------------------------------------------------------------------------------------

phpSATk is tested to run on Linux and Windows using Apache and LigHTTPd webservers.

Make sure you have the following installed:
* A current PHP version (5.2.2 best - dom,pdo,json,xmlrpc enabled)
* MySQL (4.1+/5.0)
* PHPTAL (Version 1.1.8 required) has to be installed into your include path.

Optional:
* memcached and PECL-memcache

2. Unpacking
------------------------------------------------------------------------------------------
Download a package (either zip, tar.gz or tar.bz2) of the current version and unpack it 
somewhere outside your document root. Move “phpsatk” and “phpsatk-lib” to a place where 
they can stay (that is, again, outside your document root). 
Now copy (or symlink if you webserver allows this) the contents of the htdocs folder 
contained in the package to the place beneath your document root where you want to reach
your phpSATk installation.

3. Base Configuration
------------------------------------------------------------------------------------------
Open “config.php” in an editor and change the paths defined as SAT_LOCAL and 
SAT_INCLUDEDIR to the paths to your “phpsatk” (LOCAL) and “phpsatk-lib” (INCLUDEDIR) 
directories.

4. Creating databases
------------------------------------------------------------------------------------------
You will propably want to use some modules which need a database to work 
(especially the Authentication/Authorization modules), so create a database and import 
the dump (MySQL only atm) which is located in the global (phpsatk-lib) repository under 
contrib/base.sql. It contains tables for access control and the job server. 
This step will be included in some installation/packaging mechanism some day, 
but don’t expect this to come soon.

5. Permissions
------------------------------------------------------------------------------------------
Change all permissions so that the user php is running on can read but not write them. 
The files in you document root need to be accessible by the webserver too 
(in most situations this will be the same user). Now give the php user write privileges
to the cache folder (and its subdirectories) below the local repository 
(called ‘phpsatk’ before).

6. Configuration
------------------------------------------------------------------------------------------
Go to you local repository and copy conf/local.conf.xml.dist to conf/local.conf.xml. 
Now open this file and change the given values to ones that match you environment.

The directives you want to change are:
“auth.dummy.pass” to a password that can be used for authenticating using the “admin” user.
“rdbms.default” to a URL for you database (format is “<type>://<user>:<pass>@<host>/<db>”).

7. Launch
------------------------------------------------------------------------------------------
You are now ready to open you web-browser and point it to the URL where your ‘htdocs’ 
directory is located.


8. Demo Applications
------------------------------------------------------------------------------------------
This release includes some demo applications which might need further configuration:

CA:
 - has an additional sql dump for installation, make sure to import it first
   ("phpsatk-lib/contrib/ca.sql").
 - uses the jobserver so make sure to have "jobs.runner.php" configured to a php-cgi 
   executable. On windows platforms you will need to have SysInternals/Microsoft
   PsTools (http://www.microsoft.com/technet/sysinternals/Security/PsExec.mspx)
   installed and "jobs.runner.psexec" pointing to it's path.
 - For certificate revokation you will need to patch your php installation at the
   moment (PHP 5.3 will possibly include it), you can get it at:
   http://mbechler.eenterphace.org/blog/uploads/ext-openssl.patch
 - You might want to modify the openssl.cnf in phpsatk/data.
   
KDAM5:
 - requires my php_krb5 extension to be installed, get it at 
   http://mbechler.eenterphace.org/php_krb5-beta.tar.gz
 - You need to configure the "kadm5." directives in the configuartion
   to get it work.   

9. Support
------------------------------------------------------------------------------------------ 
I'm willing to help you with your tests as I am very interested in opinions about
phpSATk. The main ways to contact me are:
- via the mailinglist phpsatk-general@phpsatk.eenterphace.org (requires subscription:
   http://phpsatk.eenterphace.org/docs/doku.php/support)
   
- on IRC, I usually hang out (keep in mind ... CET) on IRCNet where you can find me on 
   the channel #phpsatk.
   
- directly via mail (I would appreciate if you use the mailinglist):
	mbechler AT eenterphace DOT org
	
Additional information can be found on the project website (especially in the wiki):
 http://phpsatk.eenterphace.org/