Fork me on GitHub

I. Installation de l'environnement

1. Installation de MySQL

Télécharger MySQL à l'adresse suivante : http://dev.mysql.com/downloads/.

Pour la documentation d'installation de MySQL, se référer à l'url suivante : http://dev.mysql.com/doc/.

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

Pour s'assurer de pouvoir stocker dans la base de données des fichiers volumineux, il est conseillé d'augmenter la taille maximale des paquets (max_allowed_packet). Pour ce faire, il suffit d'éditer le fichier my.ini qui se situe dans le répertoire d'installation de MySQL et d'y ajouter la propriété suivante :

max_allowed_packet=24M
	                    

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

2. Création de la base de données

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

  • Création de la base de données en utilisant Ant.
  • Création de la base de données en utilisant MySQL.

2.1 Installation de la base de données avec Ant

L'utilisation de Ant pour la création de la base de données, est la méthode la plus simple et la plus rapide. Cependant, il faut avoir installé auparavant Ant.

Veuillez suivre la procédure qui suit pour mener à bien cette installation :

2.1.a Installation de Ant

Télécharger Ant depuis l'adresse suivante : http://ant.apache.org/bindownload.cgi.

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

2.1.b Création de la base

Maintenant, il ne reste plus qu'à créer la base de données lutece.

Pour ce faire, il suffit d'aller dans le dossier WEB-INF/sql de la webapp et d'exécuter la commande suivante :

[Win32] & [Unix] : ant

Information : cette commande permet de créer et d'initialiser la base et les tables correspondantes. Elle s'appuie sur le fichier build.xml qui est généré automatiquement lors de la construction du projet. Ce fichier utilisera l'ensemble des fichiers SQL se trouvant dans le dossier WEB-INF/sql de la webapp. Il appelera en priorité les fichiers de création et d'initialisation des tables du coeur de Lutèce (create_db_lutece_core.sql et init_db_lutece_core.sql). Ensuite, si la webapp contient des plugins, le script exécutera les fichiers SQL de création et d'initialisation des tables pour chaque plugin qui se trouvent dans le dossier WEB-INF/sql/plugins (ces fichiers peuvent être des scripts de création et d'initialisation de tables propres au plugin mais peuvent aussi initialiser des tables du coeur).

Ce script utilise le fichier db.properties pour se connecter à la base de données. Pour configurer ce fichier, veuillez consulter la partie II.2. Mise à jour du fichier db.properties.

Remarque : si un plugin nécessite un pool de connexion particulier, il suffit de définir ce pool dans le fichier db.properties. Ce pool doit avoir le même nom que le plugin qui l'utilisera.

2.2 Installation de la base de données en utilisant les commandes MySQL

L'autre méthode pour installer la base de données est d'utiliser les commandes MySQL. Pour ce faire, il ne faut aucun autre logiciel à part MySQL. Pour installer et configurer MySQL, si ce n'est pas déjà fait, veuillez consulter la partie I.1. Installation de MySQL.

Information : les fichiers *.sql utilisés avec la commande "source" de MySQL sont placés dans le répertoire WEB-INF/sql 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 répertoire /bin de MySQL. Sinon, indiquez le chemin complet des fichiers dans la commande.

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;
	                        

Se connecter à la base de données :

[Win32] & [Unix] :

mysql> use lutece;
	                        

Créer et initialiser les tables de la base : (les scripts SQL sont fournis dans le package de Lutèce)

Pour cette étape, il faut différencier les tables du coeur et les tables des plugins.

  • Pour les tables du coeur :

[Win32] & [Unix] :

mysql> source create_db_lutece_core.sql ;
mysql> source init_db_lutece_core.sql ;
			                
  • Pour les tables relatives aux différents plugins (si ces plugins sont déployés dans la distribution) :

Dans le dossier WEB-INF/sql/plugins, exécuter tous les scripts SQL (create_<X>.sql et init_<X>.sql) de chaque sous-dossier (correspondant au plugin du même nom).

[Win32] & [Unix] :

mysql> source create_<X>.sql ;
mysql> source init_<X>.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 core_admin_right;
	                        

3. Installation du serveur d'application

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

3.1 Installation du JDK 5.0

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.5.0.

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.

3.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.

3.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

3.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 les fichiers <tomcat_home>/bin/catalina.bat et <tomcat_home>/bin/catalina.sh, ajouter la ligne suivante :

    CATALINA_OPTS="-Xms128m -Xmx512m"
                                            

    pour définir la mémoire initiale (128 Mo) et maximale (512 Mo) allouée à la JVM.

4. Installation de l'application

  • Télécharger les fichiers zip de l'application Lutèce. Vous pouvez aller sur la page Download pour télécharger ces fichiers.
  • 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

Ce fichier est à 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

Renseigner ici les informations nécessaires pour l'envoi de mail (notamment l'adresse IP du serveur SMTP).

# Mail sending parameters

mail.server=

mail.list.separator=;

mail.type.plain=text/plain;charset=

mail.type.html=text/html;charset=

mail.noreply.email=noreply@nowhere.org

mail.charset=utf-8

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 complets des fichiers de log (ces champs sont automatiquement mis à jour quand la propriété autoInit=true).

# 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 s'affiche dans la page.

# Error page management

error.page.debug=true

error.page.message=Veuillez contacter immédiatement l'administrateur de l'application

Activer ou non la gestion du cache pour les templates, le contenu des pages ou les articles. En production, il est recommandé de mettre ces valeurs à true.

# Caches management

service.templates.cache.enable=false

service.pages.cache.enable=false

service.articles.cache.enable=false

Renseigner ici les chemins d'accès aux fichiers de log : application.log, error.log et pool.log.

# log4j parameters

log4j.rootLogger=WARNING, Error

log4j.logger.lutece.error=ERROR, Error, Console

log4j.logger.lutece.pool=ERROR, Error

...

log4j.appender.Error.File=C:/tomcat/webapps/lutece/WEB-INF/logs/error.log

log4j.appender.Application.File=C:/tomcat/webapps/lutece/WEB-INF/logs/application.log

...

2. 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&useUnicode=yes&characterEncoding=utf8

portal.user=lutece

portal.password=lutece

Renseigner ici le nombre de connexions que le pool doit créer lors de son initialisation.

portal.initconns=2

Renseigner ici le nombre maximal de connexions simultanées pour le pool portal.

portal.maxconns=20

Renseigner ici le temps maximum d'attente lors d'une connexion à la base de données (en millisecondes).

portal.logintimeout=2

Requête permettant de tester la validité de la connexion. La valeur varie selon la base de données concernée :

  • 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ètres soient pris en compte.

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

III. Lancement de l'application

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

IV. Connexion au module d'administration de Lutèce

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

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

  • Login : admin - Mot de passe : admin (compte de l'administrateur technique).
  • Login : lutece - Mot de passe : lutece (compte du gestionnaire de contenu).