Skip to content

Commit 6d77c01

Browse files
committed
update docs
1 parent 799a0ba commit 6d77c01

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/admin/users/github-auth.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@
55
By default, new Coder deployments use a Coder-managed GitHub app to authenticate
66
users. We provide it for convenience, allowing you to experiment with Coder
77
without setting up your own GitHub OAuth app. Once you authenticate with it, you
8-
grant Coder server read access to:
9-
10-
- Your GitHub user email
11-
- Your GitHub organization membership
12-
- Other metadata listed during the authentication flow
8+
grant Coder server read access to your GitHub user email and other metadata listed
9+
during the authentication flow.
1310

1411
This access is necessary for the Coder server to complete the authentication
1512
process. To the best of our knowledge, Coder, the company, does not gain access
@@ -33,6 +30,15 @@ To limit sign ups to members of specific GitHub organizations, set:
3330
CODER_OAUTH2_GITHUB_ALLOWED_ORGS="your-org"
3431
```
3532

33+
> [!NOTE]
34+
> This requires the default GitHub app to be installed in the organizations you
35+
> want to limit sign ups to. You may install the app by visiting
36+
> [this page](https://github.com/apps/coder/installations/select_target).
37+
>
38+
> However, this will technically grant Coder, the company, access to your
39+
> organization's data as described in the installation flow. We recommend
40+
> configuring your own GitHub OAuth app as outlined below instead.
41+
3642
For production deployments, we recommend configuring your own GitHub OAuth app
3743
as outlined below. The default is automatically disabled if you configure your
3844
own app or set:

0 commit comments

Comments
 (0)