Commit0f4f6bd

authored

docs: describe default sign up behavior with GitHub (#16765)

Document the sign up behavior with the default GitHub OAuth2 app.

1 parent9c5d496 commit0f4f6bdCopy full SHA for 0f4f6bd

File tree

+13

-0

lines changed

+13

-0

lines changed

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,19 @@ This access is necessary for the Coder server to complete the authentication`
`15`	`15`	`process. To the best of our knowledge, Coder, the company, does not gain access`
`16`	`16`	`to this data by administering the GitHub app.`
`17`	`17`
	`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`	`+`
`18`	`31`	`For production deployments, we recommend configuring your own GitHub OAuth app`
`19`	`32`	`as outlined below. The default is automatically disabled if you configure your`
`20`	`33`	`own app or set:`

Comments

(0)