Skip to main content

Add the GitHub integration

The integration gives Astrolabe your GitHub host and the administrator's token. The GitHub tab, the catalog and the dashboard cards need it.

You do it once, as an administrator.

Before you start​

You need a token with repo, read:org and read:user: see Create a GitHub token.

🔧 Add the integration​

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

  2. Under PLATFORM, click Company connections.

  3. On the GitHub card, click Configure. The card says Not configured.

  4. Top right, click Add Token.

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

    FieldWhat to enterExample
    NameA name of your choice, unique in the list. Prefilled with GitHub.GitHub
    HostThe domain name only, no path. Prefilled with github.com. For GitHub Enterprise, its own domain name, exactly as the server answers to it.github.com
    TokenThe administrator's tokenghp_…
    Optional settings › API Base URLLeave empty: github.com needs none, and for GitHub Enterprise https://<host>/api/v3 is filled in on save.
    Optional settings › Raw Base URLLeave empty: for GitHub Enterprise https://<host>/raw is filled in on save.
  6. Click Test connection. The form says Connection works: the source accepted the credentials.

  7. Click Add. The instance restarts.

About 25 seconds later, your token is in the list, with the source Administration and the state Connected.

Same host as the catalog

The Host of the GitHub catalog provider (Administration › Catalog › GitHub) must be the one written here.

✅ That's it!

Next: Show the GitHub tab on a component.