Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0f4f6bd

Browse files
authored
docs: describe default sign up behavior with GitHub (#16765)
Document the sign up behavior with the default GitHub OAuth2 app.
1 parent 9c5d496 commit 0f4f6bd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/admin/users/github-auth.md

+13
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ This access is necessary for the Coder server to complete the authentication
1515
process. To the best of our knowledge, Coder, the company, does not gain access
1616
to this data by administering the GitHub app.
1717

18+
By default, only the admin user can sign up. To allow additional users to sign
19+
up with GitHub, add the following environment variable:
20+
21+
```env
22+
CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS=true
23+
```
24+
25+
To limit sign ups to members of specific GitHub organizations, set:
26+
27+
```env
28+
CODER_OAUTH2_GITHUB_ALLOWED_ORGS="your-org"
29+
```
30+
1831
For production deployments, we recommend configuring your own GitHub OAuth app
1932
as outlined below. The default is automatically disabled if you configure your
2033
own app or set:

0 commit comments

Comments
 (0)