GitHub Enterprise Setup

Updated 4 months ago by Jaala

Overview:

Below is a step-by-step guide on how to connect your GitHub Enterprise account to GitPrime. If your repositories are behind a firewall, please whitelist our IPs first. Here is a link to get you started. This configuration requires a connection via HTTPS over port 443.

We strongly recommend you use a service account to create this Integration. Please see this help document for instructions to create a service account and read more about why service accounts are important here.

Connecting to GitHub Enterprise

There are three ways you can connect to your GitHub Enterprise account:

A.) OAuth - Connecting via OAuth will require you to create an OAuth application in your GitHub account. 

B.) Username/Password - Connecting with your Enterprise login credentials.

C.) Access Token - This will require you to create an access token in your GitHub account. 

Step 1: In order to connect your GitHub Enterprise, you will need to first create a new Integration. Starting on your GitPrime Home page go to the left navigation bar. At the bottom go to Settings then select Integrations.

Step 2: Select the Add Integration button in the top right hand corner of your Integrations screen. 

Step 3: On the following page select GitHub Enterprise from the Integration Provider list and click Next.

Step 4: In this next step you can choose one of the three ways to connect your GitHub Enterprise account. Choose the connection that works best for you. 

A.) OAuth

Connecting via OAuth will require you to first create a new OAuth application in your GitHub Enterprise account. Follow the steps below to get started. 

Step 1: On any page of your GitHub Enterprise, click your avatar in the top right-hand corner. Then, click "Settings".

Step 2: Under Personal Settings click OAuth applications.

Step 3: Under the Developer applications tab click Register a new application.

Step 4: Fill in the “Register a new OAuth appliation” form with the following information.

Step 5: Click Register application.

Step 6a: If you wish to add a logo, save this GitPrime icon (.png below) to your desktop, and drag it into the Drag & drop area.

Step 6b: A window will pop-up, click Set new application image.

Step 7: Navigate back to the OAuth Apps page in your GitHub account. Copy your and into the authorization page in GitPrime as well as your GitHub’s instance base URL.

Make sure you are not blocking pop-ups as you will need to authorize the application.

Step 8: Authorize the application in the pop-up by selecting Authorize application.

Step 9: If your connection was successful you will see the following message:

If you are not able to connect to your account check your Client ID and Client Secret to make sure they are correct and try again. 

Step 10: To finish up your GitHub Enterprise Integration skip down to the Finishing Up section below. 

B.)Username/Password

 Step 1: You can connect to your account using your GitHub Enterprise credentials under the Username/Password tab. Input your credentials and base URL and click Test connection.

Step 2: If the connection was successful you will see the following message:

If you receive the following error when trying to connect your GitHub Enterprise account verify the following and try again:

  • user name and/or password are correct

If you receive the following error when trying to connect your GitHub Enterprise account verify the following and try again:

  • Base URL is correct

Step 3: To finish up your GitHub Enterprise Integration skip down to the Finishing Up section below. 

C.) Access Token

You can connect via an access token. On the Access Token tab input your access token and click Test connection. For more information on where to create an access token in GitHub Enterprise see GitHub’s support document Creating a Personal Access Token.

Step 1: On the Access Token tab input your access token and click Test connection.

Step 2: If the connection was successful you will see the following message:

If you receive an error when trying to connect to your account using an access token verify the access token and base URL and try again. 

Finishing Up

Step 1: Once you have successfully connected to your GitHub Enterprise account, click Next.

Step 2: On the next screen you will be selecting the services you want turned on for this Integration. If you would like to import Ticket and Pull Request data in addition to Repo data, then leave all services on. You can turn services “on” and “off” at any time. Click Next.

Step 3: Name your Integration so you can identify the account you connected with. In this example we named it “Org’s GitHub Enterprise”. Click Create.

Step 4: You have successfully created a new GitHub Enterprise Integration.

Step 5: You can begin to import your repos by clicking repo import page. To learn more about managing your new Integration settings, see Managing Integrations.

Still having problems setting up your GitHub Enterprise account? Email us at support@gitprime.com or click on the chat icon in the bottom right corner of your screen.


How did we do?