...

This deployment allows esup-helpdesk to run as a stand-alone application (a Tomcat instance is embedded).

It can be used in order to test the application, but some deployers (especially those who d not have J2EE competences) run in production this way; quick-starts are full-featured applications.

...

export JAVA_HOME=/usr/java/jdk1.6.0_05
export ANT_HOME=/usr/local/apache-ant-1.7.0
export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin

Windows requirements

Download

The last release can be downloaded at http://helpdesk.esup-portail.org/current (previous releases are at http://helpdesk.esup-portail.org).

The zip file to download depends on the deployment mode selected:

• quick-start: esup-helpdesk-quick-start-x.y.z-t.zip
• portlet or servlet: esup-helpdesk-x.y.z-t.zip
  

Uncompressing the sources

Uncompress the zip file you have downloaded to your filesystem, for instance in */usr/local/helpdesk/src*. Uncompressing *esup-helpdesk\[-quick-start\]-x.y.z-t.zip* creates the folder *usr/local/helpdesk/src/esup-helpdesk\[-quick-start\]-x.y.z*.

Le fichier build.properties indique à esup-helpdesk comment l'application sera déployée. 

Une fois ces propriétés correctement remplis, il faudra configurer l'application (cf 01 Configuration).

Deployment properties (build.properties)

Edit the configuration file /build.properties to set the properties that tell how the application should be installed

Common properties (any deployment)

Whatever the deployment mode selected, property custom.recover.files must be set.

custom.recover.files

Property custom.recover.files is used when upgrading the application to recover the deployer's customizations, for instance:

custom.recover.files= properties/domain/xmlDepartmentSelection.xml

Quick-start deployments

quick-start

Just tell the it is a quick-start deployment this way:

quick-start=true

All the other properties are optional.

Optional properties

Properties tomcat.host, tomcat.port and tomcat.shutdown-port can be used in order to configure the embedded Tomcat (default values below):

#tomcat.port=8080
#tomcat.shutdown-port=8009
#tomcat.host=localhost

Portlet deployments

deploy.type

Tell that it is a portlet deployment:

deploy.type=portlet

deploy.home

Tell where the application will be deployed to be executed by the portal, typically in a webapps folder of an existing portal:

deploy.home=/usr/local/uPortal/webapps/esup-helpdesk

This path should be used by the portal administrator to configure the portlet context. Typically (tomcat/conf/server.xml):

<Host name="localhost"
    appBase="webapps" unpackWARs="true"
    autoDeploy="true" xmlValidation="false"
    xmlNamespaceAware="false">
    <Context path="/esup-helpdesk"
	docBase="/usr/local/uPortal/webapps/esup-helpdesk"
	crossContext="true" reloadable="true">
      <Manager pathname="" />
    </Context>
</Host>

On trouvera typiquement dans le fichier conf/server.xml de Tomcat quelque chose comme :

<Service name="Catalina">
    <Connector 	port="8080"
	maxHttpHeaderSize="8192" maxThreads="150"
	minSpareThreads="25" maxSpareThreads="75"
	enableLookups="false" redirectPort="8443"
	acceptCount="100" connectionTimeout="20000"
	disableUploadTimeout="true" emptySessionPath="true" />
    <Engine name="Catalina" defaultHost="helpdesk.domain.edu">
        <Host name="helpdesk.domain.edu"
    	    appBase="webapps" unpackWARs="true"
	    autoDeploy="true" xmlValidation="false"
	    xmlNamespaceAware="false">
	    <Context
		path="" docBase="/usr/local/tomcat/webapps/esup-helpdesk"
		crossContext="true" reloadable="false">
                <Manager pathname=""
		    className="org.apache.catalina.session.StandardManager" />
            </Context>
        </Host>
    </Engine>
</Service>

Déploiement en servlet

deploy.type

Il faut indiquer qu'il s'agit d'un déploiement en servlet :

deploy.type=servlet

deploy.home

Il faut ensuite indiquer l'endroit où l'application sera déployée pour être exécutée par le conteneur de servlets, typiquement dans un sous-répertoire du répertoire webapps d'un Tomcat existant, mais pas nécessairement :

deploy.home=/usr/local/portal/webapps/esup-helpdesk

Ce chemin devra être utilisé pour la configuration du contexte de la servlet. On trouvera typiquement dans le fichier conf/server.xml de Tomcat quelque chose comme :

<Host name="localhost"
    appBase="webapps" unpackWARs="true"
    autoDeploy="true" xmlValidation="false"
    xmlNamespaceAware="false">
    <Context path="/esup-helpdesk"
	docBase="/usr/local/portal/webapps/esup-helpdesk"
	crossContext="true" reloadable="true">
      <Manager pathname="" />
    </Context>
</Host>

• 02 Download 
• 03 Uncompressing the sources
• 04 Propriétés de déploiement (build.properties)

...