Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
Extend github integration docs (#1235)
Browse files Browse the repository at this point in the history
* Update github.mdx

* Update sso.mdx
  • Loading branch information
lucasra1 authored Jul 9, 2024
1 parent 4f34bb8 commit 3403e0b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
14 changes: 7 additions & 7 deletions src/docs/integrations/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Start by following GitHub's [official guide on creating a GitHub App](https://de
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}` |
| User authorization callback URL | `${url-prefix}/auth/sso/` |
| 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:

Expand Down
14 changes: 8 additions & 6 deletions src/docs/self-hosted/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,14 @@ As of [Sentry 10](https://github.com/getsentry/self-hosted/releases/tag/10.0.1),
If the form above does not work for you, you need the following settings for your GitHub Application:
| Setting | Value |
| ------------------------------- | ----------------------------------------- |
| Homepage URL | `${urlPrefix}` |
| User authorization callback URL | `${urlPrefix}/auth/sso/` |
| Setup URL (optional) | `${urlPrefix}/extensions/github/setup/` |
| Webhook URL | `${urlPrefix}/extensions/github/webhook/` |
| 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" |

<Alert level="warning">
Don't forget to replace all occurances of <code>{'${urlPrefix}'}</code> with your own url prefix.
Expand Down

0 comments on commit 3403e0b

Please sign in to comment.