From 0f4f6bd147799fd31aec38409692c0406d57f002 Mon Sep 17 00:00:00 2001 From: Hugo Dutka Date: Mon, 3 Mar 2025 13:23:12 +0100 Subject: [PATCH] docs: describe default sign up behavior with GitHub (#16765) Document the sign up behavior with the default GitHub OAuth2 app. --- docs/admin/users/github-auth.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/admin/users/github-auth.md b/docs/admin/users/github-auth.md index 1bacc36462..21cd121c13 100644 --- a/docs/admin/users/github-auth.md +++ b/docs/admin/users/github-auth.md @@ -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: