Première installation du package Esup

Ce paragraphe décrit 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.

Modes d'installation

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 ici : 02 - Installation rapide du paquet de développement.
  
• 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).

Selon le mode d'installation choisi, vous téléchargerez une archive portant le nom esup-uPortal-3.2.x-esupdev-x.y.z (développement) ou esup-uPortal-3.2.x-esup-x.y.z (production)

Les fonctionnalités de ces deux archives sont les mêmes. La version "développement" est une sorte de quick start, préconfigurée avec une installation automatique des application tierces.

Récupération de la distribution :

Les distributions du projet peuvent être téléchargées ici : https://sourcesup.cru.fr/frs/?group_id=173&release_id=1843

Décompression de l'archive

tar -xvzf esup-uPortal-3.2.4-esup-x.y.z

Un répertoire esup-uPortal-3.2.x-esup-x.y.z est créé. On appellera ce répertoire la 'racine' du package. Il correspond au paramètre ${esup.root} du fichier build.properties.

Contenu du répertoire :

TODO : Arborescence

Personnalisation du déploiement du portail

Copiez le fichier build.sample.properties dans build.properties.

Copiez le fichier config.sample.properties dans config.sample.properties

Adaptez le fichier build.properties à votre environnement :

Voir le détail des options : 01 - build.properties (esup-3)\

• java_home : Emplacement du kit de développement Java

Si vous n'utilisez pas le mode de développement, vous devez préciser l'emplacement su serveur d'application Tomcat :

• server_home

Si vous n'utilisez pas le mode de développement ou que vous avez déjà un client Maven sur votre machine, précisez :

• mvn_home : Emplacement du client Maven
• mvn_settings : fichier de configuration du client Maven
• mvn_repo : Emplacement du dépôt Maven local (localrepository dans le fichier de configuration)

Vous pouvez également personnaliser les différents répertoires d'installation, l'emplacement du fichier de configuration du portail. La suite de cette documentation de l'installation fera référence aux valeurs par défaut de ces paramètres.

Récupération des archives des applications tierces

Lancez la commande :

ant getcomponents

Cette opération 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

Lancez la commande :

ant unzip

Les archives sont décompactées sous le répertoire Portail.

Configuration du portail

Adaptez le fichier config.properties à votre environnement.

Voir le détail des options : 02 - config.properties (esup-3)

Initialisation du portail

Lancez la commande :

ant init

Cette tâche :

• Copie les scripts du répertoire resources/scripts vers la racine,
• copie les fichiers de personnalisation Esup de update/uPortal/* vers le répertoire des sources uPortal Portail/uPortal-rel-3.2.4,
• copie vos fichiers de personnalisation (voir parties modifications et personnalisations) de custom/uPortal/* vers le répertoire des sources uPortal Portail/uPortal-rel-3.2.4,
• adapte les fichiers de configuration d'uPortal en fonction des paramètres de config.properties,
• copie les fichiers de personnalisation Esup pour Tomcat de update/Tomcat/* vers le répertoire de Tomcat  Portail/apache-tomcat-6.0.29 (tomcat.update=true uniquement)
• adapte les fichiers de configuration de Tomcat en fonction des paramètres de config.properties (tomcat.update=true 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|../display/ESUPMU/02+-+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