diff --git a/develop-docs/integrations/github.mdx b/develop-docs/integrations/github.mdx index 314cb494ca424..e2138d4dc54b4 100644 --- a/develop-docs/integrations/github.mdx +++ b/develop-docs/integrations/github.mdx @@ -3,28 +3,40 @@ title: GitHub Integration sidebar_title: GitHub --- +## Configure ngrok + +`ngrok` allows your local developer environment to be reachable by Github callbacks and webhooks and is needed for the `${url-prefix}` later on in this setup. + +Follow the steps in the [ngrok documentation](/development-infrastructure/ngrok/) to get started. + ## Create a GitHub App To configure the GitHub integration you'll need to create a GitHub app and obtain credentials. Installation will fail if your GitHub App's name contains spaces. +For local development make sure to use your ngrok URL as the prefix. + The GitHub App name and GitHub Org Slug must not contain any spaces. - + Start by following GitHub's [official guide on creating a GitHub App](https://developer.github.com/apps/building-github-apps/creating-a-github-app/). If the form above does not work for you, you need the following settings for your GitHub Application. You'll need to come up with your own webhook secret: -| Setting | Value | -| ------------------------------- | ----------------------------------------------------------------------- | -| Homepage URL | `${url-prefix}` | -| Callback URLs | `${url-prefix}/auth/sso/` and `${url-prefix}/extensions/github/setup/` | -| Setup URL (optional) | `${url-prefix}/extensions/github/setup/` | -| Webhook URL | `${url-prefix}/extensions/github/webhook/` | -| Webhook secret | "my-super-secret-example-secret" | +| Setting | Value | +| -------------------- | ---------------------------------------------------------------------- | +| Homepage URL | `${url-prefix}` | +| Callback URLs | `${url-prefix}/auth/sso/` and `${url-prefix}/extensions/github/setup/` | +| Setup URL (optional) | `${url-prefix}/extensions/github/setup/` | +| Webhook URL | `${url-prefix}/extensions/github/webhook/` | +| Webhook secret | "my-super-secret-example-secret" | When prompted for permissions, choose the following: @@ -34,17 +46,20 @@ When prompted for permissions, choose the following: | Repository / Contents | Read-only | | Organization permissions / members (optional) | Read-only | | Account permissions / Email addresses (optional) | Read-only | +| Repository / Checks | Read & write | +| Repository / Commit Statuses | Read & write | | Repository / Issues | Read & write | | Repository / Pull requests | Read & write | | Repository / Webhooks | Read & write | When prompted to subscribe to events, choose the following: - - Pull Request - - Push +- Pull Request +- Push - Enabling optional permissions will also enable the GitHub SSO for your instance. + Enabling optional permissions will also enable the{" "} + GitHub SSO for your instance. You'll be given various credentials, configure them in `config.yml`: @@ -63,7 +78,8 @@ github-app.webhook-secret: "my-super-secret-example-secret" ``` - If you're receiving invalid application or application not found error, it's suggested to change the `github-app.name` to the correct application slug. + If you're receiving invalid application or application not found error, it's + suggested to change the `github-app.name` to the correct application slug. This can occur if the application includes non-alphanumeric characters.