Installation de l'application K-Sup

Usage

L'application K-Sup est le coeur de l'application. C'est elle qui contient le projet qui sera déployée.

Pré-requis

• OS : Debian 12
• Java : Open JDK 17
• Installation du serveur Tomcat (cf Serveur Applicatif)
• Installation du serveur Apache (cf Serveur Applicatif)
• Installation du serveur de données (cf Serveur MariaDB)
• Installation du serveur Opensearch (cf Serveur d'indexation)

Installation de l'application

Création des dossiers

Le dossier d'installation de l'application contiendra deux sous dossiers :

• Dossier "webapp", contenant les binaires de l'application
• Dossier "storage", contenant les catégories de fichiers suivantes :
  • le paramétrage de l'application
  • les données de l'application
  • les fichiers générés par l'exécution : données de travail, logs, ...

Pour créer les dossiers, exécutez les commandes suivantes :

# Dossier webapp
mkdir /web/ksup/webapp
# Dossier storage
mkdir -p /web/ksup/storage/{conf,imports,logs,medias,save,sessions,forms}

L'utilisateur tomcat doit alors avoir les droits d'écriture sur ces deux dossiers.

#Positionnement des droits sur les répertoires WEBAPP_HOME et WEBAPP_STORAGE
chown -R tomcat:tomcat /web/ksup/webapp
chown -R tomcat:tomcat /web/ksup/storage

Point d'attention
Si votre infrastucture est composée d'un cluster de serveurs Tomcat, le répertoire "storage" doit être placé sur un disque partagé de type NFS.
En revanche, pour des soucis de performance, il est déconseillé de placer le répertoire "webapp" contenant les binaires de l'application sur un tel disque. Le répertoire "webapp" doit être dupliqué sur chaque membre du cluster.

Déploiement du package

Récupérez l'archive de votre projet au format .war. Il faut ensuite déployer cette archive sur le serveur applicatif, au sein de Tomcat.
Le package d'installation se présente sous la forme d'une archive ZIP avec une extension ".war". Cette archive contient l'ensemble des fichiers de l'application à déployer : application produit ou projet.

Voici le détail de l'arborescence du package par défaut :

• /adminsite : dossier contenant une partie des fichiers de l'interface d'administration (une autre partie est répartie par module, sous /WEB-INF/jsp)
• /extensions : dossier contenant les extensions déployées, avec un répertoire dédié pour chacune
• /images : dossier contenant les images par défaut utilisées dans l'application (favicon, logo par défaut, ...)
• /jsp : dossier contenant une partie des fichiers du template front-office générique de K-Portal / K-Sup (une autre partie est répartie par module, sous /WEB-INF/jsp)
• /META-INF : dossier technique lié au packaging d'applications Java
• /WEB-INF
  • /classes : dossier contenant les fichiers de configuration .properties et .xml par défaut
  • /conf : dossier de stockage des fichiers d'initialisation de l'application
  • /jsp : dossier contenant les fichiers des modules applicatifs
  • /lib : dossier contenant les librairies java nécessaires au fonctionnement de l'application
  • /tables : répertoire contenant les fichiers .dat (listes de libellés non modifiables)
• LICENSE (licence Apache 2.0)
• robots.txt

Déployez l'archive dans votre dossier webapp, et attribuez les droits à tomcat sur le dossier :

unzip /tmp/archive.war -d /web/ksup/webapp
chown -R tomcat:tomcat /web/ksup/webapp

Paramétrage

Paramétrage minimal

Il est nécessaire de créer le fichier suivant :

/web/ksup/storage/conf/env.properties

Le fichier doit être composé à minima des informations suivantes :

storage.dir=/web/ksup/storage
## Pour les divers fichiers de logs
logs.path=${storage.dir}/logs
 
# configuration du premier site
site.ksup.intitule=%WEBAPP_NAME%
site.ksup.host=%WEBAPP_HOST%
 
# adresse du serveur smtp
mail.host=%SMTP_HOST%
mail.port=%SMTP_PORT%
mail.from=%MAIL_FROM%
mail.webmaster=%MAIL_WEBMASTER%
 
# adresse du serveur MySQL
datastore.default.user=ksup-admin
datastore.default.password=%BD_PASSWORD%
datastore.default.url=jdbc:mysql://%IP_BDD%:%PORT_BDD%/ksup?useUnicode=true&characterEncoding=UTF-8

où

• %WEBAPP_NAME% : nom de l'application
• %WEBAPP_HOST% : nom de domaine principal de l'application
• %SMTP_HOST% : nom de domaine de la machine hébergeant le serveur SMTP
• %SMTP_PORT% : port d'écoute du service SMTP. Par défaut 25.
• %MAIL_FROM% : adresse e-mail expéditrice des mails envoyés par l'application
• %MAIL_WEBMASTER% : adresse e-mail de réception des mails d'alerte
• %BD_PASSWORD% : mot de passe de l'utilisateur se connectant à la base de données
• %IP_BDD% : nom de domaine ou IP de la machine hébergeant le serveur de base de données
• %PORT_BDD% : port du serveur de base de données (par défaut 3306)

En fonction des extensions et connecteurs installés dans votre application, le paramétrage devra être complété avec de nouveaux fichiers spécifiques à ces fonctionnalités. Par exemple les connecteurs CAS et LDAP nécessitent des fichiers de paramétrage complémentaires

Paramétrage du moteur de recherche

Il faut créer un fichier env_opensearch.properties et le mettre dans le répertoire dans le fichier /web/ksup/storage/conf/.
Ce fichier doit contenir la ligne suivante :

search.nodes = %IP_OPENSEARCH%:9200

Où

• %IP_OPENSEARCH% : Adresse IP (ou hostname) du serveur elasticsearch.

Démarrage de l'application

Pour démarrer l'application K-Sup, il faut exécuter la commander suivante :

sudo systemctl start tomcat

Configuration en mode cluster

L'application peut être configurée pour fonctionner en mode cluster.
Merci de vous référer à la documentation détaillant la configuration de ce mode : Mise en place du mode cluster.

Vérification de l'installation

Vérification de la configuration

Vérifier la présence des fichiers et du remplacement des variables en %% dans les fichiers /web/ksup/storage/conf/env.properties et /web/ksup/storage/conf/env_opensearch.properties.

Vérification du démarrage de l'application

Après avoir exécuté la commande de démarrage, il faut vérifier la log de démarrage de l'application présente dans /web/ksup/storage/logs/default-webapp.log. Il faut notamment contrôler l'absence d'erreurs.