10.2. Upgrade process

In eXo Platform 4, the upgrade is guaranteed and tested as follows:

This means you should upgrade from a version that is "the nearest" to the one you want to upgrade to. For example, if you want to upgrade from 4.1.1 to 4.2.1, you should upgrade from 4.1.1 to 4.2.0 (as in 4.2.0's release notes), then from 4.2.0 to 4.2.1 (as in 4.2.1's release notes).

However, if you still insist on skipping versions (for example, from 4.1.1 to 4.2.1), it is strongly advised you read all release notes of versions you are skipping to see which of any previous upgrade procedure impacts your project. eXo does not either guarantee or provide instructions for such an upgrade.

Upgrade to a new eXo Platform version

For Tomcat and JBoss packages

  1. Stop the old version of eXo Platform.

  2. Apply your customizations into the new version.

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

      Note

      As of eXo Platform 4.1, SMTP and JODConverter configuration has been included in the exo.properties file. See the corresponding sections in Configuration chapter.

  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-ABC-to-XYZ-sample.properties) into upgrade.properties as described in Release Notes. For example, to upgrade from 4.2.0 to 4.2.1, simply rename upgrade-4.2.0-to-4.2.1-sample.properties into upgrade.properties.

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

For Native Installer

  1. Stop the Tomcat server of the current installation and back up its data.

    1. Copy the $CURRENT_INSTALLER_DIR/apps/exoplatform/gatein/data folder to a known location.

    2. Back up the data from the Postgresql database (notice that the Postgresql server must be running, see this guide). To do this:

      • Go to the $CURRENT_INSTALLER_DIR/postgresql/bin folder.

      • Run the command pg_dump -U postgres -p database_port bitnami_exoplatform > backup.sql.

        Note

        • -p database_port is optional if you use the default port (5432) for the Postgresql server.

        • When prompted for password of the postgres user, enter the password of the root user set during the installation.

    3. Stop the Postgresql server if you want to use the same port for the new installation.

  2. Download the new installation, and install it.

  3. Stop the Tomcat server of the new installation.

  4. Go to $NEW_INSTALLER_DIR/apps/exoplatform/gatein/conf/, then rename the sample upgrade file regarding the installation you want to upgrade into upgrade.properties. For example, for upgrade from 4.2.0 to 4.2.1, simply rename upgrade-4.2.0-to-4.2.1-sample.properties into upgrade.properties.

  5. Replace the $NEW_INSTALLER_DIR/apps/exoplatform/gatein/data folder with the folder copied in step 1b.

  6. Restore the database from the current installation to the new one (notice that the Postgresql server must be running, see this guide). To do this:

    1. Copy the backup.sql file generated in step 1c from $CURRENT_INSTALLER_DIR/postgresql/bin to $NEW_INSTALLER_DIR/postgresql/bin.

    2. Go to the $NEW_INSTALLER_DIR/postgresql/bin folder.

    3. Run the command psql.exe -U postgres -p database_port and enter the password of the user postgres. In the Postgres shell, do as follows:

      • Drop the database bitnami_exoplatform with the command drop database bitnami_exoplatform;.

      • Recreate the database bitnami_exoplatform with the command create database bitnami_exoplatform;.

    4. Run the command psql -U postgres -p database_port bitnami_exoplatform < backup.sql.

  7. Start the Tomcat server. The upgrade will be run automatically. To check whether the upgrade is done successfully or not, refer to this link.

  8. Stop the Tomcat server.

  9. Remove or rename the upgrade.properties file under the $NEW_INSTALLER_DIR/apps/exoplatform/gatein/conf folder.

  10. Restart the Tomcat server. Now, go to the next section to do some tests on the upgraded version.

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