Nuxeo Server

Connecting Nuxeo to the Database

Updated: September 22, 2017 Page Information Edit on GitHub

To connect Nuxeo to your database, you need to tell Nuxeo which database template to use and provide the database connection information.

Connecting Nuxeo to the Database From the Admin Center

  1. In the Admin Center, click on the Setup tab of system information section.
  2. In the Main information section, select the target database in the drop down menu. A new Database Information section is displayed on the page.
  3. Fill in the database connection information.
  4. Click on the Save button displayed below the Email information section.
  5. Restart your server.

Connecting Nuxeo to the Database From the Startup Wizard

The first time you start your Nuxeo server, a wizard is displayed to help you setup your application. One of the steps is about the database: select the database you want to use in the drop down list and provide the connection information to the database.

Connecting Nuxeo to the Database From the nuxeo.conf File

By default, the "default" template is enabled on your Nuxeo server (see the Database templates section for more information on this template). You need to edit it to change the template to be used.

  1. Open your nuxeo.conf file with a text editor.

    For Windows users

     Do not use Office writers, nor Notepad.

    Wordpad is fine, Notepad++ and SciTE are good text editors, there are a lot of other text editors.

  2. If needed, uncomment or edit the nuxeo.templates parameter and replace default with the wanted database template's name (see Database Templates section).
  3. Uncomment or edit the parameters below and provide their values:
    • nuxeo.db.name
    • nuxeo.db.user
    • nuxeo.db.password
    • nuxeo.db.host
    • nuxeo.db.port
  4. Save your modifications.
  5. Restart the server.

For production or load testing environments

These are the minimum required parameters to enable the Nuxeo server to communicate with the database. For a production or load testing environment, you may need to provide the other commented parameters.

Database Templates

The default available database templates are:

  • common: Common template used by other templates
  • default: default Nuxeo configuration template for test purpose
  • sql: Configuration template for SQL directories (since 9.2)
  • https: (not recommended) Template to make the server listen to port 443 (HTTPS)
  • postgresql: PostgreSQL configuration template
  • postgresql-quartz-cluster
  • mssql: MS SQL Server configuration template
  • mssql-quartz-cluster
  • mysql: MySQL configuration template
  • mariadb: MariaDB configuration template (since Nuxeo FT 9.1; for older versions of Nuxeo the mysql template should be used)
  • mongodb: MongoDB configuration template
  • oracle: Oracle configuration template
  • oracle-quartz-cluster;
  • custom: Sample custom templates. Of course, this template is empty by default. One should copy it outside $NUXEO_HOME and adapt to their needs. See related section below.

The most commonly used templates are described below. For more information read the page Configuration Templates.

Default

This is the default Nuxeo configuration using an embedded H2 database. It is designed for development or test purpose. Do not use this in production or for performance evaluations.

  • Repository backend: H2
  • Services backend: H2

This is the recommended configuration for production, based on PostgreSQL.

  • Repository backend: PostgreSQL XA
  • Services backend: PostgreSQL XA

The PostgreSQL driver is included in the Nuxeo applications by default. However, if needed you can download a more recent version from http://jdbc.postgresql.org/download.html#current.

The JAR (for instance postgresql-9.4-1212.jar) is located in $NUXEO/lib/.

You can use a later driver with an earlier database version, for instance the 9.4 driver still works with PostgreSQL 9.2 or 9.3.

See the page PostgreSQL for more information on the database configuration.

Oracle

  • Repository backend: Oracle XA
  • Services backend: Oracle XA

The driver is not included in Nuxeo applications for legal reasons. To install it:

  1. Download the appropriate JDBC driver from http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html.
  2. The JAR (ojdbc7.jar) must be placed in $NUXEO/lib/.

See the page Oracle for more information on the database configuration.

Microsoft SQL Server

  • Repository backend: Microsoft SQL Server XA
  • Services backend: Microsoft SQL Server XA

The Microsoft JDBC driver is already shipped with Nuxeo.

The JAR (for instance sqljdbc-4.2.6420.jar) is located in $NUXEO/lib/.

See the page Microsoft SQL Server for more information on the database configuration.

MySQL

  • Repository backend: MySQL XA
  • Services backend: MySQL XA

The JDBC driver (dowloadable from http://www.mysql.com/downloads/connector/j/) is included in Nuxeo applications and is located in $NUXEO/lib/.

We recommend using a near-infinite wait_timeout in the MySQL server configuration. See the page MySQL for more information on the database configuration.


2 days ago Solen Guitter Don't show excerpt 'upgrade-9.2-drop-change-token' and add comment
a year ago Manon Lumeau 47
a year ago Manon Lumeau 46
a year ago Manon Lumeau 44
a year ago Manon Lumeau 45
2 years ago Manon Lumeau 43 | Fix links
2 years ago Manon Lumeau 42
2 years ago Florent Guillaume 41
3 years ago Solen Guitter 40
3 years ago Solen Guitter 39 | Screenshot and link update
3 years ago Solen Guitter 36
3 years ago Solen Guitter 37 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 38 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 35
3 years ago Solen Guitter 34
4 years ago Thierry Martins 33
4 years ago Solen Guitter 31 | Updated screenshot
4 years ago Solen Guitter 32 | Migration of unmigrated content due to installation of a new plugin
4 years ago Alain Escaffre 30
4 years ago Solen Guitter 29
5 years ago Solen Guitter 23 | Added related pages in other documentation
5 years ago Solen Guitter 24 | Migrated to Confluence 4.0
5 years ago Solen Guitter 25 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 26 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 27 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 28 | Migration of unmigrated content due to installation of a new plugin
5 years ago Florent Guillaume 22 | Added related content
6 years ago Solen Guitter 21 | Added related content
6 years ago Solen Guitter 20 | added instructions for nuxeo.conf edition and Startup wizard
7 years ago Solen Guitter 19
7 years ago Solen Guitter 18
7 years ago Julien Carsique 17
7 years ago Julien Carsique 15
7 years ago Julien Carsique 16
7 years ago Julien Carsique 14
7 years ago Wojciech Sulejman 13 | cleanup
7 years ago Wojciech Sulejman 12 | Provided database connection information using templates. Added examples.
7 years ago Wojciech Sulejman 10
7 years ago Wojciech Sulejman 11
7 years ago Wojciech Sulejman 9
7 years ago Solen Guitter 8
7 years ago Solen Guitter 5
7 years ago Solen Guitter 6
7 years ago Solen Guitter 7
7 years ago Solen Guitter 4
7 years ago Florent Guillaume 3
7 years ago Florent Guillaume 2
7 years ago Florent Guillaume 1
History: Created by Florent Guillaume