Preparing for Upgrade

This document outlines the steps you need to take to prepare for upgrading your instance of Jive. Ensure you complete the preparations relevant to your current version before you start the upgrade process.

Upgrade Path

If you have a version of Jive from before Jive 7.0, you need to upgrade to Jive 7.0 or Jive 8.0 first before upgrading to Jive 9.0.
You can upgrade to Jive 9.0 from Jive 7.0.x and Jive 8.0.x only. For information on what's changed from 7 or 8 to 9.0, see Learn What's Changed from Jive 7 & 8 to Jive 9 on Thrive.
For Jive Cloud, upgrades are supported only from versions 7.0.x or 8.0.x. Upgrades from versions earlier than 7.0 are not supported.

warning

You must be upgrading from version 4.5.0 or later.

Backup Important Data

Back up your `jiveHome` directory

The jiveHome directory contains crucial information about your environment, including database connection information, logs, cached attachments, your license file, and local system database files (if used). You should back up this directory before upgrading.

Back up your database

Ensure you back up your database before upgrading. The best way to manage database backups is to follow your DBA's recommendations or the advice of your database software. Examples of backup tools include:

MySQL: Use the mysqldump tool
Postgres: Use the pg_dump tool

Configure System Properties

Set system parameters

Set the jive.cookies.secure system property to true or false.
- True: The cookie will only be transferred over HTTPS.
- False: The cookie can be transferred over HTTP.
- If this property is not set, you may not be able to log in to the Admin Console after the upgrade.
Delete the value for the jive.master.encryption.key.node system property. This value will be automatically repopulated after the upgrade. Not deleting it may cause issues if upgrading on a node that was not previously defined as the master node. Verify that this property is deleted from all nodes.

For more information about Jive system properties, see Fine-tuning with system properties.

Prepare for Upgrade Procedures

Remove plugins before upgrading

Before starting your upgrade, remove all installed plugins. For any plugins that are not compatible with the version you're upgrading to, separately upgrade the plugin code or obtain the upgraded versions from their developer, then install them after upgrading Jive.

For more on managing plugins, see Customizing with plugins.

Allow time for search index rebuilding

First, test the upgrade on a staging instance to determine how long the search index rebuild will take. It may take several days, depending on the size and activity of the community. Ensure to allow adequate time for the search index rebuild before deploying the upgrade to production.

For more information on creating a test instance, see Creating test environment for upgrading.

Additional Preparations Based on Version

For 5.0 and 6.0 upgrades: Prepare for the new Jive CLI installer and interface

Jive started enforcing a strict policy on HTTPS certificate checking.
Use jive setup to move your existing configurations into the new unified format.
The HTTPD service now runs on port 8080, a non-privileged port.

For an overview of the CLI installer, see CLI installer overview.

Jive enforces HTTPS certificate checking

Jive will not accept self-signed certificates without adding them to the application Java keystore. If you encounter communication errors between the self-signed application and the Jive server, add the certificate to the Java keystore.

For instructions on certificate installation, see the section below:

Example of Certificate Installation:

Download the certificate:

openssl s_client -connect yourserver.example.com:443 -showcerts > sam.cert

Import it into the local keystore:

/usr/local/jive/java/jre/bin/keytool -import -alias jiveSamCert -file sam.cert -keystore /usr/local/jive/java/jre/lib/security/cacerts

For pre-6.0 upgrades: Add a node for On-Premise Search (optional)

If you are implementing On-Premise Search instead of Cloud Search, add a node for the Search service and ensure it meets the requirements specified in Hardware requirements.

For pre-5.0 upgrades: Add an Activity Engine node and database

If upgrading from a version prior to 5.0, ensure you add a node and database for the Activity Engine. For more information, see Setting up Activity Engine and Setting up new databases before proceeding.