Confluence Docs 3.0 : Upgrading Confluence EAR-WAR Distribution This page last changed on Jul 24, 2009 by ggaskell. This document tells you how to upgrade from one version of Confluence to a later version.
| These instructions apply to: The EAR-WAR Distribution of Confluence, deployed on your own existing application server. If you want to upgrade your Confluence Standalone distribution, which includes Apache Tomcat as the standalone application server, please refer to Upgrading Confluence Standalone Distribution. Also, please check the new version of Confluence which you are installing. Refer to the documentation home page to verify the latest Confluence version and to find documentation for older versions.
| Upgrading to Confluence 3.0.2? If so, please review the Confluence 3.0.2 Upgrade Notes for important information about this version of Confluence. Also, it is strongly recommended that you check the upgrade notes for every major version of Confluence that you are skipping, since there might be specific changes between Confluence versions that could affect your Confluence installation. The upgrade notes pages for recent major versions of Confluence are accessible from the Upgrade Notes Overview page.
On this page: Before you Start Backing Up Testing the Upgrade in a Test Environment Performing the Upgrade Reapplying Customisations to your New Confluence Troubleshooting the Confluence Upgrade
| Upgrading a Cluster or Changing your Database? If you are running Confluence on a cluster, please see Upgrading a Confluence Cluster instead of this document. If you are planning to change to a different database, we recommend that you complete the Confluence upgrade first. Then follow the instructions on migrating to a different database.
# Before you Start Note that you need current software maintenance to perform the upgrade. Confirm that your license support period is still valid before you try to upgrade. If your current license has expired but you have a new license with you, please update your license in Confluence before performing the upgrade. If you forget to do this and your license has expired, you will receive errors during the upgrade process. Refer to the instructions on upgrading beyond current license period. Check the release notes for the new version of Confluence you are installing, plus the upgrade notes for any major versions you are skipping. It is important to read these upgrade notes as there might be specific changes between Confluence versions that could affect your Confluence instance. The upgrade notes pages for recent major versions of Confluence are accessible from the Upgrade Notes Overview page. (Each upgrade notes page is a 'child' of its respective release notes page.) If you are upgrading from a version of Confluence prior to 2.5.5, the upgrade notes information is located under a heading on the release notes pages. Make sure that your environment (e.g. the database system, the operating system, the application server and so on) still complies with the Confluence System Requirements. A newer version of Confluence may have different requirements than the previous version. If you are using Confluence EAR-WAR edition, check Installing the Confluence EAR-WAR Edition for your specific application server, to see if there is anything extra you will need to do to get Confluence running. For example: Resin 3 users will need to update web.xml. If you are using an external database, familiarize yourself with all known issues for your specific database. Also make sure the Confluence database connector principal (the database user login) has sufficient permissions to modify the database schema. Note which plugins are installed/enabled on your current Confluence instance. Please verify whether a compatible version of the plugin is available in the version of Confluence you are upgrading to. This information is available on the respective home pages for these plugins on the Confluence Extension space. Once you have confirmed the availability of compatible versions, you should upgrade your plugins after successfully upgrading Confluence. This can be done via the 'Plugin Repository' in your Administration Console. Please test these first by applying them to the latest Confluence version in a test environment. If you have made any customisations to Confluence, please verify their compatibility in the latest version. For example, if you have modified any layouts or are using your own custom theme, please test these first by applying them to the latest Confluence version in a test environment. # Backing Up Before you begin the Confluence upgrade, you must back up the following: Back up your Confluence Home directory. The Confluence Home directory is the folder where Confluence stores its configuration information, search indexes and page attachments. If you're using the embedded HSQLDB database supplied for evaluation purposes, the database files are also stored in this directory. Tip: Another term for 'Home directory' would be 'data directory'. The location of the Home directory is stored in a configuration file called `confluence-init.properties`, which is located inside the `confluence/WEB-INF/classes` directory in your Confluence Installation directory. Back up your database. Perform a manual backup of your external database before proceeding with the upgrade, and double check that the backup was actually created properly. If you are not a database expert, or unfamiliar with the backup-restore facilities of your database, you should try to restore the backup to a different system to ensure the backup worked, before proceeding. This recommendation is not specific to Confluence usage but just common sense: Surprisingly many companies, even banks, get in trouble for broken database backups. The 'embedded database' is the HSQLDB database supplied with Confluence for evaluation purposes, you don't need to back it up since it is stored in the home directory. But you should not use this database for production systems anyway, so if you happen to accidentally still use HSQLDB in a production system, please migrate to a proper database before the upgrade. Back up your Confluence Installation directory (if you are using Confluence Standalone) or your Confluence webapp (if you are using Confluence EAR-WAR edition). The 'Confluence Installation directory' is the directory into which the Confluence application files and libraries have been unpacked (unzipped) when Confluence was installed. Confluence does not modify or store any data in this directory. This directory is also sometimes called the 'Confluence Install directory'. # Testing the Upgrade in a Test Environment
| Be sure to test the upgrade in a test environment before proceeding on your production server.
5. - Create a snapshot of your current production Confluence environment on a test server, as described in the page on Moving Confluence Between Servers. Perform the upgrade on your cloned environment. Test all your unsupported plugins and any customisations with the new version before proceeding on your production server. You can read more about supported and unsupported plugins. # Performing the Upgrade The upgrade process allows you to unzip the new Confluence installation into a directory of your choice and then edit the configuration files to point your new installation to your existing data files. Follow these instructions: Shut down your existing Confluence instance. Download the Confluence EAR-WAR zip file: Go to the Download Centre, and click 'Show all' to find the EAR-WAR zip file. If you are on Windows, please check your unzip program before extracting the downloaded zip file. Some archive-extract programs cause errors when unzipping the Confluence zip file. You should use a third-party unzip program like 7Zip or Winzip. If you do not have one, please download and install one before continuing: 7Zip — Recommended. If in doubt, download the '32-bit.exe' version Winzip Use your unzip program to unzip the installation file. You should now have a new directory called `confluence-<version>`. In the rest of this document, we will refer to this as the `<Installation-Directory>`. Do not use spaces in your directory path. You can read more about the Confluence Installation directory. Edit the `confluence-init.properties` file found at: `<Installation-Directory>\confluence\WEB-INF\classes\confluence-init.properties` and update '`confluence.home`' to point to your existing Confluence Home directory. Make sure you have first backed up your Home directory. Open the `confluence-init.properties` file in a text editor such as Notepad. Scroll to the bottom and find this line:
         # confluence.home=c:/confluence/data
