This document will attempt to outline a basic install of UBMoD.

This installation document assumes you are running a Linux system and already have Apache, PHP, Perl and MySQL installed and running.

• Download the latest pre-built release (ubmod-x.x.x.tar.gz) here.

$ tar -xvzf ubmod-x.x.x.tar.gz
$ cd ubmod-x.x.x

mysql> create database ubmod;
mysql> grant all on ubmod.* to ubmoduser@localhost identified by 'password';
mysql> quit;

$ mysql -u ubmoduser -p ubmod < ./ddl/ubmod.sql

• Create the files portal/config/settings.ini and shredder/config/settings.ini with your site specific settings. An example can be found in the docs directory of the UBMoD distribution. These files both contain the same information. Two files are needed so that the portal and shredder can be moved and used separately if necessary.

[database]
host = localhost
dbname = ubmod
user = ubmoduser
password = password

• For PBS/TORQUE:

$ ./shredder/bin/ubmod-shredder -v -s -H your.host.org -f pbs -d /var/spool/pbs/server_priv/accounting

• For SGE:

$ ./shredder/bin/ubmod-shredder -v -s -H your.host.org -f sge -i /var/lib/gridengine/default/common/accounting

• For Slurm:

$ ./shredder/bin/ubmod-slurm-helper -v

$ ./shredder/bin/ubmod-shredder -v -u

• Add a virtual host to your Apache configuration. Update the path and port number where necessary. An example with comments (ubmod.conf) can be found in the docs directory of the UBMoD distribution.
• Copy the following into your Apache configuration file. Replace /path/to/ubmod with the appropriate path.

Listen 8080
<VirtualHost *:8080>
    DocumentRoot /path/to/ubmod/html
    <Directory /path/to/ubmod/html>
        RewriteEngine On
        RewriteRule ^api/rest/(.*)$ api/rest/index.php?path_info=$1 [L,QSA]
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteRule ^(.*)$ index.php?path_info=$1 [L,QSA]
    </Directory>
</VirtualHost>

• * Note this is a basic example of setting up Apache for use with UBMoD for demo purposes only and not intended for production use. UBMoD does not have built-in authentication or authorization access controls.

• Reload the Apache configuration.
• Point your browser to http://localhost:8080/.