This page last changed on Apr 04, 2007 by ganand.

This document outlines the procedures you need to follow to upgrade from one version of Confluence to another. You can download the latest version of Confluence from here.

Before you begin
Always check the release notes for the version of Confluence you are installing for upgrade instructions specific to that version.
Only users with valid licence may perform the upgrade.

Step One: 1. Backing up

We strongly recommend that you backup your Confluence home and install directories. If you are using an external database, you should perform a manual database backup before proceeding.

Things you need to backup

  • Confluence Home Directory
  • Your database - If you are not using the embedded database
  • osuser.xml - If you running Confluence 2.0 or earlier and have your user management delegated to JIRA or any other user management system.
    The osuser.xml file is located in the WEB-INF/classes directory.
  • server.xml- If you are running Confluence Standalone, and have modified your server.xml file (for example to add a datasource).
    The server.xml file is located in the Conf directory.
  • WEB-INF/lib directory - If you have deployed any themes, macros or other plugins.


Step Two: Things you need to check ...

  • Check out the Configuration Guide for your application server and database, to make sure there isn't anything extra you need to do to get Confluence running
  • Especially, Resin 3 users should remember they need to update web.xml

Step Three: Performing the upgrade

Please note, if you are upgrading from a 1.x version to a 2.x version of Confluence, you must use Method Two.

There are two ways to perform the upgrade:

Method One

Pointing the new webapp to existing Confluence home
  1. unzip the new release into a new directory (e.g. 'confluence-2.4.3-std').
    If you have downloaded the WAR version and are using Tomcat, you need to update either your confluence.xml or server.xml to point to the location of the new version. Else, if you have deployed Confluence by copying it to your Tomcat webapps directory, please do not copy the new version over your existing install, as this may cause old files from previous versions to be left behind causing unpredictable problems. Instead, remove the old version first from webapps and then copy the new one in.
  2. change the confluence-init.properties file to point to your existing confluence home directory (make sure you've already backed this up)
  3. if you are not using the embedded database, remember to copy over the jdbc driver jar. In a stand-alone configuration, it needs to go in confluence-X.Y.Z-std/common/lib.
  4. restart the application server
    This method is the most convenient and will allow you to reuse your existing Confluence home directory and database.

Method Two

Exporting and Restoring to a Brand New Instance
  1. From Confluence, go to Administration -> Backup & Restore and create a manual backup that includes attachments.
  2. Create the new, separate install directory. We recommend including the version number in the install directory ie ..\confluence<VERSION> and that users avoid putting spaces in the install path. Windows users may wish to use C:\confluence\conf2.2.0 (set it to the version you downloaded).
  3. Download the Confluence standalone version and setup a new installation of Confluence, create a new clean database and proceed with setup wizard.
  4. when asked to restore existing data, specify the backup created in step 1
  5. if you have made modifications to your osuser.xml file, this is the time to shutdown your confluence instance, copy the osuser.xml file into the WEB-INF/classes directory and start up Confluence.
    • If you are unsuccessful with upgrading using the first method outlined above, you may give this approach a go. Occasionally, starting afresh will fix the problem.
    • If you are upgrading from a version older than 2.0, we recommend using this method to obtain significant performance improvements from indexes we added in the 2.0 release (these indexes will not get added if you upgrade using the first method)


Post-install Notes

  • If you're happy with the new version, you can remove the old Confluence directory.
  • If you have delegated user management to JIRA and are running Confluence 2.0 or earlier, read the release notes to see if osuser.xml has been updated. If it has, you will have to move your changes over from your old osuser.xml to the new one or copy your old osuser.xml into the WEB-INF/classes directory and just override the one there.
  • Remember to restore the server.xml or plugin jar files you backed up earlier.
  • If you have previously installed Confluence/Tomcat as a Windows service, you may have to uninstall and reinstall the service, as described here.
  • If you're using AtlassianUser LDAP integration, remember to copy over your old atlassianUserContext.xml file over to the confluence/WEB-INF/classes in the new version.
  • You should re-download the latest version of each plugin you are using from the Confluence Extension space
RELATED TOPICS


Upgrade (text/xml)
Upgrade (text/xml)
Document generated by Confluence on May 01, 2007 19:29