Vous êtes ici : Installer et exploiterInstallationServeur applicatifApplication

Procédure d'installation de l'application K-Portal ou K-Sup

Cette page décrit les étapes d'installation de K-Portal ou K-Sup sur le serveur applicatif.

Note : La procédure ci-dessous s'appuie sur notre package logiciel par défaut (non personnalisé), mais vous pouvez suivre les mêmes étapes si vous disposez de votre propre package .war comprenant le logiciel et sa partie personnalisée (templates front-office, extensions, etc.) spécifique à votre application.

Création des dossiers

Le dossier d'installation de l'application contiendra deux sous dossiers :
  • WEBAPP_HOME : ce dossier, dit "webapp", contient l'application
  • WEBAPP_STORAGE : ce dossier, dit "storage", contient 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_HOME
mkdir WEBAPP/webapp
# Dossier WEBAPP_STORAGE
mkdir -p WEBAPP/storage/{conf,imports,logs,medias,save,sessions,forms}
Où : WEBAPP est le chemin absolu vers le dossier d'installation de K-Sup/K-Portal.

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 WEBAPP_HOME
chown -R tomcat:tomcat WEBAPP_STORAGE
 

Déploiement du package

Téléchargez l'archive au format .war depuis cette page. 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 WEBAPP_HOME
chown -R tomcat:tomcat WEBAPP_HOME

Paramétrage

Paramétrage minimal

il est nécessaire de créer le fichier suivant :
WEBAPP_STORAGE/conf/env.properties
Le fichier doit être composé à minima des informations suivantes :
storage.dir=%WEBAPP_STORAGE%
## Pour la médiathèque
mediatheque.path=${storage.dir}/medias
## Pour les fichiers de session
connecteurs.session_path=${storage.dir}/sessions
## Pour les divers fichiers de logs
logs.path=${storage.dir}/logs
## Chemin du répertoire de sauvegarde de K-Portal
sauvegarde.path=${storage.dir}/save
## Chemin du répertoire d'import des fichiers xml
import.batch.source=${storage.dir}/imports
## Chemin du répertoire de stockage des fichiers joints des formulaires
forms.defaultdir=${storage.dir}/forms
 
# 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=%BD_LOGIN%
datastore.default.password=%BD_PASSWORD%
datastore.default.url=jdbc:mysql://%BD_HOST%/%BD%

Où :
  • %WEBAPP_STORAGE% : le chemin absolu vers le dossier "storage" de l'application (voir ici)
  • %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_LOGIN% : login de l'utilisateur se connectant à la base de données
  • %BD_PASSWORD% : mot de passe de l'utilisateur se connectant à la base de données
  • %BD_HOST% : nom de domaine ou IP de la machine hébergeant le serveur de base de données
  • %BD% : nom de la base de données mise à disposition pour l'application K-Sup ou K-Portal
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

En mode "embedded", aucun paramétrage supplémentaire n'est nécessaire.
En mode "standalone", il faut ajouter les paramètres suivants dans le fichier WEBAPP_STORAGE/conf/env.properties:

# moteur de recherche elastic
search.mode = external
search.nodes = %SEARCH_SERVER%:%SEARCH_PORT%
Où :
  • %SEARCH_SERVER% : Adresse IP (ou hostname) du serveur elasticsearch.
  • %SEARCH_PORT% : Port du serveur  elasticsearch. Utiliser la valeur 9300.
 

Démarrage

Une fois l'application configurée il est nécessaire de redémarrer le serveur d'application Tomcat pour l'activer et l'initialiser (cf Installation de Tomcat).
L'application est ensuite accessible à l'adresse définie dans votre configuration. Pour vous connecter au module d'administration, appelez l'adresse /adminsite/ et renseignez les identifiants admin/admin.
  Mis à jour le 28 septembre 2018