Installation du package Esup

Ce paragraphe décrit de manière rapide le processus d'installation et de paramétrage ; les paragraphes suivants détaillent les différents paramètres ou options. Les répertoires d'installation sont paramétrables dans le fichier build.properties. Ces paramètres sont indiqués entre accolades.L'installation complète peut (et devrait) se faire depuis un compte utilisateur non root. Il est bien sûr nécessaire que ce compte ait un droit d'écriture dans les différents répertoires utilisés.

Deux modes d'installation sont possibles :

Développement : pour faire une installation rapide, des tests, découvrir le produit. Ce mode permet d'installer également des applications tierces nécessaires au fonctionnement du portail : Tomcat, Ant, et un moteur de base HSQL. L'installation rapide minimale est décrite en bas de chapitre.

Production. Ce mode installe uPortal et l'adaptation Esup. Les applications tierces sont considérées déjà installées et configurées (voir prérequis).

Prérequis

Système d'exploitation

Unix, Linux. L'installation en mode de développement peut être faite sur un système Windows.

Base de données

Fonctionne avec un SGBD acceptant du SQL standard et les transactions, et proposant un drivers JDBC natif.
Testé avec MySQL (version 4 ou supérieure), PostgreSQL, Oracle. Les pilotes pour MySQL et PostgreSQL sont fournis dans le package.
Si vous utilisez un autre système, placez le pilote dans le répertoire ${esup.custom}/uPortal/lib/container-common avant l'initialisation du portail (voir plus bas)

Environnement JAVA

Un JDK 1.5 doit être préalablement installé sur le (ou les) serveur supportant le portail.

La variable JAVA_HOME doit être valuée, et le chemin $JAVA_HOME/bin rajouté au PATH

ANT

Le logiciel ANT doit être installé, avec une version égale ou supérieure à 1.6.5.

La variable ANT_HOME doit être valuée, et le chemin $ANT_HOME/bin rajouté au PATH

Authentification

En environnement de production, un serveur CAS doit être opérationnel au sein de l'établissement.

Annuaire LDAP

L'établissement doit disposer d'un annuaire LDAP exhaustif et compatible Supann.

Tomcat

Dans le cadre d'une installation de production (non esupdev) Tomcat n'est pas distribué par esup et doit donc être installé manuellement.

Première installation

Décompression de l'archive

tar -xvzf esup-2.6-esup-2.X.Y

Un répertoire esup-2.6-esup-2.X.Y est créé. On appellera ce répertoire la 'racine' du package. Il correspond au paramètre ${esup.root} du fichier build.properties.

Personnalisation du déploiement du portail

Vous pouvez adapter le fichier build.properties pour personnaliser l'emplacement du kit de développement Java, le mode d'installation (développement ou production), les différents répertoires d'installation, l'emplacement du fichier de configuration du portail.

Il faut au minimum préciser l'emplacement du kit de développement Java (${java_home}).

Le paramètre ${devel_mode} permet d'indiquer si l'on veut faire une installation en mode de développement (ESUPDEV) ou de production (ESUP). Ceci a un impact sur les packages déployés et les tâches Ant disponibles.

Récupération des archives des applications tierces

ant getcomponents

Télécharge les archives des applications uPortal (ESUP et ESUPDEV), Tomcat, Ant, HSQL (ESUPDEV uniquement) dans le répertoire ${esup.packages}.

Décompression des archives des applications tierces

ant unzip

Les archives sont décompactées sous le répertoire ${esup.base}.

Configuration du portail

Vous devez adapter le fichier config.properties. C'est le principal travail à effectuer.

Initialisation du portail

ant init

Cette tâche :

Copie les scripts du répertoire ${esup.resources} /scripts vers la racine,
copie les pilotes de base de données de ${esup.resources}/drivers vers ${esup.sources}/lib/container-common,
copie les fichiers de personnalisation Esup dans ${esup.update}/uPortal vers le répertoire de distribution uPortal (${esup.sources}),
copie vos fichiers de personnalisation dans ${esup.custom}/uPortal vers le répertoire de distribution uPortal (${esup.sources}),
adapte les fichiers de configuration d'uPortal en fonction des paramètres de config.properties,
adapte les fichiers de configuration de Tomcat en fonction des paramètres de config.properties (ESUPDEV uniquement)

