Skip to content

Commit e97a342

Browse files
committed
update docs
1 parent 799a0ba commit e97a342

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

docs/admin/users/github-auth.md

Lines changed: 13 additions & 6 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
@@ -27,7 +24,17 @@ up with GitHub, add the following environment variable:
2724
CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS=true
2825
```
2926

30-
To limit sign ups to members of specific GitHub organizations, set:
27+
You may limit sign ups to members of specific GitHub organizations, but the
28+
GitHub app must be installed in the organizations you want to limit sign ups to.
29+
**This will grant Coder, the company, access to your organizations' data as
30+
described in the installation flow.** In a production environment, we recommend
31+
configuring your own GitHub OAuth app as outlined further below, so all of your
32+
data is kept private.
33+
34+
If you'd like to proceed with the default GitHub app, install it in the
35+
organizations you want to limit sign ups to by visiting
36+
[this page](https://github.com/apps/coder/installations/select_target) and set
37+
the following environment variable:
3138

3239
```env
3340
CODER_OAUTH2_GITHUB_ALLOWED_ORGS="your-org"

0 commit comments

Comments
 (0)