Skip to content

docs: document default GitHub OAuth2 configuration and device flow #16663

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 1 commit into from
Mar 3, 2025
Merged

docs: document default GitHub OAuth2 configuration and device flow #16663

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
github oauth2 by default docs
  • Loading branch information
@hugodutka
hugodutka committed Feb 28, 2025
commit ebd0a933bcb91f9e76832c2c96a7d44bb1473b09
36 changes: 36 additions & 0 deletions docs/admin/users/github-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# GitHub

## Default Configuration

By default, new Coder deployments use a Coder-managed GitHub app to authenticate
users. We provide it for convenience, allowing you to experiment with Coder
without setting up your own GitHub OAuth app. Once you authenticate with it, you
grant Coder server read access to:

- Your GitHub user email
- Your GitHub organization membership
- Other metadata listed during the authentication flow

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.

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:

```env
CODER_OAUTH2_GITHUB_DEFAULT_PROVIDER_ENABLE=false
```

## Step 1: Configure the OAuth application in GitHub

First,
Expand Down Expand Up @@ -82,3 +105,16 @@ helm upgrade <release-name> coder-v2/coder -n <namespace> -f values.yaml
> We recommend requiring and auditing MFA usage for all users in your GitHub
> organizations. This can be enforced from the organization settings page in the
> "Authentication security" sidebar tab.

## Device Flow

Coder supports
[device flow](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#device-flow)
for GitHub OAuth. To enable it, set:

```env
CODER_OAUTH2_GITHUB_DEVICE_FLOW=true
```

This is optional. We recommend using the standard OAuth flow instead, as it is
more convenient for end users.
Loading