Skip to content

docs: allow multiple Coder deployments to use single GitHub OAuth app #8786

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 4 commits into from
Jul 31, 2023
Merged

docs: allow multiple Coder deployments to use single GitHub OAuth app #8786

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b0657a
docs: Add instructions for using the same GitHub OAuth app for multip…
matifali Jul 28, 2023
4358f38
fmt
matifali Jul 28, 2023
658af0c
typo
matifali Jul 28, 2023
4e28acd
Update auth.md
matifali Jul 28, 2023
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
Next Next commit
docs: Add instructions for using the same GitHub OAuth app for multip… 
…le Coder deployments
  • Loading branch information
@matifali
matifali authored Jul 28, 2023
commit 7b0657abb0232a9ea78a954b2f36a7fd8525f032
6 changes: 4 additions & 2 deletions docs/admin/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ The following steps explain how to set up GitHub OAuth or OpenID Connect.

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:

- **Homepage URL**: Set to your Coder domain (e.g. `https://coder.domain.com`)
- **User Authorization Callback URL**: Set to `https://coder.domain.com/api/v2/users/oauth2/github/callback`
- **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`)
- **User Authorization Callback URL**: Set to `https://coder.domain.com`

> Note: If you want to allow multiple coder deploymnets hosted on subdomians e.g. coder1.domain.com, coder2.domain.com, to be able to autheticate with same gitHub OAuth app, then you can set **User Authorization Callback URL** to `https://domain.com`

Note the Client ID and Client Secret generated by GitHub. You will use these
values in the next step.
Expand Down