L'installation s'effectue à partir de l'application packagée sous la forme d'un fichier .war
Si vous ne disposez pas de ce package, vous pouvez au choix :
- Télécharger le war de la dernière version de l'application depuis la page releases de github
- Générer le war à partir des sources disponibles sur github (voir ci-dessous)
Génération du war depuis le code source de l'application
Pour générer le war, il faut avoir préalablement récupéré le code source de l'application.
Récupération du code source
git clone https://github.com/EsupPortail/esup-mdw-pegase.git
Génération du war
mvn clean package -P production
Déploiement
- Dézipper le war dans le répertoire webapps de Tomcat
- Configurer l'application (cf "Configuration" ci-dessous)
- Configurer le fichier server.xml de Tomcat :
- Host avec unpackWARs=false
- Ajout du context de l'application dans le Host
- Démarrer Tomcat
- L'application est accessible depuis un navigateur via le port défini dans le server.xml de Tomcat
Configuration
Paramètres applicatifs
version < 1.5
La configuration de l'application est à renseigner le fichier WEB-INF/classes/application.properties.
Il vous faut donc créer et compléter un fichier application.properties sur le modèle de WEB-INF/classes/application-sample.properties. Toute la configuration de l'application est expliquée dans ce fichier.
version >= 1.5
A partir de la version 1.5 (release de novembre 2022) le paramétrage applicatif se fait en 2 temps :
- 1 - Avant le démarrage du Tomcat : Paramétrage du socle applicatif via le fichier application.properties
- 2 - A la première connexion sur l'application : Paramétrage final depuis l'écran "Paramètres" de l'application.
application.properties
Il vous faut donc créer et compléter un fichier WEB-INF/classes/application.properties sur le modèle de WEB-INF/classes/application-sample.properties. Toute la configuration de l'application est expliquée dans ce fichier.
Vue Paramètres
Tout utilisateur connecté en tant que superadmin (logins à renseigner dans application.properties, voir paragraphe ci-dessus) a accès à la vue "Paramètres" depuis le menu contextuel accessible dans le coin supérieur droit.
Cette vue permet de finaliser la configuration de l'application. Le paramétrage est découpé en domaine technique : LDAP, Pégase Access token, Pégase API, etc.
Pour modifier le paramétrage d'un domaine, il est nécessaire de cliquer sur le bouton "Éditer" situé en bas du bloc correspondant.
Une fois les différents champs renseignés, cliquer sur "Enregistrer" (ou "Annuler" pour revenir aux valeurs précédentes).
Ces modifications ont un effet immédiat sur l'instance applicative en cours d'utilisation par l'utilisateur connecté.
Dans le cas d'une architecture multi-instances (plusieurs Tomcat hébergeant chacun une instance de MDW) il est nécessaire, pour certains domaines techniques, de pousser la configuration sur les autres instances via le bouton "Synchroniser la configuration". Dans un délais maximum de 5 secondes toutes les instances de MDW synchroniseront leur configuration du domaine technique concerné.
Dans certains cas il peut être pratique de valider préalablement sa modification sur la session en cours avant de forcer la synchronisation globale du paramétrage.
A cette fin, la configuration de certains domaines peut être testée via un bouton dédié.
Le bouton "Tester APIs" permet, par exemple, d'appeler chacune des APIs Pégase utilisée par MDW.
Messages
La quasi totalité des libellés affichés par MonDossierWeb (à l'exception de ceux provenant directement de Pégase) sont modifiables via : /WEB-INF/classes/i18n/messages.properties.
Il suffit d'y ajouter le ou les libellés de messages-default.properties que l'on souhaite surcharger en indiquant la valeur souhaitée.
Cette configuration est à effectuer avant le démarrage du Tomcat.
Le fichier messages.properties étant packagé dans chaque release, il sera nécessaire de récupérer votre fichier messages lors de chaque nouvelle installation.