• Products
  • Documentation
  • Resources

Integrate Jira Software with GitHub Enterprise Server

Use the GitHub for Jira app to integrate Jira and GitHub Enterprise Server. With the app, you can easily track branches, pull requests, commits, builds, and more in Jira to stay up-to-date on your team's development work.

Then, add issue keys in GitHub to view development data in Jira. And use smart commits to automate common tasks like transitioning issues or adding comments.

These instructions are for GitHub Enterprise Server. Read instructions for GitHub Cloud and GitHub Enterprise Cloud

The DVCS connector won’t be supported after March 31, 2024. We strongly encourage you to upgrade to the GitHub for Jira app. Read more about upgrading to GitHub for Jira

Before you begin

  • You need site administrator permissions in Jira.

  • You must be an owner of the GitHub organization you're connecting.

  • Your GitHub Enterprise Server must have a public DNS and path and allow access from GitHub for Jira’s IP range, which may require changes to your firewall settings. How to set up the GitHub IP allow list

API key-based pre-authorization

GitHub for Jira lets you integrate with private GitHub Enterprise Server that can't be accessed via the public internet.

To enable this feature, you’ll set up a public API gateway or a reverse proxy to forward requests to your GitHub Enterprise Server. Subsequently, the Server will perform pre-authorization by examining the configured custom HTTP header to detect a specific “secret” string or API key.

The API key is a secret string that is shared exclusively between the API gateway and the app within your tenancy, adding an extra layer of security to your system. You can set up the API key when configuring GitHub for Jira.

(For inspiration, see our nginx instance sample configuration: github-for-jira/sample-reverse-proxy-nginx.conf at main · atlassian/github-for-jira)

Configure GitHub for Jira

  1. Install the free GitHub for Jira app from the Atlassian Marketplace.

  2. Select Get started. You can also come back to the GitHub for Jira page later by going to Apps > Manage apps > GitHub for Jira.

  3. Select Connect GitHub organization.

  4. Select GitHub Enterprise Server and click Continue.

  5. Enter the URL for your GitHub Enterprise Server account in the format of http(s)://<your-github-enterprise-server-domain and click Next.

Create a GitHub app

Select Automatic app creation or Manual app creation, and click Create.

We recommend automatic app creation, as it’s faster and simpler. All you need to do is name the app, and we’ll use the GitHub API and a manifest file to pre-populate the app creation form for you. However, this does require your GitHub Server to run on version 3.1 or higher. Upgrade GitHub Enterprise Server.

Automatic app creation (recommended)

If you’re creating the app automatically, you’ll be redirected to the automatic app creation page to fill in a few details.

  1. Give your app a unique name and click Create GitHub App.

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

Manual app creation

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.

 


Remove legacy DVCS connection

This step is only applicable if you are migrating from DVCS connector 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 > Products > DVCS Accounts.

  3. Select the icon, on the organizations you want to remove from DVCS and click Disconnect.

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

 

Additional Help