Skip to main content

Configure GitHub sign-in in Astrolabe

You give Astrolabe the Client ID and Client Secret of your GitHub OAuth app. Then the sign-in page offers Continue with GitHub.

You do it once, as an administrator.

Before you start​

You need the Client ID and Client Secret of the app: see Create the OAuth app in GitHub.

🔧 Install the GitHub provider​

  1. In the left sidebar, at the bottom, click Administration.

  2. Under PLATFORM, click Authentication. The Providers tab opens.

  3. On the GitHub card, click the switch at the top right of the card. The Configure GitHub window opens.

  4. Fill in the form. Each ? next to a label explains the field.

    FieldWhat to enterExample
    Client IDThe Client ID of your OAuth appOv23li…
    Client SecretThe client secret of the app0123…
    Entreprise Instance URLLeave empty. For GitHub Enterprise only: its full address with https://.https://github.example.com
    Callback URLLeave empty: Astrolabe uses <Astrolabe address>/api/auth/github/handler/frame.

  5. Click Install. The instance reloads.

When the page is back, the GitHub card shows its switch on, with a Configure button. A warning above the cards says Nobody can sign in with GitHub yet: an account must be in the catalog first. until the next section is done.

👥 Import the members​

Signing in with GitHub only works for an account Astrolabe already knows. You import the members of your GitHub organization into the catalog.

  1. In the warning, click Open Catalog › GitHub. The Catalog page opens.

  2. On the GitHub card, click Configure. The Configure GitHub window opens.

  3. Fill in Organization with the name of your GitHub organization.

  4. Tick Import GitHub members and teams.

  5. Click Install. The instance reloads.

  6. Go back to Administration › Authentication: the warning is gone.

Steps 3 to 6 were not checked on an instance connected to a real GitHub organization.

The token of your GitHub connection needs the read:org and read:user scopes. The other fields are described in Import your GitHub repositories.

✅ That's it!

Next: Sign in with GitHub.

🔌 Turn GitHub sign-in off​

  1. In Administration › Authentication, click Configure on the GitHub card.

  2. Click Uninstall. The instance reloads, without asking for confirmation.

The Continue with GitHub button leaves the sign-in page.