GitHub

This integration is available in all editions from v0.76.0 onwards

The GitHub integration allows previews of issues and pull requests in GitHub within Outline. For example, hovering over a GitHub url will show a preview of the issue status at that url.

Setup

  1. Register a new “GitHub App”, you’ll need to fill out the following fields:

  • Name – “Outline” might make sense

  • URL – It is advisable to choose the address of your Outline installation

  • Callback URL – Use <yourdomain.com>/api/github.callback

  • “Request user authorization (OAuth) during installation” – Make sure this option is checked

  • “Webhooks” – This option can be disabled

  1. On the GitHub app settings make a note of the last part of the “Public link” field, this is the “app name”.

  2. Generate a client secret and make a note of the value.

  3. Still on the GitHub app settings generate a private key, the file will be saved to your machine.

  4. Base64 encode the private key using the following command, where <infile> is the path to the private key that was just downloaded. Make a note of the value in the out file.

    openssl base64 -in <infile> -out <outfile>

  5. Add the configuration to the Outline environment, using the following variable names:

    GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_APP_NAME=
GITHUB_APP_ID=
GITHUB_APP_PRIVATE_KEY=

  1. Restart the server, you should see “GitHub” available under Settings → Integrations