Lutece – Lutèce : Guide d'installation

I. Guide d'installation

1. Installation de MySQL

Télécharger MySQL à l'adresse suivante : http://www.mysql.com/downloads/index.html
Pour la documentation d'installation de mysql, se référer à l'url suivante : http://www.mysql.com/documentation/mysql/bychapter/manual_Installing.html#Installing

Mettre à jour la variable d'environnement PATH en ajoutant le chemin d'accès au répertoire \bin de MySQL à sa définition.

Lancer le serveur MySQL, si cela n'est pas fait automatiquement.

Remarque : vous pouvez créer un fichier SQL pour lancer ce script, ainsi le mot de passe n'apparaîtra pas dans l'historique

Deux procédures d'installation sont proposées pour la base de données lutece :

création d'une base de données locale, qui sera utilisée par une webapp lutece
création d'une base de données partagée et d'une ou de plusieurs bases locales, qui seront utilisées par une ou plusieurs webapps Lutece partageant du contenu.

Les fichiers *.sql utilisés avec la commande "source" de MySQL sont placés :

pour la base locale, dans le répertoire /src/sql/default de la distribution;
pour la base partagée, dans le répertoire /src/sql/shared de la distribution.

Pour utiliser la commande "source" comme indiquée dans la procédure d'installation ci-dessous, placez les fichiers *.sql dans le repertoire /bin de MySQL. Sinon, indiquez le chemin complet des fichiers dans la commande.

Dans le cas d'une utilisation de Lutèce avec une base partagée, reportez-vous au chapitre : Installation avec une base partagée.

2. Cas de l'installation d'une base locale Lutece

Créer la base lutece :

[Win32] :

Lancer MySQL depuis le sous-répertoire bin de <mysql_home> (où <mysql_home> est le répertoire dans lequel vous avez installé mysql).

Exécuter la commande suivante :

mysql.exe
mysql> create database lutece;

[Unix] :

# mysql -u root -p new_password

mysql> create database lutece;

Créer l'utilisateur qui servira à se connecter à la base depuis la webapp Lutece (les scripts SQL sont fournis dans le package de Lutece).

[Win32] & [Unix] :

mysql> source create_user_lutece.sql

Se connecter à la base de données :

[Win32] & [Unix]

mysql> use lutece;

Créer les objets de la base : (les scripts SQL sont fournis dans le package de Lutece)

[Win32] & [Unix]

mysql> source create_db_lutece.sql ;

Initialisation les données :

[Win32] & [Unix]

mysql> source init_db_lutece.sql ;

Si vous voulez vérifier que la base de données est correctement configurée pour l'utilisateur lutece (par défaut), lancer les commandes :

[Win32] & [Unix]:

mysql> show tables;
mysql> select * from theme;

3. Cas de l'installation d'une base partagée et d'une base locale

Créer la base partagée :

[Win32] :

Lancer Mysql depuis le sous-répertoire bin de <mysql_home> (où <mysql_home> est le répertoire dans lequel vous avez installé mysql).

Exécuter la commande suivante :

mysql.exe
mysql> create database shared;

[Unix] :

# mysql -u root -p new_password

mysql> create database shared;

Créer l'utilisateur qui servira à la webapp pour se connecter à la base shared.

[Win32] & [Unix] :

mysql> source create_user_shared.sql

Se connecter à la base de données :

[Win32] & [Unix]

mysql> use shared;

Créer la structure de la base :(les scripts SQL sont fournis dans le package de Lutece)

[Win32] & [Unix]

mysql> source create_db_shared.sql ;

Importer les données :

[Win32] & [Unix]

mysql> source init_db_shared.sql ;

Si vous voulez vérifier que la base de données est correctement configurée pour l'utilisateur shared (par défaut), lancer les commandes :

[Win32] & [Unix]:

mysql>use shared;

mysql> show tables;
mysql> select * from theme;

Créer une base locale lutece :

[Win32] :

Lancer Mysql depuis le sous-répertoire bin de <mysql_home> (où <mysql_home> est le répertoire dans lequel vous avez installé mysql).

Exécuter la commande suivante :

mysql.exe
                                
mysql> create database lutece;

[Unix] :

# mysql -u root -p new_password

mysql> create database lutece;

Créer l'utilisateur qui servira à la webapp pour se connecter à la base lutece. (les scripts SQL sont fournis dans le package de Lutece)

[Win32] & [Unix]:

mysql> source create_user_lutece.sql

Pour créer deux bases locales sur le même serveur de base de données, il faut que celles-ci aient des noms différents. Il faut donc reproduire l'étape de création de la base locale et de son utilisateur pour chaque base locale envisagée ( ne pas oublier de mettre à jour les fichiers db.properties pour le nom de la base locale et les mots de passe utilisateur, ainsi que le fichier config.properties pour les identifiants des différents portails. (Les identifiants des portails sont ceux créés dans la table portal de la base shared)

Se connecter à la base de données :

[Win32] & [Unix]

mysql> use lutece;

Créer la structure de la base :

[Win32] & [Unix]

mysql> source create_db_lutece.sql ;

Importer les données :

[Win32] & [Unix]

mysql> source init_db_lutece.sql ;

Si vous voulez vérifier que la base de données est correctement configurée pour l'utilisateur lutece (par défaut), lancer les commandes :

[Win32] & [Unix] :

mysql> use lutece;
mysql> show tables;
mysql> select * from theme;

4. Installation du serveur d'application

L'installation décrite ci-après concerne le serveur d'application Tomcat.

4.1 Installation du J2SDK

L'utilisation de Tomcat nécessite l'installation préalable de Java 2 SDK Standard Edition sur le serveur. La version minimale à utiliser est le jdk 1.4.2_06.

Installation de Java 2 SDK, Standard Edition

Télécharger la version du JDK depuis le site de Sun : http://java.sun.com/j2se/downloads.html

Configurer ensuite la variable d'environnement JAVA_HOME en lui donnant pour valeur le chemin d'accès au répertoire contenant le JDK.

Mettre à jour la variable d'environnement PATH en ajoutant JAVA_HOME\bin à sa définition.

4.2 Installation de Tomcat

Télécharger Tomcat depuis l'adresse suivante : http://jakarta.apache.org/tomcat/index.html Configurer ensuite la variable d'environnement TOMCAT_HOME en lui donnant pour valeur le chemin d'accès au répertoire de Tomcat.

Recharger le fichier contenant les variables d'environnement pour que les modifications soient prises en compte.

4.3 Vérification de l'installation

Lancer Tomcat : (<tomcat_home> est le répertoire dans lequel vous avez installé Tomcat)

[Win32] : <tomcat_home>/bin/startup.bat

[Unix] : <tomcat_home>/bin/startup.sh
Lancer un navigateur et taper l'URL suivante : http://localhost:8080 La page d'accueil de Tomcat doit s'afficher.
Pour arrêter Tomcat :

[Win32] : <tomcat_home>/bin/shutdown.bat

[Unix] : <tomcat_home>/bin/shutdown.sh

4.4 Configuration du serveur

Pour désactiver l'affichage de la liste des fichiers à partir de l'url d'une webapp, modifier le fichier <tomcat_home>/conf/web.xml :
```
<init-param>
<param-name>listings</param-name>
<param-value>false</param-value>

</init-param>
                                        
```
Modifier les tailles mémoire allouées à la machine virtuelle.

Dans le fichier <tomcat_home>/bin/catalina.sh, ajouter la ligne :
```
CATALINA_OPTS="-Xms128m -Xmx512m"
                                        
```
pour définir la mémoire initiale (128 Mo) et maximale (512 Mo) allouée à la JVM.

4.5 Installation de l'application

Télécharger les fichiers zip de l'application Lutèce. Construire le projet Lutèce si vous utilisez les sources et non le .war.
Copier le fichier war de Lutèce dans le répertoire webapps de Tomcat
Lancer Tomcat pour déployer l'application
Editer les fichiers de configuration config.properties et db.properties pour mettre à jour les chemins d'accès.

Le contenu de ces fichiers est décrit ci-après.

II. Configuration de l'application

Les fichiers de configuration de l'application se trouvent dans le répertoire WEB-INF/conf de la webapp. Les fichiers à configurer sont les suivants :

config.properties
db.properties

1. Configuration du fichier config.properties

A mettre à jour au moment du déploiement de l'application :

Lors du premier lancement de l'application, autoInit est à true pour vous permettre la mise à jour automatique des chemins absolus du fichier. Par la suite, il est positionné à false.
`# AutoInit for first deployment` `autoInit=false`

Paramètres qui servent pour le plugin article (portal.param sert à créer et reconnaître le code du fournisseur de contenu et plugin.param.source.id est le nom du paramètre à récupérer dans le fichier de configuration xml du plugin )
`# Portal and Plugins parameters` `portal.param=LUTECE` `plugin.param.source.id=id_source`

