Historique de la page
Sommaire |
---|
Remarque | ||
---|---|---|
| ||
L'exploitant doit avoir choisi son mode de déploiement (cf Déploiements portlet, servlet, quick-start) et remplir les prérequis d'installation (cf Prérequis). |
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
Deployment modes
Three deployment modes are available.
Portlet deployment
This deployment is proposed for portal administrators, it deploys esup-helpdesk as a JSR-168 portlet, in order to execute it within a JSR-168 compliant portal (uPortal, Liferay, infoglue, ...).
If you are no portal administrator or you do not know what a portlet is, select a servlet or quick-start deployment.
Servlet deployment
This deployment is proposed for deployers who want to run the application into an existing servlet container (such as Tomcat).
If you do not know what a servlet is or if you do not have a J2EE runtime available, select a quick-start deployment.
Quick-start deployment
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.
Requirements
Installing esup-helpdesk needs a few requirements.
- esup-helpdesk is provided as a zip file that contains all the sources. The sources must be compiled, which needs a Java Development Kit (a Java Runtime Environment is not enough).
- Installation commands and asynchroneous tasks are run using ant.
- esup-helpdesk is configured by default to connect to a MySql database; Hibernate allows the usage of any other database manager (see Configuring the database connection).
Unix requirements
Java
Any Unix administrator knows how to install a JDK, embedded in most distributions. If not, download from http://java.sun.com/javase/downloads/index.jsp.
Ant
If ant is not available as a package (RPM or any), it can be downloaded from http://ant.apache.org/bindownload.cgi and installed for instance in /usr/local/.
Java/ant environment variables
In order to simplify administration commands and asynchroneous tasks (see 03 Administration), deployers may create in the folder /etc/profile.d the following java.sh script (adapt to your own configuration) :
Bloc de code |
---|
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
todo | ||||
---|---|---|---|---|
|
Download
The last release can be downloaded at http://helpdesk.esup-portail.org/current (previous releases are at http://helpdesk.esup-portail.org).
Uncompressing the sources
Uncompress the zip file you have downloaded to your filesystem, for instance in 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 *. Uncompressing esup-helpdesk\[-quick-start\]-x-3.y.z-t.zip* crée le répertoire */ creates the folder usr/local/helpdesk/src/esup-helpdesk\[-quick-start\]-x.y.z*. Balise Wiki
Astuce |
---|
Il faudra toujours installer les versions successives de esup-helpdesk au même endroit pour bénéficier des facilités de mise à jour. |
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 :
Bloc de code |
---|
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 :
Successive versions must be installed at the same location on the filesystem in order to ease upgrades. |
Deployment properties (build.properties)
At first, edit the configuration file /build.properties to set the properties that tell how the application should be installed.
Once these properties set (see below for details), the behaviour of the application at runtime must be configured (see 01 Configuration).
Astuce |
---|
When changing the deployment mode, it is recommended to clean everything (ant clean) before deploying again. |
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:
Bloc de code |
---|
Bloc de code |
custom.recover.files= properties/domain/xmlDepartmentSelection.xml
|
...
Quick-start deployments
quick-start
Il suffit d'indiquer qu'il s'agit d'un déploiement quick-start, de cette manière Just tell the it is a quick-start deployment this way:
Bloc de code |
---|
quick-start=true
|
Autres propriétés facultatives
All the other properties are optional.
Optional properties
Properties 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éfautport and tomcat.shutdown-port can be used in order to configure the embedded Tomcat (default values below):
Bloc de code |
---|
#tomcat.port=8080
#tomcat.shutdown-port=8009
#tomcat.host=localhost
|
Astuce |
---|
En déploiement When using a quick-start deployment, l'application sera déployée comme une servlet dans un répertoire /deploy créé par la procédure de déploiement. De plus une instance de Tomcat sera installée et configurée pour pointer sur le contexte de l'application. |
Déploiement en portlet
deploy.type
Il faut indiquer quil s'agit d'un déploiement en portlet :
the application is deployed into the folder /deploy; a Tomcat instance is installed automatically and configured to point to the application context. |
Portlet deployments
deploy.type
Tell that it is a portlet deployment:
Bloc de code |
---|
Bloc de code |
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 Tell where the application will be deployed to be executed by the portal, typically in a webapps folder of an existing portal:
Bloc de code |
---|
deploy.home=/usr/local/tomcatuPortal/webapps/esup-helpdesk |
Ce chemin devra être utilisé pour la configuration du contexte de la servlet. On trouvera typiquement dans le fichier This path should be used by the portal administrator to configure the portlet context. Typically (tomcat/conf/server.xml de Tomcat quelque chose comme ):
Bloc de code |
---|
<Service<Host name="Catalinalocalhost"> <Connector portappBase="8080" maxHttpHeaderSize="8192" maxThreads="150" minSpareThreads="25" maxSpareThreads="75" enableLookups="false" redirectPort="8443" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true" />webapps" unpackWARs="true" <Engine nameautoDeploy="Catalinatrue" defaultHostxmlValidation="helpdesk.domain.edufalse"> <Host name="helpdesk.domain.edu" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> <Context path="" /esup-helpdesk" docBase="/usr/local/tomcatuPortal/webapps/esup-helpdesk" crossContext="true" reloadable="falsetrue"> <Manager className="org.apache.catalina.session.StandardManager" pathname="" /> </Context> </Host> </Engine> </Service> |
...
Servlet deployments
deploy.type
Il faut indiquer qu'il s'agit d'un déploiement en servlet Tell that it is a servlet deployment:
Bloc de code |
---|
deploy.type=portletservlet |
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 Tell where the application will de deployed to be executed by the servlet container, typically in the webapps folder of an existing Tomcat:
Bloc de code |
---|
deploy.home=/usr/local/portaltomcat/webapps/esup-helpdesk |
Ce chemin devra être utilisé pour la configuration du contexte de la servlet. On trouvera typiquement dans le fichier This path should be used to configure the servlet context. Typically (tomcat/conf/server.xml de Tomcat quelque chose comme ):
Bloc de code |
---|
<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="localhost" helpdesk.domain.edu" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> <Context path="/esup-helpdesk" docBase="/usr/local/portaltomcat/webapps/esup-helpdesk" crossContext="true" reloadable="truefalse"> <Manager pathname="" className="org.apache.catalina.session.StandardManager" /> </Context> </Host> |
...
</Engine>
</Service>
|