|========================================================================|
| ELEDIA - ELEctromagnetic DIAgnostic LABoratory - eledia@ing.unitn.it   |
|          Via Sommarive, 14 - 38050 Povo di Trento - Italy              |
|  @ DIT - Department of Information and Communication Technology        |
|          Engineering University of Trento                              |
|========================================================================|
|
| ELEDIA Project Manager: Installation Guidelines
|                                                         2007-01-25 18.33
|_________________________________________________________________________



Requirements
============

 Following items are required to run ELEDIA Project Manager on a server.

   - Apache 1.3 or greater [suggested: 2.x]

   - PHP 5.0.4* or greater [suggested: 5.2.x or greater]
      * required also php-xml, php-dom.

   - PHP PEAR: Archive_Tar (1.3.x), Net_SMTP (1.2.x)

 Optional:
 
    - Apache FOP [suggested: 0.20.5] - Required for PDF outputs
      [http://xmlgraphics.apache.org/fop/]




Installation
============

 ELEDIA Project Manager installation is very easy, here are all steps:
 
 
   - UNZIP the software in your Apache Document Root, you will have 3 folders
     and 2 shell scripts:

       /eproject [the root]
       /_bs_Images [few required images]
       /_bs_JavaScript [many required java scripts]
       /eledia.cron.daily
       /eledia.cron.monthly


   - EDIT following files

       /eledia.cron.daily
       /eledia.cron.monthly
	
	Change WWW_ROOT to the path of ELEDIA Project Manager (ex. /var/www/eproject)
	 						      (DO NOT PUT final slash)
	   and WWW_USER for your system, you may find it in your Apache configuration file,
	   usually is apache:apache for Fedora and www-data:www-data for Debian.

     Then update also 

       /eproject/includes/common_functions.php

	Change $rootpath to the path of ELEDIA Project Manager (ex. /var/www/eproject/)
	 						       (PUT final slash)


       /eproject/includes/reports.php

	Change $fop_cmd to the full path of Apache FOP launcher (ex. /usr/share/fop/fop.sh)


  - EXECUTE and COPY shell scripts*:
     
       /eledia.cron.daily	=>	/etc/cron.daily/eledia.cron.daily
       /eledia.cron.monthly	=>	/etc/cron.monthly/eledia.cron.monthly

     * these scripts will reset file permissions/cache and will backup database.


  - INSTALL Apache FOP

       Download and Install current version of Apache FOP (http://xmlgraphics.apache.org/fop/),
       you need the Java Runtime Environment installed (JAVA_HOME must be set on boot or you may
       edit the shell script fop.sh and type it manually.)




Maintenance
===========

 - You do not need to do anything after installation, cron script will reset file permissions
   (to increase security and avoid I/O errors) and clear reports (/reports folder) daily.
   Each month the full database (projects, users, courses..) will be zipped and saved into
   /backups folder ( filename: {archive_name}.{date_time}.tar.gz ), but you may also backup 
   (and recover) them manually from the Administration Interface.
   NOTE: Archived projects may have an attachment, these files are stored in /projects/attachments
         engine won't backup these files, but you may uncomment the relative line in the cron script.

 - Periodically you may verify system consistency through the System Validation section of
   the Administration, it will check up full database and each project for errors.
   
 - While upgrading Engine or editing (files), website must be disabled (they may interact with
   your changes). You may stop the web server or disable the VirtualHost, but you can also
   edit /includes/auth_functions.php and set '$site_disabled = true;' at line 4.
   You may need to access the website to verify changes, this is possible setting the GET variable
   'debugmode=true' while logging in (ex: index.php?debugmode=true).



Credits
=======

 ELEDIA Project Manager has been developed by Alessandro Polo <alessandro.polo@ewgate.net>
 for ELEDIA Group on 2006-12.