ProCKSI

= ProCKSI Framework =

(needs to be updated)

== Installation and Basic Configuration ==

This section describes the installation and configuration of the ProCKSI server component. This includes the configuration of the web server and the database.

The server component 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.

Get the latest release of the server component, referred to in the following as ''RELEASE'', and extract it into ''/home/procksi/RELEASE.'' 

{{{

tar -xvzf RELEASE.tgz

}}}

Create a softlink from ''RELEASE'' to a generic directory ''/home/procksi/latest''. This will be accessed by the web server:

{{{

ln -s /home/procksi/RELEASE /home/procksi/latest

}}}

In order to test new versions, referred in the following as ''TEST'', before taking them officially online, create a softlink from ''TEST'' to a generic directory ''/home/procksi/test''. This will be accessed by the web server:

{{{

ln -s /home/procksi/TEST /home/procksi/test

}}}

In case that you want to bring the test version online, just delete the softlinks and repeat the previous steps for the new release. Please make sure that always both softlinks exist!

Change into the administrative directory and run the installation script. Change the server settings, database settings and directory settings if necessary.

{{{

cd /home/procksi/latest/admin

./configure.pl

}}}

== Web Server Configuration ==

Make the following changes to the Apache configuration file (''/etc/httpd/conf/httpd.conf''):

{{{

User  			procksi

Group 			procksi

ServerAdmin		procksi@cs.nott.ac.uk

ServerName 		procksi.cs.nott.ac.uk

DocumentRoot /home/procksi/latest/html

<Directory /home/procksi/latest/html">

   AllowOverride AuthConfig

</Directory>

LogFormat "%t %h %l %u \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined

LogFormat "%t %h %l %u \"%r\" %>s %b" common

LogFormat "%t %{Referer}i -> %U" referer

LogFormat "%t %{User-agent}i" agent

#Exclude Logging of Ganglia Requests

SetEnvIf Request_URI "ganglia" ganglia

#

# The location and format of the access logfile (Common Logfile Format).

# If you do not define any access logfiles within a <VirtualHost>

# container, they will be logged here.  Contrariwise, if you *do*

# define per-<VirtualHost> access logfiles, transactions will be

# logged therein and *not* in this file.

#

CustomLog /home/procksi/latest/logs/access.log common env=!ganglia

#

# If you would like to have agent and referer logfiles, uncomment the

# following directives.

#

CustomLog /home/procksi/latest/logs/referer.log referer env=!ganglia

CustomLog /home/procksi/latest/logs/agent.log agent env=!ganglia

#

# For a single logfile with access, agent, and referer information

# (Combined Logfile Format), use the following directive:

#

#CustomLog logs/access_log combined env=!ganglia

ScriptAlias /cgi-bin/ /home/procksi/latest/cgi-bin/

<Directory "/home/procksi/latest/cgi-bin">

    AllowOverride None

    Options None

    Order allow,deny

    Allow from all

</Directory>

Alias  /data/ 	  /home/procksi/latest/data/

Alias  /images/   /home/procksi/latest/images/

Alias  /styles/   /home/procksi/latest/styles/

Alias  /applets/  /home/procksi/latest/applets/

Alias  /scripts/  /home/procksi/latest/scripts/

Alias  /ganglia/  /usr/local/ganglia/html/

#Redirection

Redirect /trac https://psiren.cs.nott.ac.uk/projects/procksi/

AddLanguage de .de

AddLanguage en .en

AddLanguage es .es

AddLanguage fr .fr 

LanguagePriority en es de fr

Alias /errordocs/ "/home/procksi/errordocs"

<IfModule mod_negotiation.c>

    <IfModule mod_include.c>

        <Directory /home/procksi/errordocs>

            AllowOverride none

            Options MultiViews IncludesNoExec FollowSymLinks

            AddType text/html .shtml

            <FilesMatch "\.shtml[.$]">

                SetOutputFilter INCLUDES

            </FilesMatch>

        </Directory>

        ErrorDocument 400 /errordocs/400_BAD_REQUEST

        ErrorDocument 401 /errordocs/401_UNAUTHORIZED

        ErrorDocument 403 /errordocs/403_FORBIDDEN

        ErrorDocument 404 /errordocs/404_NOT_FOUND

        ErrorDocument 405 /errordocs/405_METHOD_NOT_ALLOWED

        ErrorDocument 406 /errordocs/406_NOT_ACCEPTABLE

        ErrorDocument 408 /errordocs/408_REQUEST_TIMEOUT

        ErrorDocument 410 /errordocs/410_GONE

        ErrorDocument 411 /errordocs/411_LENGTH_REQUIRED

        ErrorDocument 412 /errordocs/412_PRECONDITION_FAILED

        ErrorDocument 413 /errordocs/413_REQUEST_ENTITY_TOO_LARGE

        ErrorDocument 414 /errordocs/414_REQUEST_URI_TOO_LARGE

        ErrorDocument 415 /errordocs/415_UNSUPPORTED_MEDIA_TYPE

        ErrorDocument 500 /errordocs/500_INTERNAL_SERVER_ERROR

        ErrorDocument 501 /errordocs/501_NOT_IMPLEMENTED

        ErrorDocument 502 /errordocs/502_BAD_GATEWAY

        ErrorDocument 503 /errordocs/503_SERVICE_UNAVAILABLE

        ErrorDocument 506 /errordocs/506_VARIANT_ALSO_VARIES

    </IfModule>

</IfModule>

<Location /server-status>

    SetHandler server-status

    Order deny,allow

    Deny from all

    Allow from .cs.nott.ac.uk

</Location>

<Location /server-info>

    SetHandler server-info

    Order deny,allow

    Deny from all

    Allow from .cs.nott.ac.uk

</Location>

}}} 

