GitHub links
GitHub links
Breadcrumbs

Migration path from On-Premises to the Cloud for GitHub links for Confluence

This documentation explains how to migrate from GitHub links for Confluence Data Center to GitHub links for Confluence Cloud using Atlassian Migration Assistant.

Migration Assistant support is now available

Migration assistance is available for GitHub links for Confluence. When you migrate your Confluence content using Atlassian Migration Assistant, existing GitHub macros are carried over automatically as part of the migration process.

GitHub links for Confluence Cloud supports the URL parameter format previously used by the Data Center app. This means that migrated links and their existing configuration can continue to work in Cloud without requiring manual changes.

Prerequisites

Before you start, make sure you have:

Migration Steps

Before migrating your Confluence content, ensure that GitHub links for Confluence (Cloud) is installed on your Confluence Cloud instance.

For the full setup procedure, see the GitHub links for Confluence (Cloud) setup guide.

Step 2. Migrate your Confluence content to Cloud

Use Atlassian Migration Assistant to migrate your Confluence content from Data Center to Cloud.

On Confluence Data Center, go to Confluence administration → General configuration → Migration Assistant and run the migration for the required spaces, pages, users, and attachments.

During the migration, existing GitHub links and their associated configuration are carried over automatically.

After the migration is complete:

  • Your pages, spaces, and attachments are available in Confluence Cloud.

  • Existing GitHub links are migrated automatically.

  • The URL parameters used by the Data Center app continue to be supported in Cloud.

  • You do not need to manually recreate migrated links or reconfigure their existing URL parameters.

Step 3. Review your migrated content

After completing the migration, review your migrated Confluence content to confirm that your GitHub links are displayed and working as expected.

GitHub links for Confluence Data Center uses URL parameters appended to the end of the URL to configure how links are displayed.

In GitHub links for Confluence Cloud, configuration options are available in a separate configuration section. However, Cloud also supports the legacy URL parameter format used by the Data Center app.

As a result, after migration, you can continue using the existing URL parameters from Data Center or use the separate configuration options available in Cloud for new or updated links.

Important considerations

  • Configuration options.
    The configuration experience differs between Data Center and Cloud:

    • Data Center: Configuration is specified using URL parameters appended to the end of the GitHub URL.

    • Cloud: Configuration options are available in a separate configuration section.

  • For migrated content, the existing Data Center URL parameters remain supported in Cloud. You can therefore leave migrated links unchanged or use the Cloud configuration options where appropriate.

  • Feature parity.
    Before migrating, review any differences between the Data Center and Cloud versions to understand the available features and configuration options.

  • Authentication model.
    The authentication options differ between the Data Center and Cloud versions of GitHub links for Confluence.

    • Data Center: Connects to GitHub using a Personal Access Token (PAT).

    • Cloud: Supports both a GitHub App connection and a Personal Access Token connection. The GitHub App is the recommended connection method.

    Both versions use a global, administrator-level connection; per-user connections are not supported.

    After migrating to Cloud, review your GitHub connection and configure the authentication method that best suits your environment. If you use the GitHub App, you can also control which organisations and repositories the app can access through its GitHub configuration.

Note: A Cloud connection must be configured independently after migration. The authentication credentials and connection configuration from the Data Center instance are not carried over as part of the content migration.

Need help?

If you have any questions or need help with your migration, please contact our Support Team. Our dedicated team can answer your questions and guide you through the migration process.