GitHub Enterprise setup

Tags: Flow

Overview:

Below is a step-by-step guide on how to connect your GitHub Enterprise account to Flow.  If your repositories are behind a firewall, please whitelist our IPs on port 443 over HTTPS.  You also need a public DNS record pointing to the IP address that is being exposed for Flow analysis.  This DNS entry should match the TLS/SSL certificate that the server is utilizing.

Important: We strongly recommend you use a service account to create this Integration. Please see How to create a service account for instructions and information about why service accounts are important.

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 Enterprise account. 

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

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

Step 1: In order to connect your GitHub Enterprise, you will need to first create a new integration. Starting on your Flow home page, go to the top navigation bar and click Settings. Using the left navigation under Integrations, click Integrations.


Step 2: Select the Add Integration button in the top right hand corner of you 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 application form with the following information.


Step 5: Click Register application.


Step 6a: If you wish to add a logo, save this Flow 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 Flow as well as your GitHub’s instance base URL.




Tip: 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 Flow’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. Click Create.


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


Step 5: You can begin to import your repos by going to your repo import page. Click the repo import page link. To learn more about managing your new integration settings, see Manage integrations.



back to top


If you need help, please email support@pluralsight.com for 24/7 assistance.