GitHub Enterprise Server & Enterprise Cloud with data residency

Installation instructions for self-hosted GitHub Enterprise Server and Enterprise Cloud with data residency

This guide also applies to GitHub Enterprise Cloud with data residency — instances hosted by GitHub at a dedicated *.ghe.com subdomain (e.g. your-company.ghe.com). The setup is the same as self-hosted GitHub Enterprise Server.

1. Create a Swarmia app on GitHub

In your GitHub Enterprise organization settings, select GitHub Apps under Developer Settings. Select New GitHub App.

Fill out the form with the following values:

• GitHub App name: Swarmia

• Homepage URL: https://www.swarmia.com

Identifying and authorizing users

Callback URL: https://app.swarmia.com/auth/github/callback/[your-github-organization-name]

If you don't know exactly what to put as your organization name, don't worry. This is just for an identifier on our side that you'll use to login.

Expire user authorization tokens: ✅

Request user authorization (OAuth) during installation: ✅

Webhook

Active: ✅

Webhook URL: https://hook.swarmia.com/GithubWebhook

Webhook secret: <random-string-with-high-entropy>

Enable SSL verification: ✅

Repository permissions

Organization permissions

Subscribe to events

Create GitHub App

• Where can this GitHub App be installed? Select Any account

• Click Create Github App

After you've created the app, you will see the following message.

Click Generate a private key.

It will take you to the Private keys section. Click Generate a private key button.

swarmia.date.private-key.pem will be downloaded.

After successfully registering your application, you can optionally add a logo to your app. Here is a pre-cropped image you can use:

Make a note of your App ID, Client ID, and Client Secret. you will need those to connect your GitHub Enterprise Server with Swarmia in the next step. App ID and Client ID should be visible and client secret you can generate.

Finally, generate a Client secret, and store it somewhere safe. You'll need that in a bit:

2. Share your settings with Swarmia

You should have acquired App ID, Client ID, Client Secret, Callback URL, Webhook secret and Private key in the previous steps. Share these secrets securely with this Google Form and let your Swarmia contact person know that you're done with this part of the setup.

On GitHub Enterprise Cloud with data residency (*.ghe.com) also share your instance hostname (e.g. your-company.ghe.com) so we can configure the connection on our end.

If you're using a self-signed TLS certificate in your GitHub Enterprise instance please supply a TLS certificate pair to be used by Swarmia as a client certificate when contacting your GitHub Enterprise endpoints.

3. Configure your firewall

If your GitHub Enterprise is behind a firewall you’ll need to allow Swarmia's IP address so we can perform GitHub Enterprise API calls and receive webhooks.

• Inbound IPs (we make HTTPS requests to your GitHub instance): 34.89.165.89 & 35.234.103.84

• Outbound IPs (GitHub makes HTTPS requests to us): 34.117.202.112 (hook.swarmia.com) & 34.107.207.241 (app.swarmia.com)

If you are unable to grant the inbound traffic access, you can use our proxy agent to facilitate access.

4. Install the Swarmia app in organization(s)

After you've completed steps 1, 2, and 3 let Swarmia know you're ready to install the app. We then run the installation on our end, after which you're free to install the Swarmia app to your chosen organization(s). The app can be found at https://[hostname]/github-apps/swarmia where users can install it to their organization(s).

5. Log in

Now you can log in to your Swarmia instance at https://app.swarmia.com/login/[your-github-organization-name]

where the Github organization name is the same one that you used for the Callback URL earlier.