Récupération de Nuxeo

Récupérez la version de Nuxeo que vous souhaitez installer avec les derniers Hot Fixes à l'adresse ci-dessous :

https://maven.nuxeo.org/nexus/content/repositories/public-releases/org/nuxeo/ecm/distribution/nuxeo-distribution-tomcat/

Dézippez ensuite le fichier téléchargé dans le répertoire destiné à accueillir Nuxeo

Nuxeo Wizard

Depuis les versions 5.4, un wizard se lance automatiquement au premier démarrage de Nuxeo (dans le cadre d'une première installation). Il permet de renseigner un certains nombre de paramètres (base de données, paramètres SMTP, répertoires de stockages des logs et des binaires, choix des modules ...). Ces derniers sont insérés au fichier nuxeo.conf.

L'utilisation de ce wizard peut s'avérer pratique mais il y a de fortes chances qu'il soit nécessaire d'aller plus loin en éditant le fichier nuxeo.conf et en utilisant les templates.

Note : il est possible de relancer le wizard à tout moment en lançant la commance : <racine_nuxeo>/bin/nuxeoctl wizard

Nuxeo.conf et les templates

Les templates sont des répertoires permettant de stocker (notamment) des fichiers de configuration spécifiques.

Un certain nombre de templates pré-définis sont fournis par Nuxeo, la plupart servant à paramétrer les accès à la base de données. Le template "common" contient des fichiers de configuration "de base" devant être utilisés quel que soit l'environnement choisi.

Principe de fonctionnement

• Au démarrage, le fichier nuxeo.conf (par défaut placé dans <racine_nuxeo>/bin) est lu pour déterminer quels sont les plugins utilisés. On peut en choisir plusieurs (séparés par une virgule).
• Le fichier nuxeo.defaults de chacun des templates spécifiés est ensuite utilisé pour initialiser ou écraser des paramètres de configurations.
• Le fichier templates/nuxeo.defaults permet d'initialiser les paramètres de configuration qui n'ont pas été précédemment renseignés.
• Enfin, le fichier nuxeo.conf est utilisé et écrase les paramètres de configuration avec les valeurs qui y sont définies.

nuxeo.conf

C'est donc le fichier central qui stocke les variables de configuration de Nuxeo. Les éléments importants que vous serez certainement amenés à modifier (certains sont déjà renseignés si vous avez utilisé le wizard) sont détaillés ci-dessous. Pour avoir l'exhaustivité des paramètres disponibles, reportez-vous à ladocumentation de Nuxeo.

JAVA_HOME=/opt/java
Répértioire d'installation du jdk, on peut également utiliser les variables d'environnement pour renseigner cette donnée.

JAVA_OPTS= -Xms512m -Xmx1024m -XX:MaxPermSize=512m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dfile.encoding=UTF-8
Options passées à la JVM, permet notamment d'augmenter la mémoire allouée.

nuxeo.templates=custom
indique le (ou les) template(s) utilisé(s). Ici on décide d'utiliser le template custom.

nuxeo.force.generation=true
Indique à Nuxeo qu'il faut régénérer les fichiers de configuration à chaque démarrage.

nuxeo.db.user=nuxeo
nuxeo.db.password=secret
nuxeo.db.name=nuxeo
nuxeo.db.host=localhost
Paramètres de connexion à la base de données.

nuxeo.log.dir=/var/log/nuxeo
Répertoire de stockage des logs.

nuxeo.data.dir=/opt/data
Répertoire dans lequel seront stockés les documents téléchargés. Peut (c'est même conseillé) tout à fait être un point de montage.
Choisissez de préférence un répertoire situé hors de l'arborescence de Nuxeo (facilite le processus de mise à jour)

mail.stmp.host=smtp.univ.fr
mail.smtp.port=25
mail.from=nuxeo@univ.fr
mail.smtp.auth=false
nuxeo.notification.eMailSubjectPrefix="[espace collaboratif mon univ]"
Paramètres SMTP pour l'envoi des différents courriers (notifications, workflow, espaces communautaires, invitations ...)

jod.connection.protocol=SOCKET
jod.office.home=/opt/openoffice.org3/
Paramètres de configuration pour jodconverter (utilisation d'un serveur OpenOffice ou libreOffice pour la prévisualisation)

Utilisation du template Custom

Afin de maintenir toutes les personnalisations et ajouts par rapport à la configuration de base de Nuxeo dans un unique répertoire, nous recommandons l'utilisation du template custom (défini dans nuxeo.conf).

Dans le fichier nuxeo.defaults du template custom, on déclare les autres templates que l'on va utiliser.Exemple de fichier nuxeo.defaults

custom.target=nxserver
nuxeo.template.includes=default,postgresql,dam,collaboration
org.nuxeo.ecm.instance.description=Nuxeo ECM customized

On y précise aussi le répertoire dans lequel seront copiées toutes nos personnalisations, en l'occurrence, il s'agit du répertoire nxserver. L'idée est donc de reproduire l'arborescence de nxserver dans le template custom avec :

un répertoire config : on y stocke tous nos points d'extensions qui surchargent les configurations par défaut. les points d'extensions sont des descripteurs XML qui permettent de configurer les comportements des divers composants.

un répertoire bundles : on y stocke certains composants (addons). On fait le choix de stocker ici les composants distribués par Nuxeo tandis que l'on privilégiera le répertoire plugins pour stocker nos propres composants.

un répertoire plugins  : on y stocke nos composants personnalisés

D'autres répertoires pourront également être ajoutés au grès des personnalisations effectuées (lib  pour l'ajout de bibliothèques spécifiques, schemas pour stocker de nouvelles définitions de schemas...).

L'outil nuxeoctl

Nuxeoctl (dans <racine_nuxeo>/bin) est le script qui permet de démarrer et d'arrêter nuxeo (nuxeoctl start et nuxeoctl stop).

Il existe également d'autres commandes et options possibles qui peuvent être utiles :

L'option --debug permet un lancement en mode debug (nuxeo 5.5), a contrario on peut utiliser le mode --quiet.

Depuis Nuxeo 5.5, on peut également utiliser nuxeoctl pour la gestion des package market-place (listing, installation, désinstallation).

Retrouvez la liste des commandes disponibles surle site de Nuxeo.

Introduction

Cette page décrit les opérations minimales pour faire fonctionner nuxeo 5.4.1.

Pour une configuration plus poussée (intégration de CAS ou Shibboleth, personnalisation ... se référer aux pages explicatives concernées).

Pré-requis

Système d'exploitation

Un système d'exploitation Unix (Linux) est conseillé mais il reste néanmoins possible d'installer Nuxeo sous Windows.

Java

Un JDK 6 ou supérieur est recommandé.

Base de données

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. Il est possible d'installer nuxeo avec les bases de données suivantes :

• PostgreSQL
• MySQL
• MSSQL
• Oracle

Sachez toutefois que Nuxeo recommande l'utilisation de PostgreSQL.

OpenOffice

La présence d'une installation d'OpenOffice 3 peut être nécessaire si vous souhaitez utiliser la prévisualisation de fichiers ou la transformation à la volée en PDF.

2. Récupération de la release de nuxeo :

wget http://community.nuxeo.com/static/releases/nuxeo-5.4.1/nuxeo-dm-5.4.1-tomcat.zip
unzip nuxeo-dm-5.4.1-tomcat.zip

3. Configuration de la base de données :

3.1 Configuration Postgres :

Nuxeo supporte Postgres à partir de la version 8.3.

Quelques modifications à apporter au fichier postgresql.conf :

A indiquer de façon obligatoire à partir de la version 8.4 de postgres sinon déclenche des exceptions dans nuxeo (javax.transaction.HeuristicMixedEception)

max_prepared_transactions = 64

Dans un cadre de production, les paramètres ci-dessous peuvent améliorer les performances :

shared_buffers = 1GB
effective_cache_size = 2GB
work_mem = 32MB
maintenance_work_mem = 128MB
wal_buffers = 8MB
random_page_cost = 2

Se reporter à la documentation de Nuxeo pour plus de détails

Créer ensuite la base de données :

su - postgrespsql template1
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';
CREATE USER nuxeo WITH PASSWORD '123456';
CREATE DATABASE nuxeo ENCODING 'UTF8' OWNER nuxeo;

4. Configuration du template

Depuis la Version 5.3.2, Nuxeo utilise la notion de templates ainsi qu'un fichier nuxeo.conf pour faciliter et regrouper les options de configuration.

Vous trouverez plus de détails sur la façon d'utiliser les templates ainsi que sur les options disponibles dans nuxeo.conf dans la page de documentation dédiée.

Pour une configuration minimale, renseigner simplement le fichier nuxeo.conf (sous ?nuxeo-dm-5.4.1-tomcat/bin) avec les paramètres de votre base de données et choisissez le template correspondant à cette dernière :

nuxeo.db.name=nuxeo
nuxeo.db.user=nuxeo
nuxeo.db.password=123456
nuxeo.db.host=127.0.0.1
nuxeo.db.port=5432
nuxeo.templates=postgresql

Vous pouvez maintenant démarrer Nuxeo (nuxeo-dm-5.4.1-tomcat/bin/nuxeoctl start).

NB : il existe également un wizard qui vous permet de renseigner via une interface graphique les paramètres de connexion à la base de données, ce wizard se lance automatiquement si vous démarrez directement nuxeo sans avoir modifié le fichier nuxeo.conf. Dans le cadre d'une configuration avancée de nuxeo, il reste néanmoins conseillé de ne pas utiliser le wizard et de s'appuyer sur les templates, notamment le tempalte custom.

5. Configuration avancée

- Utilisation de l'authentification CAS et d'une annuaire LDAP : se référer à cette page

- Utilisation de l'authentification Shibboleth : se référer à cette page

- Personnaliser Nuxeo : se référer à cette page