add docs info for auth through github app

This commit is contained in:
msukkari 2025-10-18 16:11:30 -07:00
parent fa8e0d294f
commit b96a35a0be
2 changed files with 6 additions and 0 deletions

View file

@ -33,6 +33,11 @@ The following authentication providers require an [enterprise license](/docs/lic
[Auth.js GitHub Provider Docs](https://authjs.dev/getting-started/providers/github) [Auth.js GitHub Provider Docs](https://authjs.dev/getting-started/providers/github)
Authentication using both a **GitHub OAuth App** and a **GitHub App** is supported. In both cases, you must provide Sourcebot the `CLIENT_ID` and `SECRET_ID` and configure the
callback URL correctly (more info in Auth.js docs).
When using a **GitHub App**, enable the `“Email addresses” account permissions (read)` permission to allow Sourcebot to read the email of the user from GitHub after they authenticate.
**Required environment variables:** **Required environment variables:**
- `AUTH_EE_GITHUB_CLIENT_ID` - `AUTH_EE_GITHUB_CLIENT_ID`
- `AUTH_EE_GITHUB_CLIENT_SECRET` - `AUTH_EE_GITHUB_CLIENT_SECRET`

View file

@ -42,6 +42,7 @@ export const getSSOProviders = (): Provider[] => {
}, },
}, },
})); }));
}
if (env.AUTH_EE_GITLAB_CLIENT_ID && env.AUTH_EE_GITLAB_CLIENT_SECRET) { if (env.AUTH_EE_GITLAB_CLIENT_ID && env.AUTH_EE_GITLAB_CLIENT_SECRET) {
providers.push(Gitlab({ providers.push(Gitlab({