• Products
  • Documentation
  • Resources

Connect Jira to GitHub Enterprise Server

This topic covers connections to GitHub Enterprise Server. If you’re connecting a GitHub Cloud account, see Connect GitHub Cloud to Jira.

When you connect a GitHub Enterprise Server to Jira, your team can link their development activity to Jira issues. Use this app to track branches, commits, and pull requests in the context of your Jira issues, on your Jira board, in the releases feature, and more.

Before you begin

To install and set up the GitHub for Jira app, you need:

  • Site administrator permission for your Jira site

  • Owner permission for a GitHub organization

If you’re not familiar with setting up firewall or gateway settings on a GitHub Enterprise Server, you may also need to contact your GitHub Enterprise Server administrator for help preparing your server.

Set up your server’s firewall

Your GitHub Enterprise Server is behind a firewall. Before you can connect to a Jira site, you must open a hole in that firewall to let Jira communicate with your server.

There are two ways to do this:

  1. If your GitHub Enterprise Server has a public-facing URL, you can set up the server’s firewall to allow access from Atlassian IP addresses. Here’s how to set up a GitHub IP allow list

  2. If you would like an additional layer of security, or your GitHub Enterprise Server does not have a public-facing URL, your technical team can create a locked, public-facing gateway using this code template. Once they’ve created this, your technical team will give you the following items that Jira will use to connect to your server:

    1. A server URL for your locked gateway.

    2. A HTTP request header name.

    3. An API key value.

Install the GitHub for Jira app

  1. In Jira, select Apps, then select Explore more apps.

  2. Search for GitHub for Jira, then select it from the results.

  3. Select Get app, then Get it now.

Connect a GitHub Enterprise Server

  1. After the app is installed, select Get started. If the app is already installed on your Jira site, you can find this section by selecting Apps, then Manage your apps, and then GitHub for Jira.

  2. Select Continue.

  3. Select GitHub Enterprise Server, then Next.

  4. Enter your GitHub Enterprise Server URL using the format http(s)://<your-github-enterprise-server-domain. This will be either your server’s public-facing URL, or the URL of the locked gateway provided by your technical team.

  5. If you’re using a locked gateway, enter the HTTP request header name and the API key value provided by your technical team.

  6. Select Next.

Create a GitHub app

Once you’ve connected a GitHub Enterprise Server, you'll need to create an app on that server to manage the flow of data to your Jira site. This app will also control settings such as which repositories are available to your site, and what Jira automations your team can trigger through GitHub commit messages.

Your GitHub Enterprise Server can create this app automatically, or you can create it manually using information provided in Jira. As the outcome is exactly the same regardless of which method you use, we recommend the more convenient automatic method.

Your GitHub Enterprise Server must be running software version 2.19 or higher to automatically create this app. Here’s how to upgrade GitHub Enterprise Server.

  1. Select Automatic app creation. You’ll be redirected to GitHub to automatically create your app.

  2. Give your app a unique name and select Create GitHub App.

  3. Go to http(s)://<your-github-enterprise-server-domain>/settings/apps/<your-github-app-name and update the Homepage URL to include the name of your app.

Create an app manually

If you're creating the app manually, you’ll need to create a GitHub App within your GitHub Enterprise Server account. Learn how to manually create a GitHub app.

Uninstall legacy connections

The GitHub for Jira app covered in this topic replaces the legacy DVCS connector.

If you’re using the DVCS connector, we strongly encourage that you migrate your connection to GitHub for Jira, as the DVCS connector won’t be supported after March 31st, 2024. Read more about migrating to GitHub for Jira.

After you have connected all your GitHub Enterprise organizations to GitHub for Jira, you can remove them from DVCS.

  1. Make sure you have added all your GitHub Enterprise organizations to GitHub for Jira.

  2. Go to Jira Settings, then select Products, then DVCS Accounts.

  3. Select the more actions icon () on the organizations you want to remove from DVCS and select Disconnect.


Additional resources

To learn more or get help setting up and using GitHub for Jira for GitHub Enterprise Server:

Still need help?

The Atlassian Community is here for you.