Skip to content

docs: describe default sign up behavior with GitHub #16765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2025
Merged

docs: describe default sign up behavior with GitHub #16765

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/admin/users/github-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ This access is necessary for the Coder server to complete the authentication
process. To the best of our knowledge, Coder, the company, does not gain access
to this data by administering the GitHub app.

By default, only the admin user can sign up. To allow additional users to sign
up with GitHub, add the following environment variable:

```env
CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS=true
```

To limit sign ups to members of specific GitHub organizations, set:

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

For production deployments, we recommend configuring your own GitHub OAuth app
as outlined below. The default is automatically disabled if you configure your
own app or set:
Expand Down
Loading