Skip to content

Commit b96a35a

Browse files
committed
add docs info for auth through github app
1 parent fa8e0d2 commit b96a35a

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/docs/configuration/auth/providers.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ The following authentication providers require an [enterprise license](/docs/lic
3333

3434
[Auth.js GitHub Provider Docs](https://authjs.dev/getting-started/providers/github)
3535

36+
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
37+
callback URL correctly (more info in Auth.js docs).
38+
39+
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.
40+
3641
**Required environment variables:**
3742
- `AUTH_EE_GITHUB_CLIENT_ID`
3843
- `AUTH_EE_GITHUB_CLIENT_SECRET`

packages/web/src/ee/features/sso/sso.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ export const getSSOProviders = (): Provider[] => {
4242
},
4343
},
4444
}));
45+
}
4546

4647
if (env.AUTH_EE_GITLAB_CLIENT_ID && env.AUTH_EE_GITLAB_CLIENT_SECRET) {
4748
providers.push(Gitlab({

0 commit comments

Comments
 (0)