Configuring GitHub Enterprise

Introduction

This tutorial will guide you through the steps required to connect Roadie to your GitHub org in GitHub Enterprise.

Prerequisites

• Please let the Roadie support team know about your intention to configure GitHub Enterprise so we can enable it on our side.
• You will need to ensure that the GitHub Enterprise instance is available to our IP addresses.

Step 1: Create an OAuth App in GitHub

Create an OAuth App on GitHub and generate a secret key. Keep note of the client ID and secret key.

Step 2: Create a personal access token

Create a personal access token in GitHub with the repo permissions.

Step 3: Configure the GitHub Enterprise secrets

Go to the secrets configuration page in Backstage:

https://<your-tenant>.roadie.so/administration/settings/secrets

And add the secrets for GHE_TOKEN, GHE_CLIENT_ID and GHE_CLIENT_SECRET.

Next steps

Now that a connection to GitHub is established, you can make yourself an admin on Roadie.

To automatically load catalog files from repositories please see how to set up GitHub Discovery

To load users and groups from GitHub Teams please see GitHub teams documentation.