GitHub Cloud Setup for Workbench

This procedure is specifically for cloud-hosted GitHub deployments. For on-prem, refer to GitHub Self-Hosted (On-Prem) Setup for Workbench.

Prerequisites

You must have:

1. A GitHub Enterprise account license. For more information, see GitHub's products.

Step 1: Install the Cloud-Hosted GitHub App

Expel uses a GitHub App as part of the onboarding process. During installation, the Expel GitHub App receives the following organization-level privileges:

• Administration: Read-Only
• Members: Read and Write

1. Go to the ExpelGitHubIntegration installation and select Configure.
2. Follow the steps to install the application within the GitHub organization you want to onboard.
3. Copy the installation ID from the URL in your browser’s address bar for use later in this process. It is the number sequence at the end of the URL after the last /.

Step 2: Add GitHub as a Security Device in Workbench

If you have multiple organizations, create a separate security device in Workbench for each organization.

Now that you have the correct access configured and noted the credentials, you can integrate your tech with Workbench.

1. In a new browser tab, log in to https://workbench.expel.io/settings/security-devices?setupIntegration=github.

   
2. For Where is your device? select Cloud.
3. Complete these fields using the credentials and information from Step 1:

   • Name - enter the name of your GitHub organization.
   • Location - enter "Cloud".
   • Organization name - enter the name of your GitHub organization.
   • Enterprise slug - enter the enterprise slug URL. This is only required if you use an enterprise SAML identity provider; otherwise you can leave it blank.
   • Application Installation ID - enter the installation ID from Step 1.
4. Leave the other fields blank.
5. Click Save.

Your device should be created successfully within a few seconds. A few reminders:

• After your connection is healthy, it will take some time for your device to begin polling and receiving data.
• To check on the status, select the downward arrow for your device in the first column and choose View details.
• Polling will happen first; data will be received after that. You must refresh the page to see updates.
• If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, contact our support team for help.
• To check if alerts are coming through, navigate to Dashboards > Alert Analysis. Scroll to the device you want to check, and select the Expel Alerts tab to reveal more alert information. It can take 36 to 72 hours for alerts to appear after setup, as we tune your device.

Step 3: Update your GitHub Logs to Record/Display IP Addresses

While not required, consider updating your GitHub audit logs to record/display IP addresses. These addresses are not automatically logged in GitHub. This is a key field when the SOC analysts investigate GitHub activity. Follow these instructions to set this up.