Introduction

Esup-ECM correspond à un packaging de Nuxeo permettant de faciliter son installation et sa configuration par rapport aux besoins ressentis dans le projet Esup-ECM. Aussi, installer Esup-ECM correspond bel et bien à installer Nuxeo (Esup-ECM donne des orientations dans les possibilités de configurations offertes par Nuxeo).

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

Pré-requis

ESUP-ECM 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 (La version 6 n'est pas encore officiellement supportée par nuxeo).

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.

On s'attend également à ce que ant et maven soient présents sur la machine. De plus, maven doit être présent dans le path (exemple, si besoin, de positionnement du path : export PATH=$PATH:/opt/apache-ant-1.7/bin:/opt/apache-maven-2.0.9/bin)

De même, ESUP-ECM 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és pour PostgreSQL. La version 8.3 n'étant pas encore officiellement supportée par nuxeo nous vous demandons d'avoir accès un serveur postgreSQL en version 8.1 ou 8.2.

...

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

 Pour mysql, 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'@'%';

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.

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

  Remarque
  title note
  Si vous utilisez un serveur proxy il faut : Pour ANT : Définir les variables d'environnements  export ANT_OPTS="-Dhttp.proxyHost=proxy-host.domain.org -Dhttp.proxyPort=1234" pour les téléchargements initiaux. Pour NAVEN : Editer le fichier .m2/settings.xml contenu dans votre home_dir Bloc de code <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-ep-5.1.6.GA/bin
• Lancer le serveur par sh <nuxeo.dir.parent>/nuxeo-ep-5.1.6.GA/bin/jbossctl start &
• Tester http://<nomServeur>:<portHttpToncat>/nuxeo

Paramètres du build.properties

...

Paramètre

...

Description

...

Exemple

...

nuxeo.dir.parent

...

Répertoire où sera déployé l'application

...

/opt/nuxeo

...

nuxeo.url

...

URL utilisé pour les interactions avec CAS lors de différentes actions (login, logout). Le port correspond à tomcat.port.http si tomcat est utilisé directement. En cas d'utilisation d'un frontal apache, le port à utiliser ici est celui du frontal.

...

http://localhost:8080/nuxeo

...

jboss.console.log

...

Fichier de trace de la console jboss. Il se trouve par défaut sous  <nuxeo.dir.parent>/nuxeo-5.1.6.GA/server/default/log  

...

/var/log/nuxeo-console.log

...

jboss.server.log

...

Fichier de trace du serveur jboss. Il se trouve par défaut sous  <nuxeo.dir.parent>/nuxeo-5.1.6.GA/server/default/log  

...

/var/log/nuxeo.log

...

db.type

...

Le type de la base de données utilisée .
Saisir la valeur  "MySQL" pour mysql, "PostgreSQL" pour postgresql

...

MySQL
PostgreSQL

...

db.user

...

Nom de l'utilisateur pouvant lire et écrire dans les bases de données

...

...

db.password

...

Mot de passe conrespondant à l'utilisateur défini par db.user

...

e-%truc!

...

db.driver

...

Nom de la classe java du driver JDBC

...

db.schema

...

Nom du schéma

...

mysql
postgresql

...

db.url

...

Chaîne de connexion à la base de données nuxeo

...

db.mysql.jena.url

...

Particularité mysql : le paramètre relaxAutoCommit=true permet d'éviter les messages d'erreur lors des transactions quand autocommit=true

...

jdbc:mysql://localhost/nuxeo?relaxAutoCommit=true

...

db.mysql.compass.url

...

Particularité mysql : idem paramètre précédent avec en plus  emulateLocators=true permettant à compass de supporter  les BLOBS

...

jdbc:mysql://localhost/nuxeo?relaxAutoCommit=true&emulateLocators=true

...

Type de repository de documents :
JCR  ou sql storage (stockage Nuxeo conforme CMIS)

...

jcr
sql

...

db.jcr.url

...

Chaine de connexion à la base de données JCR (si rep.type=jcr)

...

jdbc:mysql://localhost/nuxeo_storage
jdbc:postgresql://localhost/nuxeo_storage

...

db.sql.server

...

Serveur de la base de données sql-storage (si rep.type=sql)

...

localhost

...

db.sql.port

...

Port de base de données sql-storage (si rep.type=sql)

...

3306

...

db.sql.db

...

Nom de la base de données sql-storage (si rep.type=sql)

...

nuxeo_storage

...

db.sql.user

...

Utilisateur de la base de données sql-storage (si rep.type=sql)

...

...

db.sql.password

...

Mot de passe correspondant à l'utilisateur de la base de données sql-storage (si rep.type=sql)

...

...

jdk.home

...

Chemin d'accès au JDK

...

/opt/jdk1.5.0

...

jboss.user

...

Nom de l'utilisateur qui lancera le serveur d'application jboss

...

jboss

...

tomcat.port.http

...

port HTTP utilisé par le tomcat embarqué par jboss pour répondre aux requêtes HTTP

...

8080

...

tomcat.port.jk

...

port AJP utilisé par le tomcat embarqué par jboss pour répondre aux requêtes AJP (utilisé dans le cas de l'utilisation d'un frontal apache)

...

9554

...

cas.url

...

URL d'accès au serveur CAS de l'établissement

...

https://sso.univ.fr

...

ldap.url

...

URL d'accès au serveur LDAP de référence

...

ldap://ldap.univ.fr:389

...

ldap.user.searchBaseDn

...

Base DN utilisé lors des recherches d'utilisateurs dans le LDAP

...

ou=people,dc=univ,dc=fr

...

ldap.user.firstName

...

Attribut LDAP contenant le nom des l'utilisateurs

...

givenName

...

ldap.user.lastName

...

Attribut LDAP contenant le nom complert à afficher pour les l'utilisateurs

...

sn

...

ldap.user.company

...

Attribut LDAP contenant l'organisme de rattachement des utilisateurs

...

supannOrganisme

...

ldap.user.email

...

Attribut LDAP contenant l'adresse électronique des utilisateurs

...

mail

...

ldap.user.defaultAdministratorId

...

UID de l'administrateur de la plateforme

...

ldap.group.searchBaseDn

...

Base DN utilisé lors des recherches de groupes dans le LDAP

...

ou=groups,dc=univ,dc=fr

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.com/pages/viewpage.action?pageId=3343487

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;

...

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

| Comme Nuxeo utilise la validation 'Two-phase Commit' en version PostgreSQL 8.4 on doit activer la variable max_prepared_transactions du fichier de configuration de postgresql postgresql.conf (ligne 110):max_prepared_transactions =64(Cette valeur étant commenté par défaut et valuée à 0.) |

Procédure avec template

Pour ne pas avoir à faire les réglages pour chaque base, on peut modifier le template1 de postgres, qui sera utilisé pour la création des bases Nuxeo.

La procédure ci-dessous reprend les inidcations des liens précédentsconcernant la customisation des bases postgreSQL en version 8.3.4+ pour Nuxeo.

...

Etape 1

...

Une fois postgreSQL installé :

su postgres
psql -d template1
# 1. changement du mot de passe admin
alter user postgres with password 'MDP';
# 2. modifs pour Nuxeo (voir plus bas)
CREATE FUNCTION pg_catalog.text(integer) RETURNS text STRICT IMMUTABLE LANGUAGE SQL AS 'SELECT textin(int4out($1));';
CREATE CAST (integer AS text) WITH FUNCTION pg_catalog.text(integer) AS IMPLICIT;
COMMENT ON FUNCTION pg_catalog.text(integer) IS 'convert integer to text';
CREATE FUNCTION pg_catalog.text(bigint) RETURNS text STRICT IMMUTABLE LANGUAGE SQL AS 'SELECT textin(int8out($1));';
CREATE CAST (bigint AS text) WITH FUNCTION pg_catalog.text(bigint) AS IMPLICIT;
COMMENT ON FUNCTION pg_catalog.text(bigint) IS 'convert bigint to text';
create language plpgsql;
\q

...

Etape 2

...

Ensuite, on peut créer les bases Nuxeo qui vont hériter du template1 par défaut :

# 3. creation des bases Nuxeo
createdb nuxeo_storage
createdb nuxeo

MySQL

Dans le 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. paragraphes suivants pour plus d'informations.
• Positionner JAVA_HOME (ex : export JAVA_HOME=/opt/jdk1.5.0)
• Lancer la commande ant deploy

  Remarque
  title 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 Bloc de code xml xml <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

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

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

Paramètres du build.properties

Fonctionnalités  (default.properties)

Le fichier default.properties définit le fonctionnement standard de ESUP-ECM. Il est possible d'ajouter et d'enlever des fontionnalités en modifiant la valeur de ces paramètres .

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 2.4

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

Installation du serveur Open Office

Consultez la page de référence à ce sujet : http://doc.nuxeo.org/5.1/books/nuxeo-book/html/admin-openoffice.html

Installation du serveur X virtuel

   Récupérer et installer un paquet Xvbf
   par exemple, sur RedHat :  yum install XFree86-Xvfb-4.3.0-69.EL.x86_64.rpm

Installation OpenOffice 2.4

    Il est conseillé d'installer la version 2 de openOffice.

    Consultez le guide d'installation officiel : http://fr.openoffice.org/Documentation/Guides/SETUP_GUIDE_FR08_1.pdf Par exemple, sur un serveur RedHat :

  
      cd /tmp
      wget http://openoffice.cict.fr/stable/2.4.2/OOo_2.4.2_LinuxIntel_install_en-US.tar.gz_
      tar -zxvf OOo_2.4.2_LinuxIntel_install_en-US.tar.gz
      yum install libgnomevfs-2.so.0
      cd  cd OOH680_m18_native_packed-1_en-US.9364/RPMS/
      rpm -ivh *.rpm

 Configuration de OpenOffice pour Nuxeo

     Deux extensions Nuxeo permettent de configurer OpenOffice en mode serveur de façon permanente.

 
         cd <path/to/esup-ecm>/esup-ecm-0.3
         svn co http://svn.nuxeo.org/nuxeo/tools/ooo-package/linux nxOOo
         cd nxOOo
         cp patch/bootstraprc <path/to/openoffice>/program/   
         <path/to/openoffice>/program/unopkg add --shared patch/nxSkipInstallWizard.oxt    (permet d'utiliser OO tout de suite après l'installation)
         <path/to/openoffice>/program/unopkg add --shared patch/nxOOoAutoListen.oxt       (permet de faire fonctionner OO en mode écoute de façon permanente)

Lancement/Arret de OOo en mode serveur

       Voici un exemple de script shell appelé  nxopenoffice :                 

 
         #!/bin/sh
         #
         # openoffice This shell script takes care of starting and stopping
         # openoffice server.
         #

          case "$1" in

            start)
              echo "Starting openoffice: "
              Xvfb :8100 2>/dev/null &
             sleep 5
             /opt/openoffice.org2.4/program/soffice.bin -headless "-accept=socket,host=localhost,port=8100;urp;StarOffice.Service" 2>/dev/null &
             echo
           ;;

          stop)
             ps -aef|grep "program/soffice.bin" | grep -v grep|cut -c10-15 >/var/run/ooo.pid
            val=`head /var/run/ooo.pid`
             if [ -n $val ]
              then
                 kill $val 2>/dev/null && echo "Shutting down openoffice: " $val
              fi
             ps -aef|grep "Xvfb" | grep -v grep|cut -c10-15 >/var/run/xvfb.pid
             val=`head /var/run/xvfb.pid`
            if [ -n $val ]
               then
                kill $val 2>/dev/null && echo "Shutting down virtual xterm: " $val
           fi   
           echo
          ;;

          restart)
             $0 stop
             $0 start
          ;;

          status)
            echo "Servers listening on port 8100 :"
            netstat -na | grep :8100 | wc -l
            netstat -na | grep :8100
            echo "openoffice processes :"
            ps -aef | grep -i program/soffice | grep -v grep
            echo "X processes :"
            ps -ef | grep -i xvfb | grep -v grep
        ;;

      *)
          echo "Usage: nxopenoffice [start|stop|restart|status]\n"
          exit 1

      esac

     exit 0

      Note : ne pas oublier de positionner JAVA_HOME