Installation_guide

• Installation guide
• How to install the product?
• Using the demo package
  • With Windows
    • With Linux
• Start the client
• Application settings
  • Documents server
  • Default country
• Advanced configuration
• Advanced installation guide

Installation guide

The product use a Java web server and a database to run. You need to install these software in order to execute the system. The installation needs some specific operations in order to customize to your system. Although it's quite simple, this operation needs an experimented technician to ensure it success. The easiest way is to start the demo package.

How to install the product?

If you want to evaluate the product, it's easier to install the pack (see the next paragraph below). You may need to install:

• Java SE SDK 6 or Java JRE 6
• Tomcat 5.5
• H2 database or any database with a JDBC 3 connector
• 150 Mo of free RAM minimum

Using the demo package

Just download the pack and unzip it. Replace in the instruction <VolunteerBase_Install_directory> by the directory you have choosen. You must install at least the Java JRE 6 (see www.java.com). Notice the installation path while your are installing the JRE, you will need it later.

With Windows

With the right click button of the mouse, select Properties on MyComputer-> select Advanced-> Environment variables, add a new System variable JRE_HOME and put the full path to your JRE installation in the value.

• To start,double click on <VolunteerBase_Install_directory>\apache-tomcat-5.5.23\bin\VBstartup.bat
• To stop, double click on <VolunteerBase_Install_directory>\apache-tomcat-5.5.23\bin\VBshutdown.bat

With Linux

Setup the JRE_HOME.
To start:

cd <VolunteerBase_Install_directory>\apache-tomcat-5.5.23\bin
java -cp h2.jar org.h2.tools.Server -tcp
./startup.sh

To stop:

cd <VolunteerBase_Install_directory>\apache-tomcat-5.5.23\bin
./shutdown.sh
java -cp h2.jar org.h2.tools.Server -tcpShutdown tcp://localhost:9092

Start the client

Put the address http://localhost:8080/VolunteerWeb on the address bar of your browser to obtain the home page.

Application settings

The application can be customized to adapt the system to your requirement.

Documents server

Before using the documents, you must set 2 parameters to ensure a proper behaviour. The first one is the directory where the server will store all the documents (upload directory) and must be set to a proper directory with all the rights. Don't forget to backup this directory.

The second is needed when you use a network sharing of the documents. If you have an access to the server trough a network drive, you must set the path to the documents from a client workstation. The basic idea is to store all the documents on a shared server's folder so you don't have to duplicate theses files. For example, your organisation has already a folder on the server named /shared/documents (or C:\shared\documents for Windows). This folder is shared and can be accessed from windows workstations as Z:\documents. All the existing documents are already on the server so it's not necessary to upload these documents. You must configure the application to give these paths. The management of document will use these rules : - if the document is stored in Z:\documents, it's not necessary to copy the file - if the document is stored in other directory, ie C:\toto, a copy of the document is uploaded in Z:\documents Note: if you are using Firefox, the server receive only the name of the document and can't be able to know were the document is stored. It is advised to use M$ Internet Explorer if you want to activate this option.

To setup the path of the parameters, you must open the war file and edit the web.xml file in the WEB-INF folder. You will find these lines at the beginning :

    <context-param>
        <description>Upload directory for documents (be careful with
windows to put the drive upper case</description>
        <param-name>org.spw.UPLOAD_DIR</param-name>
        <param-value>C:/temp/upload</param-value>
    </context-param>
    <context-param>
        <description>Shared directory name on client workstartion
correponding to the upload directory of the
server. Remove this parameter if you don't
use a shared directory.</description>
        <param-name>org.spw.SHARED_DOC_DIR</param-name>
        <param-value>C:/temp/upload</param-value>
    </context-param>

Change the param-value with your personal settings and replace with the modified file. Be carreful, the path is case sensitive including the drive letter for Windows.

Default country

In the distribution, open the war file and change the web.xml file. Locate the line :

<context-param><description>Default country code for new contact</description><param-name>org.spw.COUNTRY</param-name><param-value>AU</param-value>

Change the param-value AU to the code of your country, for example PL (Poland) etc...

Advanced configuration

The page [Users_administration] contain information about the user management, including email configuration.

Advanced installation guide

If you want to use the system with a server and/or a different database, you should go to the [Advanced_installation_guide] to obtain more details.