Déploiement du portail

ant deploy

Compile et copie les fichiers nécessaires vers l'environnement d'exécution du portail (${esup.deploy})

Test de la connection à la base de données du portail

ant db.test

Permet de valider les informations de connection à la base de données du portail, indiquées dans le fichier config.properties (paramètres ${esup.db.xxx}) : url d'accès à la base, nom et mot de passe de l'utilisateur, classe java utilisée.

S'il s'agit d'une installation sur une nouvelle base de données, la base doit préalablement être créée et l'utilisateur indiqué dans le fichier config.properties doit avoir des droits suffisants sur les objets.

Cette tâche affiche diverses informations sur la base de données. Si elle s'exécute avec succès (affichage de "BUILD SUCCESSFUL"), vous pouvez passer à la suite. Sinon, vérifiez et corrigez les paramètres de la base.

Si le sgbd est MySQL ou PostgreSQL , noter le "Database version" (dans les première lignes du rapport), et mettez cette valeur complète dans la propriété ${esup.db.db-version} du fichier config.properties.

Initialisation de la base de données du portail

ant db.init

Cette tâche :

Supprime les tables du portail indiquées dans le fichier ${esup.sources}/properties/db/esup-tables.xml
Insère les données indiquées dans le fichier ${esup.sources}/properties/db/esup-data.xml
Créé dans la base les groupes définis dans le fichier ${esup.sources}/properties/groups/esupGroupLoad.xml
Publie tous les canaux définis dans le répertoire ${esup.sources}/properties/chanpub (correspond à la tâche ant chan.pub -Dchan.pub=all)
Publie tous les layouts définis dans le répertoire ${esup.sources}/properties/layout (correspond à la tâche ant layout.import -Dusername=all)

Démarrage du portail

A partir de la racine du package :

./start-esup.sh

Vérifier dans le fichier journal de Tomcat que le moteur et les différents contextes sont bien démarrés.

Vérifier dans le fichier journal du portail que uPortal est bien démarré.

Le portail est accessible via l'url suivante : http://Nom_d'hote:Port/uPortal

Modifications et redéploiements

Si vous modifiez le fichier config.properties ou vos personnalisations dans ${esup.custom}/uPortal, relancez les tâches ant init et ant deploy puis redémarrez le portail pour les prendre en compte

Si vous modifiez des canaux ou des layouts, vous pouvez:

Soit refaire un déploiement complet (ant init; ant db.init; ant deploy). Attention, ceci réinitialise la base donc à faire uniquement sur une base de tests.
Soit refaire les publications : ant init puis ant chan.pub -Dchan.pub=all ou ant layout.import -Dusername=all

Installation rapide en mode de développement

Décompresser l'archive
Vérifier que un JDK 1.5 minimum est installé et dans le chemin
Modifier le paramètre java_home de build.properties
ant getcomponents
ant unzip
ant init
ant hsql.start (démarre la base HSQL embarquée avec la distribution)
ant db.init
ant deploy
./start_esup.sh ou start_esup.cmd selon le système d'exploitation

Installation de production et Tomcat

Dans le cadre d'une installation de production (donc en mode esup et non pas esupdev) le tomcat n'est pas gérer par le package hors il faut modifier la configuration de tomcat pour ajouter le contexte du portail mais aussi 2 pool de connexions a la base.

Pour ce faire :

Modifier le fichier [tomcat]/conf/server.xml
Ajouter le contexte uportal vous pouvez vous baser sur le fichier exemple dans update/uPortal/properties/uPortal55.xml
remplacer les tags @[TAG]@ par les valeur correspondante a vos configurations

A partir des version esup[xx]-2.0.3 vous diposez d'une target _tomcat.genconf qui vous affiche le contenu correct du contexte a mettre dans votre configuration Tomcat