* Make the apache daemon start at bootup. Enter at the command line of the master node:

   {{{

   /sbin/chkconfig  --add httpd

   /sbin/chkconfig  httpd  on

   }}}

 * Start the apache daemon. Enter at the command line of the master node: 

   {{{

   /sbin/service  httpd  restart

   }}}

== Email Configuration ==

The ProCKSI server component send emails to the user for several occasions. In order to make sure that they are delivered correctly even when the internet is temporarily not available, a local SMTP server (''postfix'') is set up. This will accect emails from the private network only, store them temporarily (if necessary), and forward them to an email relay server.

Make sure that ''postfix'' is the default mailing software (and not ''sendmail''!).

{{{

system-switch-mail -activate postfix

}}}

Make the following changes to the ''postfix ''configuration file (''/etc/postfix/main.cf''):

{{{

myhostname = procksi0.cs.nott.ac.uk

mydomain = cs.nott.ac.uk

myorigin = $mydomai

inet_interfaces = all

mydestination = $myhostname, localhost.$mydomain, localhost

mynetworks_style = subnet

virtual_alias_maps = hash:/etc/postfix/virtual

relayhost = marian.cs.nott.ac.uk

}}}

Create or modify ''/etc/postfix/virtual'':

{{{

root        root@localhost

postmaster  postmaster@localhost

adm         root@localhost

}}}

Generate the corresponding database file (''virtual.db''):

{{{

postmap /etc/postfix/virtual

}}}

Make sure that the postfix daemon is running, and that it will start at boot time:

{{{

/sbin/service postfix start

/sbin/chkconfig --add postfix

/sbin/chkconfig postfix on

}}}

Make sure that the firewall is not open for port 25 or port 28!

Check that the STMTP server in ''/home/procksi/latest/conf/main.ini'' is set correctly set to ''procksi0.cs.nott.ac.uk''

== Garbage Cleanup Scheduling ==

After a certain period of time, given in ''/home/procksi/latest/conf/main.ini'', sessions and requests expire and must be deleted. 

Edit ''procksi's'' crontab file taking effect for the ''latest'' and ''test'' version:

{{{

crontab -e

  0-59/1 * * * * /home/procksi/latest/cron/check_sessions.sh

  1-59/1 * * * * /home/procksi/latest/cron/check_tasks.sh

  2-59/1 * * * * /home/procksi/latest/cron/check_requests.sh

}}}

Analogously for ''/home/procksi/test''.

== Linking External Software ==

Make sure that all links in ''/home/procksi/latest/bin'' point to the correct files of the operating system: 

{{{

sh, compress, bzip2, gzip, zip, ppmz, qsub

}}}

Make sure that all further executable links in ''/home/procksi/latest/bin'' point to the correct files on the file system: 

{{{

 exec_cluster, exec_!DaliLite, exec_MaxCMO, exec_molauto, exec_molscript

}}}