Skip to content

Commit af036b4

Browse files
authored
docs: allow multiple Coder deployments to use single GitHub OAuth app (#8786)
* docs: Add instructions for using the same GitHub OAuth app for multiple Coder deployments * fmt * typo * Update auth.md
1 parent ddabe9c commit af036b4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/admin/auth.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ The following steps explain how to set up GitHub OAuth or OpenID Connect.
1414

1515
First, [register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/). GitHub will ask you for the following Coder parameters:
1616

17-
- **Homepage URL**: Set to your Coder domain (e.g. `https://coder.domain.com`)
18-
- **User Authorization Callback URL**: Set to `https://coder.domain.com/api/v2/users/oauth2/github/callback`
17+
- **Homepage URL**: Set to your Coder deployments [`CODER_ACCESS_URL`](https://coder.com/docs/v2/latest/cli/server#--access-url) (e.g. `https://coder.domain.com`)
18+
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
19+
20+
> Note: If you want to allow multiple coder deployments hosted on subdomains e.g. coder1.domain.com, coder2.domain.com, to be able to authenticate with the same GitHub OAuth app, then you can set **User Authorization Callback URL** to the `https://domain.com`
1921
2022
Note the Client ID and Client Secret generated by GitHub. You will use these
2123
values in the next step.

0 commit comments

Comments
 (0)