From b96a35a0be18876d785ca0e414a1cfe890632d44 Mon Sep 17 00:00:00 2001 From: msukkari Date: Sat, 18 Oct 2025 16:11:30 -0700 Subject: [PATCH] add docs info for auth through github app --- docs/docs/configuration/auth/providers.mdx | 5 +++++ packages/web/src/ee/features/sso/sso.ts | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/docs/configuration/auth/providers.mdx b/docs/docs/configuration/auth/providers.mdx index ae52ea46..3d3cca0a 100644 --- a/docs/docs/configuration/auth/providers.mdx +++ b/docs/docs/configuration/auth/providers.mdx @@ -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) +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:** - `AUTH_EE_GITHUB_CLIENT_ID` - `AUTH_EE_GITHUB_CLIENT_SECRET` diff --git a/packages/web/src/ee/features/sso/sso.ts b/packages/web/src/ee/features/sso/sso.ts index d32e6f3c..287453d1 100644 --- a/packages/web/src/ee/features/sso/sso.ts +++ b/packages/web/src/ee/features/sso/sso.ts @@ -42,6 +42,7 @@ export const getSSOProviders = (): Provider[] => { }, }, })); + } if (env.AUTH_EE_GITLAB_CLIENT_ID && env.AUTH_EE_GITLAB_CLIENT_SECRET) { providers.push(Gitlab({