Skip to content

docs: update the GitHub Auth section #17769

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 9 commits into from
May 29, 2025
Merged

docs: update the GitHub Auth section #17769

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e97a342
update docs
hugodutka May 12, 2025
10a130d
Merge branch 'main' into hugodutka/github-auth-org-docs
EdwardAngert May 28, 2025
87f5dfa
Apply suggestions from code review
EdwardAngert May 28, 2025
70c2548
reorganize github-auth
EdwardAngert May 28, 2025
bf646fe
reorganize github-auth
EdwardAngert May 28, 2025
e5c7ee3
Apply suggestions from code review
EdwardAngert May 29, 2025
cdf3d71
Merge branch 'main' into hugodutka/github-auth-org-docs
EdwardAngert May 29, 2025
cea427b
edit limit sign-ups step
EdwardAngert May 29, 2025
9bb8e5f
add step numbers
EdwardAngert May 29, 2025
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
Prev Previous commit
add step numbers
  • Loading branch information
@EdwardAngert
EdwardAngert committed May 29, 2025
commit 9bb8e5f0c4489d284eec10426f4a16be23f04041
34 changes: 17 additions & 17 deletions docs/admin/users/github-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,30 @@ CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE=false

## Step 1: Configure the OAuth application in GitHub

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:
1. [Register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).

- **Homepage URL**: Set to your Coder deployments
[`CODER_ACCESS_URL`](../../reference/cli/server.md#--access-url) (e.g.
`https://coder.domain.com`)
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
1. GitHub will ask you for the following Coder parameters:

If you want to allow multiple Coder deployments hosted on subdomains, such as
`coder1.domain.com`, `coder2.domain.com`, to authenticate with the
same GitHub OAuth app, then you can set **User Authorization Callback URL** to
the `https://domain.com`
- **Homepage URL**: Set to your Coder deployment's
[`CODER_ACCESS_URL`](../../reference/cli/server.md#--access-url) (e.g.
`https://coder.domain.com`)
- **User Authorization Callback URL**: Set to `https://coder.domain.com`

Take note of the Client ID and Client Secret generated by GitHub. You will use these
values in the next step.
If you want to allow multiple Coder deployments hosted on subdomains, such as
`coder1.domain.com`, `coder2.domain.com`, to authenticate with the
same GitHub OAuth app, then you can set **User Authorization Callback URL** to
the `https://domain.com`

Coder will need permission to access user email addresses. Find the "Account
Permissions" settings for your app and select "read-only" for "Email addresses".
1. Take note of the Client ID and Client Secret generated by GitHub.
You will use these values in the next step.

1. Coder needs permission to access user email addresses.

Find the **Account Permissions** settings for your app and select **read-only** for **Email addresses**.

## Step 2: Configure Coder with the OAuth credentials

Navigate to your Coder host and run the following command to start up the Coder
server:
Go to your Coder host and run the following command to start up the Coder server:

```shell
coder server --oauth2-github-allow-signups=true --oauth2-github-allowed-orgs="your-org" --oauth2-github-client-id="8d1...e05" --oauth2-github-client-secret="57ebc9...02c24c"
Expand Down
Loading