Introduction

Les chapitres abordés dans la documentation d'installation sont:

Pré-requis

Généralités

Nuxeo est prévu pour être installé sur une machine unix (Par exemple Linux).

On s'attend à trouver sur la machine un JDK en version 5 ou 6.

Nuxeo fonctionne avec un serveur d'applications JBOSS (livré avec le package ESUP-ECM). Nous recommandons de créer un utilisateur dédié (par exemple jboss) qui sera utilisé pour faire faire tourner JBOSS.

export JAVA_HOME=/opt/jdk1.5.0

On s'attend également à ce que ant soit présent sur la machine.

L'utilisation du serveur Open Office est recommandée . Ce serveur (et son patch nuxeo) transforme à la volée les documents (de tout format) en format pdf.
Son installation est détaillée dans cette page.

Base de données

Le choix du SGBD

Nuxeo nécessite une base de données transactionnelle avec un mécanisme de sauvegarde en ligne. Il est conseillé d'utiliser un serveur permettant de sauvegarder/restaurer les données de façon incrémentale. Pour cette raison, cette version de ESUP-ECM est préconfiguré pour PostgreSQL.

Même si Nuxeo recommande/privilégie l'utilisation de PostgreSQL, ESUP-ECM a été rendu compatible avec Mysql.
Nous rappelons que la seule base de données préconisée officiellement par Nuxeo est PostgreSQL. La compatibilité avec MySQL est le résultat du travail d'intégration du projet ESUP-ECM.

Reportez vous à la documentation suivante pour connaître les raisons exprimées par Nuxeo sur l'utilisation exclusive de PostgreSQL: FAQ > Des raisons pour éviter d'utiliser MySQL avec Nuxeo

Les bases nécessaires

Nous recommandons de créer deux bases :

• Une base pour la gestion du repository des documents : nuxeo_storage
• Une base pour tous les autres besoins (indexation,recherche,gestion des relations,...)   de la solution : nuxeo

Il est extrêmement important de souligner les remarques spécifiques à chacun de ces 2 SGBD:

PostgreSQL

A partir de la version 5.2 de Nuxeo, il faut désormais priviligier une base de données 8.3.4+.

L'utilisation de PostgreSQL 8.3 nécessite la définition de certaines fonctions particulières. Avant de vous lancer dans l'installation, veuillez suivre la documentation suivante: http://doc.nuxeo.org/xwiki/bin/view/FAQ/UsingPostgreSQL83

En plus de la création de la base et des recommandations sur la version 8.3 de PostgreSQL, il vous faut également sur la base de données qui contiendra le repository (nuxeo_storage ici) exécuter cette requête :

create language plpgsql;

Sans cela, vous obtenez quelque chose comme :

org.postgresql.util.PSQLException: ERREUR: le langage « plpgsql » n'existe pas

MySQL

Dans la cas où vous utilisez MySQL, il est nécessaire d'utiliser le service de gestion des transactions InnoDB.
Vérifiez la présence de la ligne suivante dans my.cnf : default-storage_engine = innodb

Le script sql de création des bases pourrait ressembler à :

create user nuxeo;
set password for 'nuxeo'@'%' = password('XXXXX');
create database `nuxeo` default character set utf8 collate utf8_general_ci;
grant all privileges on nuxeo.* to 'nuxeo'@'%';
create database `nuxeo_storage` default character set utf8 collate utf8_general_ci;
grant all privileges on nuxeo_storage.* to 'nuxeo'@'%';

Lorsque vous passerez à l'étape d'installation, à aucun moment ne vous sera demandé de créer les tables de la base de données. En effet, toutes les tables sont créées automatiquement lors du premier démarrage de ESUP-ECM.

Si vous utilisez MySQL, il est nécessaire de procéder à une modification d'un type d'attribut de la base de données avant de faire le premier dépôt.

En effet, dans la version courante de ESUP-ECM, le champ nécessaire au stockage du plein texte a un format trop restrictifs pour les fichiers de taille moyenne.

Les modifications à faire portent donc sur l'attribut binarytext dans la table fulltext.
Il faut changer son type de text à longtext.

Dans le cas où vous ne faites pas cette modification avant, vous obtiendrez certainement l'erreur suivante lors du dépôt d'un fichier trop volumineux:

Installation

Résumé

• Télécharger esup-ecm-<version>.zip depuis le site du projet
• Décompresser le fichier dans un répertoire de travail
• Copier le fichier build-example.properties en build.properties
• Adapter le contenu du fichier build.properties. Cf. paragraphe suivant pour plus d'informations.
• Positionner JAVA_HOME (ex : export JAVA_HOME=/opt/jdk1.5.0)
• Lancer la commande ant deploy

  Note

  Si vous utilisez un serveur proxy il faut :

  • Pour ANT : Définir les variables d'environnement export ANT_OPTS="-Dhttp.proxyHost=proxy-host.domain.org -Dhttp.proxyPort=1234" pour les téléchargements initiaux.
  • Pour MAVEN : Editer le fichier .m2/settings.xml contenu dans votre home_dir

    <settings>
       <proxies>
          <proxy>
             <active>true</active>
             <protocol>http</protocol>
             <host>proxy-host.domain.org</host>
             <port>1234</port>
             <nonProxyHosts>*.univ.fr|localhost</nonProxyHosts>
          </proxy>
       </proxies>
    </settings>
    

• Créer l'utilisateur défini par la valeur de jboss.user
• Attribuer les droits d'exécution aux shells sous <nuxeo.dir.parent>/nuxeo-dm-5.2.0/bin
• Lancer le serveur par la commande

  sh <nuxeo.dir.parent>/nuxeo-dm-5.2.0/bin/jbossctl start &

• Tester http://<nomServeur>:<portHttpTomcat>/nuxeo

Paramètres du build.properties

Lancement /arrêt du serveur JBOSS

Le serveur se lance grâce au script  run.sh et s'arrête avec shutdown.sh, tous deux présents dans le répertoire d'installation (nuxeo.dir.parent/ du build.properties).

Ces scripts sont appelés par la commande jbossctl

Démarrage :

sh <nuxeo.dir.parent>/nuxeo-dm-5.2.0/bin/jbossctl start &

Arrêt :

sh <nuxeo.dir.parent>/nuxeo-dm-5.2.0/bin/jbossctl stop &

Interfaces réseau

La valeur par défaut 0.0.0.0 du paramètre jboss.bind.address décrit plus haut, permet d'écouter sur toutes les interfaces.

Pour restreindre l'écoute à une interface précise, il faut préciser l'IP à utiliser. Si Nuxeo est derrière un frontal Apache, il faut s'assurer que l'IP indiquée corresponde à celle du VirtualHost.

En l'absence de valeur pour ce paramètre, le serveur n'écoutera que sur le loop back (127.0.0.1).

Logs du serveur

Les logs du serveur sont par défaut générés dans <nuxeo.dir.parent>/nuxeo-dm-5.2.0/server/default/log/server.log
Cet emplacement est modifiable par le paramètre jboss.server.log décrit plus haut.

On peut modifier la façon dont vont être générés les logs par le fichier <nuxeo.dir.parent>/nuxeo-dm-5.2.0/server/default/conf/jboss-log4j.xml

Installation du serveur Open Office

Vous pouvez installer le serveur Open Office en vous reportant à cette page.