* [#73102] Update on migration docs  https://community.openproject.org/work_packages/73102

[#73102] Update on migration docs

https://community.openproject.org/work_packages/73102

* Apply suggestion from @MayaBerd

* Update docs/installation-and-operations/jira-migration/README.md

Co-authored-by: Pavel Balashou <ba1ashpash@gmail.com>

---------

Co-authored-by: Pavel Balashou <ba1ashpash@gmail.com>
This commit is contained in:
Maya Berdygylyjova
2026-03-20 20:40:15 +01:00
committed by GitHub
parent 49d8f4b034
commit 83bfc40271
15 changed files with 86 additions and 6 deletions
@@ -10,7 +10,7 @@ sidebar_navigation:
>
> This page is a work in progress. The OpenProject team is actively developing an upcoming JIRA and Confluence migration tool. Information on this page may change as new migration options become available.
>
> Last edited on: November 11, 2025.
> Last edited on: March 20, 2026.
## Overview
@@ -40,6 +40,91 @@ To support the development of the official migration tool, we are collecting ano
> [!TIP]
> Please reach out to us if you want to donate your data, we will sign an NDA to ensure confidentiality.
#### Current progress
> [!IMPORTANT]
> This section reflects the current state of development as of OpenProject 17.2. The migration tool is still under active development and is not yet production-ready. To test it, you must first enable it in your OpenProject instance adminstration (/admin/settings/experimental).
Navigate to *Administration → Import*. To create a new import configuration, click the **+ Jira configuration** button.
![Jira importer settings under OpenProject administration](openproject_admin_import_jira_import.png)
Provide the following details:
- A name for the import configuration
- Your Jira Server or Data Center URL
- A Personal Access Token. The migration tool requires a token with admin permissions. Otherwise you will get 403 error during the import process.
Click **Test configuration** to verify the connection.
![Define new Jira import in OpenProject adminstration](openproject_admin_import_jira_import_new_config.png)
If the connection is successful, a confirmation banner will appear.
![Successful connection message for Jira import](openproject_admin_import_jira_import_new_config_test.png)
Click **Add configuration** to proceed to the import runs overview. Initially, no import runs will be listed.
![Empty import runs overview after creating a Jira import configuration](openproject_admin_import_jira_import_new_config_import_run_button.png)
Click **Import run** to start a new import. In the *Get base data* section, click **Check available data** to retrieve metadata from your Jira instance.
![Checking available Jira data for import](openproject_admin_import_jira_import_check_data.png)
Once fetched, you will see which data can and cannot be imported. Click **Continue**.
![Overview of available and unavailable Jira data for import](openproject_admin_import_jira_import_data_fetched.png)
Next, select the projects you want to import. Click **Select projects**.
![Select projects button in Jira import configuration](openproject_admin_import_jira_import_data_fetched_select_project_button.png)
In the modal dialog, choose one or more projects and confirm by clicking **Continue**.
![Project selection modal showing available Jira projects](openproject_admin_import_jira_import_select_projects_modal.png)
Click **Start import** to begin the import process.
![Start import button in Jira import workflow](openproject_admin_import_jira_import_start_import_button.png)
A warning dialog will appear. Confirm that you understand the limitations (e.g., incomplete feature coverage, recommendation to avoid production use, and the need for backups). Select *I understand* and click **Start import**.
![Warning dialog before starting Jira import](openproject_admin_import_jira_import_warning_banner.png)
During import, Jira wiki markup is automatically converted to OpenProjects markdown format.
> [!TIP]
> If a user already exists in OpenProject from a previous import, they will not be duplicated.
After the import completes, the data is available in *review mode*. You can:
- Inspect imported projects and work packages
- Validate data integrity
- Decide whether to finalize or revert the import
![Example of an imported work package in review mode](openproject_admin_import_jira_import_imported_work_package_example.png)
To proceed, choose one of the following actions: finalize or revert the import.
![Finalize or revert import buttons in review mode](openproject_admin_import_jira_import_finalize_or_revert_import_buttons.png)
**Finalize import**
- Activates newly created users
- Makes imported data permanent
- Disables the option to revert the import
A confirmation warning will be shown before proceeding.
![Confirmation dialog for finalizing import](openproject_admin_import_jira_import_proceed_import_warning_banner.png)
**Revert import**
- Removes all data created during the current import run
- Does not affect data from previous import runs
A confirmation warning will also be shown.
![Confirmation dialog for reverting import](openproject_admin_import_jira_import_revert_import_warning_banner.png)
> [!NOTE]
> During review mode, any newly created users remain locked until the import is finalized.
### 2. API
Use the [OpenProject REST API](https://www.openproject.org/docs/api) to migrate data programmatically. This option provides full flexibility and supports most OpenProject entities, such as:
@@ -72,12 +157,7 @@ This approach preserves most layout elements and is recommended for documentatio
>
> This approach is only suitable for very few wiki pages. For a comprehensive Confluence migration, consider using our recommended alternative: migrating your Confluence spaces to [XWiki](https://migration.xwiki.com/en/Alternatives/xwiki-vs-confluence ), our open source partner for advanced and large-scale wiki and knowledge-base migrations. XWiki provides a more complete and scalable path when moving extensive Confluence content. [Find out more](https://www.openproject.org/alternative-atlassian-jira-data-center/).
### 5. Community-developed JIRA importer
A community-developed tool, the [OpenProject JIRA Importer](https://github.com/dotnetfactory/openproject-jira-importer) provides additional import capabilities.
It supports importing JIRA issues into OpenProject and is available as open-source software.
Refer to the [JIRA migration community development blog article](https://www.openproject.org/blog/jira-migration-community-development/) for background information and usage guidance.
## Recommended migration workflow
Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 146 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 287 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB