GitHub Enterprise Integration Guide (Via GitHub App)

This guide outlines the steps for setting up a connection to your GitHub Enterprise instance using a dedicated GitHub App for authentication and access.

Step 1: Initiate GitHub App Configuration

1. Navigate to the integration or setup page within your system.

2. Select the "Via GitHub App" option to begin the connection process.

3. Enter your GitHub Enterprise Host Name (e.g., https://github.yourcompany.com or https://github.com) in the designated input field.

4. Click the "Generate Link" button, which will redirect you to the GitHub Developer Settings page to register the App.

Step 2: Register a New GitHub App

1. On the GitHub "Register new GitHub App" page, provide the following details:

• GitHub App Name: Choose a descriptive name (e.g., CloudDefenseApp).

• Description: Add a brief description (e.g., A dedicated integration app for continuous security scanning).

2. Installation Target: Select where the app can be installed, typically "Only on this account" or "Any account" depending on your organizational requirements.

3. Click "Create GitHub App".

Step 3: Note App ID and Generate Private Key

1. Once the App is created, you will be taken to its settings page.

2. Note the App ID displayed under the "About" section. You will need this for the final configuration.

3. Scroll to the "Private keys" section.

4. Click "Generate a private key" and securely download the generated .pem file. This file contains the critical Application Private Key.

Step 4: Install the GitHub App

The app must be installed on the GitHub organization or account you wish to integrate.

1. In the left sidebar of the App settings, navigate to the "Install App" section.

2. Click the "Install" button next to your target account or organization.

3. Review the installation settings:

• Choose to grant access to "All repositories" or restrict it to "Only select repositories" (recommended for targeted use).

4. Click the final "Install" button to complete the installation.

Step 5: Configure the Integration

Return to the integration system's configuration screen.

1. The GitHub Enterprise Host Name should be pre-filled.

2. Enter the GitHub Enterprise App ID (the numeric ID you noted in Step 3).

3. Copy and paste the entire content of the downloaded .pem file into the "Enter Application Private Key" field.

4. Click "Configure" to test and finalize the connection.

Step 6: Verify and Share Integration

1. Upon successful configuration, the status should update to "Connected to GitHub for enterprises".

2. You can now click "Scan applications" to begin onboarding your repositories.

3. If you need to grant other users or teams access to this integration, use the "Share GitHub for enterprises integration" option and select the appropriate team or organization.