To set up Flow Enterprise to work with GitHub Cloud, Flow Enterprise requires that an OAuth integration be configured in your GitHub account. It is recommended that you consider creating a "server user" account that has access to all of the teams and repositories in the organizations you wish to analyze. You should then use that user to configure the OAuth integration.
- Go to https://github.com and login as a user that has access to modify the account.
- Navigate to the settings for the organization you wish to integrate by first clicking on your account menu in the top-right of the application and going to Settings.
- You will now see a larger set of settings options. At the bottom, there will be a list of organizations. Please choose the organization you want to integrate with GitPrime Enterprise.
- You will be shown a list of organization settings. At the bottom, under Developer Settings you will see OAuth Apps. Click OAuth Apps to reach the list of OAuth Applications that have been integrated with the organization, then click Register a new application button.
- You will now be asked to enter the details of the new OAuth application. The fields on the form should be filled out according to these guidelines:
- Application Name: Flow Enterprise Integration If you have multiple Flow Enterprise Integrations, name them per department, i.e. "Flow Enterprise: Core System Developers."
- Homepage URL: This is the root URL of your Flow Enterprise instance. For example, https://flow.mycompany.com
- Application Description: A more verbose description of the integration.
- Authorization Callback URL: This is the URL that GitHub will redirect the user browser to after OAuth authentication has been performed. This should be on the format of https:///accounts/complete/github/. For example, if your Flow Enterprise instance is at flow.mycompany.com, you would enter: https://flow.mycompany.com/accounts/complete/github/.
- Once you have filled out the data, click Save. You will now see a detailed page about your integration. It will show you a Client ID and Client Secret. Navigate to the Flow Enterprise Administration Console (see Configuring Flow Enterprise) and enter this key/secret pair in the GitHub Settings section. Click Save and allow Flow Enterprise to restart. At this point, GitHub functionality should be enabled.
- To connect GitHub Enterprise to GitHub, browse to the Repos section under My Data. Click Add Repos and choose GitHub. You will be asked to connect to GitHub if you have not already done so. Click Connect GitHub button to continue.
- You will now be forwarded to GitHub for OAuth confirmation. You will be asked to login to GitHub (if you are not already). You will then be asked to confirm the integration. Clicking Authorize will return you to Flow Enterprise where you will now be able to import repositories to Flow.
If you need help, please email firstname.lastname@example.org for 24/7 assistance.