Merged v0.2 branch

AUTHORS

@@ -3,7 +3,10 @@ UBMoD - AUTHORS
 ===============================================================================
 
 The code for UBMoD was originally written and currently maintained by:
-    Andrew E. Bruno <aebruno2@ccr.buffalo.edu>  
+    Andrew E. Bruno <aebruno2@ccr.buffalo.edu>
+
+The PHP and Perl rewrite was written and currently maintained by:
+    Jeffrey T. Palmer <jtpalmer@ccr.buffalo.edu>
 
 Contributors:
     -;

ChangeLog

@@ -2,14 +2,23 @@
 UBMoD - ChangeLog
 ===============================================================================
 
+- 2011-11-11 v0.2.0
+    - Rewrote portal in PHP and shredder in Perl
+    - Restructured database
+    - Added additional time periods
+    - Added support for SGE accounting logs
+    - Added Tagging feature
+    - Added monthly charts
+    - Replaced CPU consumption charts with wall time charts
+
 - 2011-01-25 v0.1.3
     - Fixed PBS log parser to handle job arrays
 
 - 2010-12-17 v0.1.2
     - Fixed typo in pom.xml to include portal source code in src assembly
 
 - 2010-11-11 v0.1.1
-    - Fixed bug in shredder to allow for negative wall times. 
+    - Fixed bug in shredder to allow for negative wall times.
     - Added jdk15 classifier to pom.xml net.sf.json-lib library
 
 - 2007-11-11 v0.1.0

INSTALL

@@ -7,15 +7,31 @@ still actively being developed these instructions may be incomplete and are
 subject to change in future releases. Any feedback is welcome.
 
 The latest version of this document can be found online at:
-  http://ubmod.sourceforge.net/install.html
+
+    http://ubmod.sourceforge.net/install-source.html
 
 This installation document assumes you are running a Linux based system and
-already have MySQL version 5 or greater installed and running. UBMoD requires
-Java version 1.5 or greater.  Download UBMoD
+already have Apache with mod_rewrite and MySQL version 5.1 or greater
+installed and running. UBMoD requires PHP version 5.3 or greater and Perl 5.8
+or greater. PHP must be built with MySQL, GD and PDO support. Perl requires
+the following modules: DBI, DBD::mysql, Config::Tiny and DateTime.
+
+These can be installed on Red Hat based systems with the following command:
+
+    # yum install httpd mysql-server mysql php php-mysql php-pdo php-gd perl \
+                  perl-DBI perl-DBD-MySQL perl-Config-Tiny perl-DateTime
+
+and on Debain based systems with this command:
+
+    # apt-get install apache2 mysql-server mysql-client libapache2-mod-php5 \
+                      php5 php5-mysql php5-gd perl libdbi-perl \
+                      libdbd-mysql-perl libconfig-tiny-perl libdatetime-perl
 
-* Download the latest pre-built release (ubmod-x.x.x-bin.tar.gz)
+Download UBMoD
 
-    $ tar -xvzf ubmod-x.x.x-bin.tar.gz
+* Download the latest pre-built release (ubmod-x.x.x.tar.gz)
+
+    $ tar -xvzf ubmod-x.x.x.tar.gz
     $ cd ubmod-x.x.x
 
 * Set up the MySQL database
@@ -26,38 +42,59 @@ Java version 1.5 or greater.  Download UBMoD
 
     $ mysql -u ubmoduser -p ubmod < ./ddl/ubmod.sql
 
-* Create the UBMoD config file
+* Create the UBMoD config files
+
+    - 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
+
+* Load in accounting log data
 
-    - Create the file /etc/ubmod.conf with your site specific settings. An
-      example can be found in the docs directory of the UBMoD distribution
+    For PBS/TORQUE:
 
-    db.host=localhost
-    db.port=3306
-    db.name=ubmod
-    db.user=ubmoduser
-    db.password=password
+    $ ubmod-shredder -v -s --format pbs -H your.host.org -d /var/spool/pbs/server_priv/accounting
 
-* Load in accounting log data from TORQUE
+    For SGE:
 
-    $ java -jar ubmod-shredder-exe.jar -v -s -H your.host.org -d /var/spool/pbs/server_priv/accounting
+   $ ubmod-shredder -v -s -H your.host.org -f sge -i /var/lib/gridengine/default/common/accounting
 
 * Aggregate accounting log data
 
-    $ java -jar ubmod-shredder-exe.jar -v -u 
+    $ ubmod-shredder -v -u
 
 * Set up the web application
 
-    - UBMoD is packaged as a WAR file which can be used with any servlet container.
-      This example uses tomcat. * Note this is a basic example of setting up tomcat
-      for use with UBMoD for demo purposes only and not intended for production
-      use.
-
-    $ cd /usr/local
-    $ tar -xvzf apache-tomcat-x.x.x.tar.gz
-    $ ln -s apache-tomcat-x.x.x tomcat
-    $ cd tomcat
-    $ rm -Rf ./webapps/*
-    $ cp /path/to/ubmod/ubmod-portal.war ./webapps/ROOT.war 
-    $ ./bin/startup.sh
+    - The UBMoD portal is packaged as a PHP application.
+      * Note that this is a basic example of setting up Apache for use with
+      UBMoD for demo purposes only and not intended for production use.
+
+* 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
+            RewriteCond $1 !^index\.php/
+            RewriteRule ^api/rest/(.*)$ /api/rest/index.php/$1 [L]
+            RewriteCond $1 !^api/rest/
+            RewriteCond $1 !^(favicon\.ico|robots\.txt)$
+            RewriteCond $1 !^(css|images|js|resources)/
+            RewriteCond $1 !^index\.php/
+            RewriteRule ^(.*)$ /index.php/$1 [L]
+        </Directory>
+    </VirtualHost>
+
+* Reload the Apache configuration
 
 * Point your browser to http://localhost:8080/