# GitHub

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

:::

The [GitHub integration](https://docs.getoutline.com/s/guide/doc/github-fSO93uaeYI) 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”](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-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



2. On the GitHub app settings make a note of the last part of the “Public link” field, this is the “app name”.
3. Generate a client secret and make a note of the value.
4. Still on the GitHub app settings generate a private key, the file will be saved to your machine.
5. 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>`

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

   ```javascript
   GITHUB_CLIENT_ID=
   GITHUB_CLIENT_SECRET=
   GITHUB_APP_NAME=
   GITHUB_APP_ID=
   GITHUB_APP_PRIVATE_KEY=
   ```


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

---

**Documents**

- [License restrictions](https://docs.getoutline.com/s/hosting/doc/license-restrictions-f9aq6uEL3H)
- [Requirements](https://docs.getoutline.com/s/hosting/doc/requirements-ULdYnwi4wG)
- [Installation methods](https://docs.getoutline.com/s/hosting/doc/installation-methods-pSvgz9j0QC)
- [Configuration](https://docs.getoutline.com/s/hosting/doc/configuration-509J4lAzjo)
- [Business + Enterprise](https://docs.getoutline.com/s/hosting/doc/business-enterprise-rv0715NxO3)
- [Backups](https://docs.getoutline.com/s/hosting/doc/backups-KZtPOADCHG)
- [Troubleshooting](https://docs.getoutline.com/s/hosting/doc/troubleshooting-HXckrzCqDJ)