RoadieDocs

Installing the GitHub App

Published on March 21st, 2022

Introduction

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

Prerequisites

If your IT department filters your outbound access by hostname, you may need to allow access to Roadie hostnames before proceeding. More information on this can be found here.

Step 1: Install the Roadie GitHub app

Installing the GitHub App will allow Roadie to access the YAML metadata files that Backstage needs to operate. Learn more about the permissions required.

  1. Click the Administration link in the bottom left of the application.

A link that says "Administration"

  1. Click the Settings tab along the top of the Administration page.

A link that says "Settings"

  1. Click on Integrations in the left sidebar.

A link that says "Integrations"

  1. Open the GitHub accordion and click “Add GitHub App”

A button that says "Add GitHub App"

  1. Choose your GitHub organization and follow the steps to install the app.

⚠️  You may need to wait up to 2 minutes for the GitHub integration to become active.

ℹ️  If you are not an owner of your GitHub organization, you will need to ask an owner to approve the App installation and then contact us to enable the App.

ℹ️  To enable the github-org processor, please navigate here.

ℹ️  To enable the github-discovery processor, please navigate here.

Next steps

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