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 the regular Confluence distribution, which includes Apache Tomcat as the application server, please refer to Upgrading Confluence instead.

Please also check the following before you start using this guide:

Upgrading to Confluence 5.0?

If so, please review the Confluence 5.0 Release Notes for important information about this version of Confluence.

また、これまでの Confluence の主要バージョンへのアップグレードを省略する場合は、バージョン間で Confluence インストールに影響を与えうる特定の変更があるかもしれませんので、各主要バージョンのアップグレードノートを確認することを強く推奨します。アップグレードノートの概要ページに、最近の Confluence 主要バージョンのアップグレードノートへのリンクがあります。

最後に、サポートするプラットフォームページで、お使いの Java バージョン、オペレーティング システム、アプリケーション サーバー、データベース、ブラウザーが本バージョンの Confluence によりサポートされていることを確認してください。Confluence のサポート終了のお知らせページで、サポートしているプラットフォームについての重要情報が見つかります。

On this page:

作業を開始する前に

Changing your Database?

アップグレードと同時に使用するデータベースを変更する場合は、アップグレードを先に実行することを推奨します。その後、異なるデータベースへの移行に従ってください。

  1. Note that you need current software maintenance to perform the upgrade.
  2. アップグレード開始前に、ライセンスサポートが有効期間内にあることを確認してください。
  3. If your current license has expired but you have a new license with you, please update your license in Confluence before performing the upgrade.
    (warning) 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.
  4. インストールする新しい Confluence のリリースノートと、インストールをスキップするバージョンの中にメジャーバージョンがあった場合はそのメジャーバージョンのアップグレードノートの内容を確認してください。ユーザーの Confluence システムに対して大きな影響のある変更が含まれている可能性もあるため、これらのノートを確認することは重要です。最近の Confluence メジャーバージョンのアップグレードノートは、アップグレードノート概要をご覧ください (各々のアップグレードノートは、対応するリリースノートが親になっています)。
  5. システム環境 (例えば、データベースシステム、オペレーティングシステム、アプリケーションサーバーなど) が引き続き Confluence のシステム要件を満たしていることを確認してください。新しいバージョンは過去のバージョンとはシステム要件が異なる可能性があります。
  6. Confluence EAR-WAR 版をご利用の場合は、Confluence の EAR-WAR 版をインストールで Confluence 実行に必要な追加作業の有無を確認してください。
  7. 外部データベースをご利用の場合は、そのデータベースの既知の問題点をすべて調べておく必要があります。さらに、Confluence のデータベースコネクタープリンシパル (データベースユーザーアカウント) にデータベーススキーマを変更できる権限が付与されていることを確認してください。
  8. Note which plugins are installed and 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 via the 'Plugins' menu in your Administration screens, and selecting Confluence Upgrade Check. This will tell you which plugins have an updated version which is compatible with your target upgrade version. You can also check the respective home pages for these plugins on the Atlassian Plugin Exchange. Once you have confirmed the availability of compatible versions, you should upgrade your plugins after successfully upgrading Confluence.  Please test these first by applying them to the latest Confluence version in a test environment.
  9. Confluence のカスタマイズを行っている場合は、それが最新バージョンにも対応しているか否かを確認してください。例えばレイアウトの変更や自分だけのカスタムテーマの適用を行っている場合は、先にテスト環境でこれらを Confluence 最新バージョンに適用するテストを行っておいてください。Confluence に設定したカスタマイゼーションの内容を確認してください。
  10. ウィルス対策ツールやインターネットセキュリティーツールの中には Confluence アップグレードの障害となるものがあり、アップグレードが成功しないことがあります。お使いのウィルス対策ツールやインターネットセキュリティーツールが過去にそのような問題を起こしたことがある場合やそのような懸念がある場合は、Confluence のアップグレードに進む前にこれらのツールを無効化してください。
  11. アップグレード後に Confluence がインデックスの再構築を行う場合があります。これが起こった場合、アップグレード後のサーバー負荷が増加します。本番環境用途の Confluence をアップグレードする場合は、必ず他のユーザーの利用時間外に行ってください。

バックアップ

