How to upgrade Nuxeo

This document describes a general upgrade procedure, check if your version needs particular action.

See Upgrading your Nuxeo Version for information about Nuxeo policy on development and versions.

General upgrade procedure

You should have configured Nuxeo with a specific configuration (and optionally with custom templates) setting a database (for production) and a data directory.
In that case, upgrading Nuxeo simply consists in:

• stopping old Nuxeo,
• deploying the new distribution,
• updating environment variables (NUXEO_HOME and NUXEO_CONF) to make it use your custom configuration, database and data directory,
• starting new Nuxeo.

Of course, you should always perform a backup before an upgrade.

If you didn't configure Nuxeo to use a database, then the default database is embedded in the data directory.

If you didn't configure Nuxeo data directory (nuxeo.data.dir in nuxeo.conf), then you have to find the default path which depends on the server (Tomcat/JBoss) and the Nuxeo version (look at the data directory value in the Admin Center).
With Tomcat, it should be $TOMCAT/nxserver/data.
With JBoss, it should be $JBOSS/server/default/data.

Specific cases

You will find below specific cases and required manual steps per version.
Follow them carefully from your current version to the new version. For instance, if upgrading from 5.3.2 to 5.4.2, follow steps about 5.3.2->5.4.0, 5.4.0->5.4.1 and 5.4.1->5.4.2.
If there are no specific instructions, then the upgrade will be smooth. For instance, if upgrading from 5.4.1 to 5.4.2, you have nothing to do unless you are using Oracle.

Upgrade notes Although major changes are explicitly documented, it is recommended to look at the upgrade notes before upgrading. Upgrade notes list changes that may affect existing configuration or features after upgrade (changes on parameters, API, default behavior, ...).

To 5.5 from 5.4.2

Upgrade notes.

See Upgrade from 5.4.2 to 5.5.

To 5.4.2 from 5.4.1

Upgrade notes.

Oracle

If using Oracle, see Upgrade to 5.4.2 with Oracle.

To 5.4.1 from 5.4.0.1

Upgrade notes.

To 5.4.0.1 from 5.4.0

Upgrade notes.

To 5.4.0 from 5.3.2

Upgrade notes.

JBoss

If using the JBoss distribution, see Upgrade to 5.4 and JBoss 5.

To 5.3.2 from 5.3.1

Upgrade notes.

See Upgrade from 5.3.1 to 5.3.2.

MySQL

If using MySQL, see Upgrade to 5.3.2 from 5.3.1 with MySQL.

To 5.3.1 from 5.3.0

Upgrade notes.

See Upgrade to 5.3.1 from 5.3.0.

To 5.3.0 from 5.2.0

Upgrade notes.

Workflow feature

The workflow implementation has changed, see From the old workflow system to the new workflow system.

To 5.2.0 from 5.1.6

Upgrade notes.

If using JCR with PostgreSQL, see How to migrate a Nuxeo 5.1.6 to Nuxeo 5.2 under JCR+PostgreSQL configuration.

To 5.1.6 from 5.1.3

Upgrade notes.

To 5.1.3 from 5.1.2

No upgrade notes.

See Upgrade to 5.1.3 from 5.1.2.

To 5.1.x from earlier

1. First, stop Nuxeo EP and, before any upgrade, always backup (at least)
   • $JBOSS/server/default/lib/nuxeo*
   • $JBOSS/server/default/deploy/nuxeo.ear/
   • $JBOSS/server/default/data/
   • dump your database(s) if you have any.
2. If you have specific configuration, back up separately the configuration files in order to easily re-apply them onto the default one (take care not to lose any modification on these files):
   • $JBOSS/server/default/deploy/nuxeo.ear/config/
   • $JBOSS/server/default/deploy/nuxeo.ear/datasources/
   • $JBOSS/server/default/deploy/nuxeo.ear/platform/nuxeo-platform-search-compass-plugin*/compass.cfg.xml
   • any other JBoss files you could have changed (mail-service.xml, etc.).
3. It could also be useful to back up logs from $JBOSS/server/default/log/.
4. Move your JBoss directory and replace it with the one coming from the new Nuxeo EP version.
5. Replace $JBOSS/server/default/data/ with your backup data.
6. Apply again you configuration.
7. Start Nuxeo.