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.3 to 4.4. 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
Stop the old version of eXo Platform, in this case the 4.3 version.
Apply your customizations into eXo Platform 4.4.
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.
Configure the JCR and IDM databases. Refer to Database for more details.
Configure the EXO_DATA_DIR variable. Refer to Data directory configuration for more details.
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.
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.
Stop the server.
Remove or rename the upgrade.properties in Step 5.
This is to avoid running the upgrade again for next time.
Restart the server, then do some tests on the upgraded version. See Best practices for more details.
Since the version 4.4.0, eXo Platform requires Elasticsearch.
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 4.4.0, wiki and social data has been migrated from JCR to JPA Datase and the related upgrade scripts are automatically run at eXo Platform startup.
Wiki data migration is done synchronously, meaning that eXo Platform instance will be available only once the data migration is done. Social data migration is done asynchronously, meaning that the data migration will run after eXo Platform start.
For Native Installer
Stop the Tomcat server of the current installation and back up its data.
Copy the $CURRENT_INSTALLER_DIR/apps/exoplatform/gatein/data folder to a known location.
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.
-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.
Stop the Postgresql server if you want to use the same port for the new installation.
Download the new installation, and install it.
Stop the Tomcat server of the new installation.
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.
Replace the $NEW_INSTALLER_DIR/apps/exoplatform/gatein/data folder with the folder copied in step 1b.
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:
Copy the backup.sql file generated in step 1c from $CURRENT_INSTALLER_DIR/postgresql/bin to $NEW_INSTALLER_DIR/postgresql/bin.
Go to the $NEW_INSTALLER_DIR/postgresql/bin folder.
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;.
Run the command psql -U postgres -p database_port bitnami_exoplatform < backup.sql.
Start the Tomcat server. The upgrade will be run automatically. To check whether the upgrade is done successfully or not, refer to this link.
Stop the Tomcat server.
Remove or rename the upgrade.properties file under the $NEW_INSTALLER_DIR/apps/exoplatform/gatein/conf folder.
Restart the Tomcat server. Now, go to the next section to do some tests on the upgraded version.