Confluence のアップグレードを実行する前に、以下に示すバックアップ作業を行う必要があります:

  1. 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 are using the embedded HSQLDB database supplied for evaluation purposes, the database files are also stored in this directory.
    (tick) 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. (info) The Confluence installer will automatically prompt you to run a backup, storing the files in a .zip archive at the same level as your Confluence Home directory.
  2. 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, simply restore the backup to a different system to ensure the backup worked before proceeding. This recommendation is generally a good best practice. Surprisingly, many companies get in trouble for broken database backups because they skip this basic but vital "smoke test" of the operation.
    (info) 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 Confluence home directory. You should not be using this database for production systems at all, so if you happen to be using HSQLDB in a production system, please migrate to a proper database before the upgrade. Read about the various shortcomings of HSQLDB.
  3. Back up your Confluence Installation directory or your Confluence webapp (if you are using Confluence EAR-WAR edition). (info) The Confluence installer will automatically back up these files, storing the files in a .zip archive at the same level as your Confluence installation directory. 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'.

テスト環境におけるアップグレードテスト

プロダクションサーバーをアップグレードする前に、必ずテスト環境でのテストを実施してください。

 

     1. サーバー間での Confluence の移行に従って、本番環境用 Confluence 環境の現在のスナップショットをテストサーバーに作成してください。

XML インポート

(warning) Importing an old XML backup file to a new major version (for example, Confluence 3.5 to Confluence 4.0) is not recommended. Please recreate your production instance in a test environment first.

      そのクローン環境でアップグレードを実行してください。

      3. 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.

アップグレードの実行

If you are migrating servers or migrating databases, perform those operations in separate steps.

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:

  1. Shut down your existing Confluence instance.
  2. Download the Confluence EAR-WAR zip file: Go to the Download Center, and click 'Show all' to find the EAR-WAR zip file.
  3. 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
  4. 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>.
    • ディレクトリパスのスペースは使用しないでください。
    • You can read more about the Confluence Installation directory.
  5. 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.

    • このラインまでスクロールします：

      # confluence.home=c:/confluence/data
    • 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.
  6. 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).
  7. 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 (Confluence 2.2 以降からアップグレードする場合)

      Upgrading to Confluence 3.5+ and using JIRA user management?

      Please review our KB article first: Upgrade to Confluence 3.5 with JIRA User Management Fails

      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" />
  8. 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.
  9. Restart your application server and start Confluence.
    (info) 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.)
  10. 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.
  11. 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.
  12. 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.
  13. Consider any adjustments you need to make to customisations and special configurations, as described below.

Reapplying Customisations to your New Confluence

ヒント： 以下の手順は、Confluence サーバーおよび/または Confluence のルック アンド フィールに特別な設定を適用している上級 Confluence ユーザー向けのものです。

 

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.
  • Confluence ディストリビューションを使用し、以前にCATALINA_HOME 環境変数を定義していた場合、新しい Confluence Tomcat サーバーが正しいパスを参照しているか確認してください。
  • 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.
  • Tomcat データソースを以前に定義した場合は、新しい <Installation-Directory>\conf\server.xml を編集し、古い 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.
  • 以前に Confluence ソース コードを変更した場合、新しいバージョンに変更を再適用する必要があります。
  • 以前に SSL で Confluence を実行していた場合、「SSL または SSL で Confluence を実行する」で説明されているように設定を再適用する必要があります。
  • 以前に <Installation-Directory>\bin\setenv.sh または <Installation-Directory>\bin\setenv.bat ファイルのいずれかでメモリ フラグ (Xms および Xmx) を変更した場合は、新しいインストールで変更を加えることをお勧めします。パラメーターは JAVA_OPTS 変数で指定されています。
  • If you had changed the Confluence interface text, you will need to pull over the ConfluenceActionSupport.properties file.
  • カスタム SSO 認証を使用していた場合、seraph-config.xml を正しい認証に変更します。

Checking for Known Issues and Troubleshooting the Confluence Upgrade

After you have completed the steps required to upgrade your Confluence installation, check all the items on the Confluence post-upgrade checklist to ensure that everything works as expected. If something is not working correctly, please check for known Confluence issues and try troubleshooting your upgrade as described below:

  • Check for known issues. Sometimes we find out about a problem with the latest version of Confluence after we have released the software. In such cases we publish information about the known issues in the Confluence Knowledge Base. Please check the known issues for the relevant release on this page of the Knowledge Base and follow the instructions to solve the problem.

  • Did you encounter a problem during the Confluence upgrade? Please refer to the guide to troubleshooting upgrades in the Confluence Knowledge Base.

関連トピック

Upgrading Confluence
Upgrading Confluence
Confluence Installation Guide
Important Directories and Files
Site Backup and Restore
Database Configuration

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.