Renseigner ici l'adresse IP du serveur SMTP
`# Mail sending parameters` `mail.server=`

Renseigner ici les chemins complets pour accéder aux fichiers properties lutece, jtidy et webmaster
`# Properties files` `file.lutece.properties=C:/tomcat/webapps/lutece/WEB-INF/conf/lutece.properties` `file.jtidy.properties=C:/tomcat/webapps/lutece/WEB-INF/conf/jtidy.properties` `file.webmaster.properties=C:/tomcat/webapps/lutece/WEB-INF/conf/webmaster.properties` `file.dir.plugins=C:/tomcat/webapps/lutece/WEB-INF/conf/plugins`

Renseigner ici les chemins des fichiers logs
`# Logs files` `file.lutece.error.log=C:/tomcat/webapps/lutece/WEB-INF/logs/errors.log` `file.lutece.app.log=C:/tomcat/webapps/lutece/WEB-INF/logs/application.log` `file.pool.log=C:/tomcat/webapps/lutece/WEB-INF/logs/pool.log`

Si `error.page.debug=true`, le détail de l'erreur s'affiche dans la page. Si `error.page.debug=false`, le message défini dans error.page.message (qui se situe dans le fichier de ressources "util_messages_fr.properties") s'affiche dans la page

Configurer ici les paramètres d'indexation pour le moteur de recherche Lucene. Il faut renseigner dans `lucene.page.jsp` l'url de la JSP `Portal.jsp`. Si vous souhaitez que ce site indexe d'autres sites Lutece, indiquez la liste des sites dans lucene.list.sites.toindex (liste séparée par des "," )
`# Lucene search engine : indexing parameters` `lucene.page.jsp=http://localhost:8080/lutece/jsp/site/Portal.jsp` `lucene.nb.docs.per.page=5` `lucene.list.sites.toindex= http://localhost:8080/lutece/servlet/XmlServlet` `lucene.site.toindex=http://localhost:8080/lutece/servlet/XmlServlet`

Renseigner ici les chemins d'accès aux fichiers application.log, error.log et pool.log
`# log4j parameters` `log4j.rootLogger=WARNING, Error` `log4j.appender.Error.File=C:/tomcat/webapps/lutece/WEB-INF/logs/error.log` `...` `log4j.logger.Application=DEBUG, App` `...` `log4j.logger.Pool=DEBUG, Pool`

Mise à jour du fichier db.properties

Choix du service de connexion : `LuteceConnectionService` pour utiliser le pool de connexion de l'application Lutèce `TomcatConnectionService` pour utiliser le pool de connexion de Tomcat
`portal.poolservice=fr.paris.lutece.util.pool.service.LuteceConnectionService` OU `portal.poolservice=fr.paris.lutece.util.pool.service.TomcatConnectionService`

Renseigner ici le nom du pilote à charger pour la connection à une base MySQL
`portal.driver=org.gjt.mm.mysql.Driver`

Renseigner `portal.url` pour indentifier la source des données JDBC de la base lutece; `portal.user` et `portal.password` renseignent le code et le mot de passe pour que l'application se connecte à la base lutece.
`portal.url=jdbc:mysql://127.0.0.1/lutece?autoReconnect=true` `portal.user=lutece` `portal.password=lutece`

Les différents niveaux possibles (dans l'ordre du moins au plus verbeux) : error, info, debug
`# Levels of the messages to write in the logs` `portal.loglevel=error`

Requête permettant de tester la validité de la connexion La valeur varie selon la base de données concernée : par exemple `SELECT 1` pour une base de type MySQL, `SELECT SYSDATE FROM dual` pour une base Oracle
`portal.checkvalidconnectionsql=SELECT 1`

Remarque : si vous modifiez un des fichiers properties, pensez à arrêter tomcat et à le relancer pour que les nouveaux paramétrages soient pris en compte.

Le fichier webmaster.properties est également à paramétrer. Une interface permet de le faire simplement depuis le module d'administration.

Lancement de l'application

Pour lancer la webapp Lutece tapez directement l'URL suivant (le serveur tomcat doit avoir été lancé) : http://localhost:8080/lutece

Connexion au module d'administration de Lutece

Pour se connecter au module d'administration, tapez l'url suivante : http://localhost:8080/lutece/admin/AdminLogin.jsp

Deux comptes sont créés par défaut :