This document will guide you through the steps you must follow to upgrade your older copy of Jive Forums to the latest release.
To upgrade your installation of Jive Forums, start by choosing your current version.
NOTE: If you have custom extensions to Jive Forums (ie, custom user or group integrations or custom filters or interceptors) then you'll need to verify those changes still work and will compile against the Jive Forums 5 APIs. Once you've verified this make sure to copy these extensions into your new 5.x environment. If you fail to do this and, for example, you've written a custom filter you'll get an error on startup when that custom filter class fails to load.
Most upgrades within the 5.5.x series are straightforward. There are no database upgrade scripts needed. The simplest way to upgrade is to deploy the new WAR from the distribution -- this ensures you'll be using all the latest code and latest web files (JSP pages, images, etc). Note, it will be necessary to set the jiveHome directory in the WAR file before deploying it. For more information about setting the jiveHome directory see the rest of the documentation included with this distribution.
Jive Forums versions 5.5.0 and later include changes to wiki markup handling that could cause dramatic differences in how markup from earlier versions is rendered. If you are upgrading directly from 5.0.x versions to 5.5.6 and later, Jive Forums will install a filter that corrects the differences. If not, read on for more details.
If you upgraded from 5.0.x versions to 5.5.0, 5.5.1, 5.5.2, 5.5.3, or 5.5.5 and you're now upgrading to 5.5.6 or later, you'll need to manually install a filter for correctly rendering posts made in earlier versions. Here's the process:
com.jivesoftware.forum.renderer.filter.WikiEscapeFilter
,
then click Add.Be sure to backup your environment (jiveHome and database) before running the upgrade utility.
Upgrades from this version to the latest (5.5.x) are also straightforward. There is an automated framework to help you upgrade. To trigger this, you'll need to update the WAR in your environment (using the same jiveHome and database you had before). Once you've started your application server and you visit your installation's URL you'll be prompted to enter your admin username and password. Once you've authenticated you'll be redirected to an upgrade utility. Follow the directions you see on the screen.
First, backup your existing installation. This includes all application files (the webapp),configuration files (the jiveHome directory) and your database.
Next, put the new jive.license file that was sent to you via email or downloaded from the Jive Software online customer account portal into the jiveHome directory. This is required because the license format has changed for this release of Jive Forums -- a 4.x license won't work. If you're evaluating Jive Forums you can get an evaluation license or you can login to your customer account at Jive Software and download the license. If you have any questions about this please contact us and we'll respond promptly.
There is an automated framework to help you upgrade. To trigger this, you'll need to update the WAR in your environment (using the same jiveHome and database you had before). Once you've started your application server and you visit your installation's URL you'll be prompted to enter your admin username and password. Once you've authenticated you'll be redirected to an upgrade utility. Follow the directions you see on the screen.
Follow the instructions listed in the 4.1 upgrade section. However, before running the 4.1 database upgrade script, you must upgrade your database to the 4.1 version. You can find upgrade scripts in the database/upgrade/xxx directory of the distribution where "xxx" is the name of your database. The script will be named "jive_forums_[database]_upgrade_4_0_to_4_1.sql", where [database] is the name of your database.
Follow the instructions listed in the 4.0 upgrade section. However, before running the 4.0 database upgrade script, you must upgrade your database to the 4.0 version. You can find upgrade scripts in the database/upgrade/xxx directory of the distribution where "xxx" is the name of your database. The scripts will be named "jive_forums_[database]_upgrade_3_2_to_4_0.sql", where [database] is the name of your database.
Follow the instructions listed in the 3.2 upgrade section. However, before running the 3.2 to 4.0 database upgrade script, you must upgrade your database to the 3.2.2 version. You can find upgrade scripts in the database/upgrade/archived directory of the distribution. The script will be named "jive_forums_[database]_upgrade_3_0_to_3_2_2.sql", where [database] is the name of your database.
Follow the instructions listed in the 3.0 upgrade section. However, before running the 3.0 to 3.2.2 database upgrade script, you must upgrade your database to the 3.0 version. You can find upgrade scripts in the database/upgrade/archived directory of the distribution. The script will be named "jive_forums_[database]_upgrade_2_5_to_3_0.sql", where [database] is the name of your database. ! Special Note for Oracle Users: Please read the Oracle upgrade script carefully before executing it. It requires a minor edit to include the username, password and SID you use for your database.