11.4. Upgrade process


You are looking at documentation for an older release. Not what you want? See the current release documentation.


When you upgrade to eXo Platform, notice that default password encryption algorithm has changed so you need to reconfigure it back to the one that you used before, otherwise old users will not be able to log in. See details in Password Encryption.

The upgrade procedure is only guaranteed and tested to be transparent from the previous maintenance version (x.y.z from x.y.z-1). So, we recommend to apply upgrade procedures for all versions between your current one and the target one. In this case it is from 4.4 to 5.0. If you are on 4.4.2 version, you should move into the 4.4.3 then to 4.4.4 and then move to 5.0 version. However, if you still insist on skipping versions, we strongly advise to read all upgrade notes of the versions you are skipping to see if your project is impacted by any previous upgrade procedure.

Upgrade to a new eXo Platform version

For Tomcat and JBoss packages

  1. Stop the old version of eXo Platform, in this case the 4.4 version.

  2. Apply your customizations into eXo Platform 5.0.

    • If you have changed the configuration properties via $PLATFORM_TOMCAT_HOME/gatein/conf/exo.properties (Tomcat) or $PLATFORM_JBOSS_HOME/standalone/configuration/gatein/exo.properties (JBoss), you can update them to the same file in the new eXo Platform version.

    • If you use a populated organizational data source (such as LDAP), activate the Organization Integration Service so that the data is synchronized. See Synchronization for more details.

  3. Configure the JCR and IDM databases. Refer to Database for more details.

  4. Configure the EXO_DATA_DIR variable. Refer to Data directory configuration for more details.

  5. Go to the new eXo Platform package ($PLATFORM_TOMCAT_HOME/gatein/conf/ or $PLATFORM_JBOSS_HOME/standalone/configuration/gatein/), then rename the sample upgrade file regarding the version you want to upgrade known as upgrade-sample.properties) into upgrade.properties as described in Release Notes.

  6. Start the eXo Platform server. The upgrade will be run automatically. The startup is successful when you see a message like INFO | Server startup in XXXX ms.

  7. Stop the server.

  8. Remove or rename the upgrade.properties in Step 5. This is to avoid running the upgrade again for next time.

  9. Restart the server, then do some tests on the upgraded version. See Best practices for more details.


  • eXo Platform 5.0 version requires the version 5.6 of Elasticsearch, you should upgrade to this version.

    eXo Platform is shipped with an embedded version of Elasticsearch which automatically starts when eXo Platform starts. You can deactivate it through Elasticsearch Configuration. This embedded Elasticsearch instance is recommended for development and test but not for production.

    For production it is recommended to run a standalone Elasticsearch cluster (please refer to Elasticsearch documentation for more details). In order to use a standalone Elasticsearch cluster, some properties must be defined in exo.properties. Please refer to Elasticsearch Configuration for more details.

  • Starting from eXo Platform 5.0:

    • Settings and Notifications data has been moved from JCR to JPA datasources.

    • ECMS files are indexed in Elasticsearch.

  • If you run eXo Platform 5.0 for the first time, the Enterprise skin will be the default skin. If you upgrade your eXo Platform instance from a previous version, your previous skin will still be applied.

    We do not want to force the change to the new Enterprise Skin if you used another skin and it could break skin customizations. You can change it by yourself in portal settings.

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus