Skip to main content

Create the OAuth app in GitHub

For your users to sign in to Astrolabe with GitHub, GitHub must know Astrolabe: you create an OAuth app there, and it gives you a Client ID and a Client Secret.

You do it once, as an administrator of your GitHub account or organization.

Before you startโ€‹

You need the address of your Astrolabe, as your users open it. Astrolabe's own form gives the address GitHub must call back:

<Astrolabe address>/api/auth/github/handler/frame

๐Ÿ”‘ Create the appโ€‹

  1. In GitHub, open Settings โ€บ Developer settings โ€บ OAuth Apps, then New OAuth App.

  2. Fill in the form:

    FieldWhat to enterExample
    Application nameA name of your choiceAstrolabe
    Homepage URLThe address of your Astrolabehttps://astrolabe.example.com
    Authorization callback URLThe address abovehttps://astrolabe.example.com/api/auth/github/handler/frame
  3. Click Register application.

  4. Copy the Client ID.

  5. Click Generate a new client secret and copy the secret.

This step was not checked on a live instance: the GitHub screens come from Astrolabe's form help, which only names the OAuth app and the address to call back.

โœ… That's it!

Next: Configure GitHub sign-in in Astrolabe.