ProCKSI

= ProCKSI Workbench Framework =
(needs to be updated)

== Installation and Basic Configuration ==
This section describes the installation and configuration of the ProCKSI server side of the ProCKSI-Workbench. component. This includes the configuration of the web server and the database.

The server component (incl. all user data and results) will be installed into the home directory of the user ''procksi''. Therefore, make sure that it is on a separate partition / hard disk with much space. In the best case, this will be a RAID system.

'''IMPORTANT''': Always test a new Get the latest release before taking a new version online!

== Preparations for '''TEST''' and '''RELEASE''' ==

Make sure that directories for log and lock files exist, which are shared by all '''TEST''' and '''RELEASE''' instances (see below for more information):
{{{
mkdir /home/procksi/logs
mkdir /home/procksi/locks
}}}

== Installation and Configuration of a ''TEST'' version ==

In the following, any test version of the workbench is server component, referred to as ''TEST'', which could be either a tagged release or a snapshot of the current development version. ''TEST'' should include the current date in order to distingish different snapshots from different days, e.g. ''snapshot_2008-08-01''.

Check out the current snapshot of the development version from the SVN repository.
following as ''RELEASE'', and extract it into ''/home/procksi/RELEASE.''
{{{
svn co https://psiren.cs.nott.ac.uk/repos/procksi/ProCKSI-Workbench/trunk /home/procksi/TEST
tar -xvzf RELEASE.tgz
}}}

Create a softlink from ''TEST'' ''RELEASE'' to a generic directory ''/home/procksi/test''. The ''/home/procksi/latest''. This will be accessed by the web server and the workbench itself assume that there is always such a generic directory: server:
{{{

ln -s /home/procksi/TEST /home/procksi/test /home/procksi/RELEASE /home/procksi/latest
}}}

Change into the installation directory, run the setup script once to see the default settings. Running the script ''without'' the parameter ''-x'' just displays the current configuration.
{{{
cd /home/procksi/test/install
./setup.pl -i -env test
}}}

Run the setup script again with adjusted parameters. Parameters that might need adjustment are:
- ''-server_base'': Should be ''/home/procksi/test''
- ''-server_name'': URL and port number for this ''TEST'' version as given in the ''apache'' configuration file
- ''-server_admin'': Email address of the administrator or this ''TEST'' version
- ''-database_name'': Database that should be used for this ''TEST'' version

In order to execute the installation for the given configuration, you must run the script ''with'' the parameter ''-x''.
{{{
cd /home/procksi/test/install
./setup.pl -i -env test -x
}}}

Check that all links new versions, referred in ''/home/procksi/test/bin'' point to the correct files of the operating system.

Having '''root privileges''', make sure that all permissions are set to '770', the user is ''procksi'' and the group is ''procksi_dev''.
{{{
cd /home/procksi/test/admin
./chall.sh
}}}

== Installation and Configuration of an official '''RELEASE''' ==

In the following, the latest official version of the workbench is referred to following as ''RELEASE'', which could be for instance ''procksi_8-6-1''.

Check out the latest ''RELEASE'' from the SVN repository:
{{{
svn co https://psiren.cs.nott.ac.uk/repos/procksi/ProCKSI-Workbench/tags/RELEASE /home/procksi/RELEASE
}}}

Create ''TEST'', before taking them officially online, create a softlink from ''RELEASE'' ''TEST'' to a generic directory ''/home/procksi/latest''. The ''/home/procksi/test''. This will be accessed by the web server and the workbench itself assume that there is always such a generic directory: server:
{{{

ln -s /home/procksi/RELEASE /home/procksi/latest /home/procksi/TEST /home/procksi/test
}}}

Change into the installation directory, run the setup script once In case that you want to see bring the default settings. Running test version online, just delete the script ''without'' softlinks and repeat the parameter ''-x'' just displays previous steps for the current configuration. new release. Please make sure that always both softlinks exist!

Make sure that a shared directory for log and lock files of all releases exists:
{{{
cd /home/procksi/latest/install mkdir /home/procksi/logs
./setup.pl -i -env latest mkdir /home/procksi/locks
}}}

In order to execute Change into the installation for the given configuration, you must administrative directory and run the script ''with'' installation script. Change the parameter ''-x''. server settings, database settings and directory settings if necessary.
{{{
cd /home/procksi/test/install /home/procksi/latest/install
./setup.pl -i -env latest -x
}}}

Check that all links in ''/home/procksi/latest/bin'' point to the correct files of the operating system.

Having '''root privileges''', make sure that all permissions are set to '770', the user is ''procksi'' and the group is ''procksi_dev''.
{{{
cd /home/procksi/latest/admin
./chall.sh
}}}