Télechargement

La dernière version du projet esup-helpdesk est téléchargeable à l'URL http://helpdesk.esup-portail.org/current (les version précédentes sont téléchargeables depuis http://helpdesk.esup-portail.org).

Selon le déploiement souhaité, il faudra télécharger esup-helpdesk-x.y.z-t.zip (déploiement portlet ou servlet) ou bien esup-helpdesk-quick-start-x.y.z-t.zip (déploiement quick-start).

Voir : Déploiements portlet, servlet, quick-start 

Décompression des sources 

Décompressez l'archive téléchargée sur votre système de fichiers, par exemple dans */usr/local/helpdesk/src*. La décompression de *esup-helpdesk\[-quick-start\]-x.y.z-t.zip* crée le répertoire */usr/local/helpdesk/src/esup-helpdesk\[-quick-start\]-x.y.z*.

Edition du fichier build.properties

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

Propriétés communes à tous les déploiements

Quelque soit le déploiement, les propriétés cas.url et custom.recover.files devront être renseignées.

cas.url

La propriété cas.url indique l'URL principale du serveur CAS, par exemple :

cas.url=https://sso-cas.univ-rennes1.fr

custom.recover.files 

La propriété custom.recover.files n'est utilisée que pour la récupération automatique des personnalisations lors des mises à jour, par exemple :

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

Déploiement quick-start

quick-start

Il suffit d'indiquer qu'il s'agit d'un déploiement quick-start, de cette manière :

quick-start=true

Autres propriétés facultatives

Les propriétés tomcat.host, tomcat.port,  

On pourra également indiquer de manière optionnelle des propriétés servant à configurer le Tomcat embarqué (ci-dessous les valkeurs par défaut) :

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

Déploiement en portlet

deploy.type

Il faut indiquer quil s'agit d'un déploiement en portlet :

deploy.type=portlet

deploy.home

Il faut ensuite indiquer l'endroit où l'application sera déployée pour être exécutée par le portail, typiquement dans un sous-répertoire du répertoire webapps d'un uPortal existant :

deploy.home=/usr/local/tomcat/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 :

<Service name="Catalina">
    <Connector port="8080" maxHttpHeaderSize="8192" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="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 className="org.apache.catalina.session.StandardManager" pathname="" />
            </Context>
        </Host>
    </Engine>
</Service>

Déploiement en portlet

deploy.type

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

deploy.type=portlet

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>

Les propriétés du fichier build.properties indiquent la manière dont l'application est déployée ; une fois celles-ci positionnées, il faut configurer l'application elle-même : les propriétés du fichier /properties/config.properties indiquent comment l'application se comporte à l'exécution (cf Configuration).