7. - Remove the '#' and the space at the beginning of this line, so that Confluence no longer regards the line as a comment. The line should now begin with `confluence.home`. Update the directory name after the `=` sign, to point to your existing Confluence Home directory. If you are using Tomcat, you need to update either your `confluence.xml` or `server.xml` (depending on where you have defined the Confluence context descriptor) to point to the location of the new Confluence installation (also remember to copy over any customisations such as a tomcat datasource if you have one). If you have delegated your user management to JIRA, LDAP or any other external user management system, copy the following files from your old Confluence installation to your new Confluence installation: `<Installation-Directory>/confluence/WEB-INF/classes/osuser.xml.` `<Installation-Directory>/confluence/WEB-INF/classes/atlassian-user.xml` (if you are upgrading from Confluence 2.2 or later).
     | If you are upgrading from an earlier version of Confluence (2.5.5 and earlier) and are copying your existing `atlassian-user.xml` file from your previous instance, please ensure that the hibernate cache parameter in this file has been enabled, to avoid performance related issues. (NOTE: If you use Crowd for your user management, you do not need to do this.):
         <hibernate name="Hibernate Repository" key="hibernateRepository"  description="Hibernate Repository" cache="true" />
If you have delegated your user management to Crowd, you will also need to copy the Crowd client library and configuration files from your old Confluence installation to your new Confluence installation: `<Installation-Directory>/confluence/WEB-INF/lib/crowd-integration-client-X.X.X.jar` and `<Installation-Directory>/confluence/WEB-INF/classes/crowd.properties`. If you need more information, please refer to the Crowd documentation. Restart your application server and start Confluence. Please note that Confluence will need to re-index attachments and this can take 5-10 minutes. Please wait until Confluence has finished indexing the attachments before trying to access Confluence via your web browser. (There is no easy and quick way to determine if the indexing process is completed. Please wait for approximately 10 minutes after the server start up before accessing Confluence via a web browser.) During the startup process Confluence will create any missing database indexes. If you created any database indexes on your own, please check those afterwards and remove those that duplicate the indexes added by Confluence. Just in case you run into any errors which prevent Confluence from starting up, you can set the system property `hibernate.hbm2ddl.skip_creating_missing_indexes` to `true` to skip automatic index creation. Visit Confluence in your web browser and log in using a username from your previous Confluence installation. You should be able to log in immediately, without seeing the Setup Wizard. Take a quick look around your Confluence site to confirm that all your spaces and pages are present and everything looks normal. You should see the new Confluence version number in the page footer. Consider any adjustments you need to make to customisations and special configurations, as described below. # Reapplying Customisations to your New Confluence
| Hint: The steps below are for advanced Confluence users, who have applied special settings to their Confluence server and/or Confluence look and feel
After upgrading your Confluence installation to a later version of Confluence, you need to consider any customisations you have applied to your system and other special configurations: If you had previously installed Confluence/Tomcat as a Windows service, uninstall the service (to ensure that the old Confluence cannot start automatically when the server restarts) and reinstall the new one. For details please see Start Confluence automatically on Windows as a Service. If you are using a Standalone Edition of Confluence and you have previously defined a CATALINA_HOME environment variable, please check that it points to the correct path for the new Confluence Tomcat server. If you had previously connected your Confluence installation to an external database via a JNDI datasource or you implemented SSL, edit your new `web.xml` file and and copy over any relevant modifications from your old `web.xml` file, which relate to these customisations. If you were previously running Confluence on a non-standard port, edit your new `<Installation-Directory>\conf\server.xml` file as described in Change listen port for Confluence Standalone. If you had previously defined a Tomcat datasource, edit your new `<Installation-Directory>\conf\server.xml` and copy over the datasource definition from your old `server.xml`. If you were previously using any plugins, install the latest compatible version and disable any plugins that are incompatible with your new version of Confluence. The easiest way to do this is to use the Plugin Repository in the Confluence Administration Console. If you are using any customised themes, please check that they are displaying as expected. Some further customisation may be required to ensure compatibility with your new version of Confluence. If you had previously customised the default site or space layouts, you will need to reapply your changes to the new defaults as described here. If you had previously modified the Confluence source code, you will need to reapply your changes to the new version. If you were previously running Confluence over SSL, you will need to reapply your configuration as described in Adding SSL for Secure Logins and Page Security. If you had previously modified the memory flags (`Xms` and `Xmx`) in either the `<Installation-Directory>\bin\setenv.sh` or the `<Installation-Directory>\bin\setenv.bat` file, you may want to make the modifications in your new installation. The parameters are specified in the `JAVA_OPTS` variable. If you had changed the Confluence interface text, you will need to pull over the ConfluenceActionSupport.properties file. If you were using a custom SSO authenticator or the utility to Automatically Add LDAP users to the confluence-users Group, change seraph-config.xml to the correct authenticator. # Troubleshooting the Confluence Upgrade Refer to Troubleshooting Upgrades from the Confluence Knowledge Base. ##### RELATED TOPICS Upgrading Confluence Upgrading Confluence Standalone Distribution Confluence Installation Guide Important Directories and Files Site Backup and Restore Database Configuration Attachments: Upgrade (text/xml)

Document generated by Confluence on Nov 05, 2009 23:34