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

Document the changes made in https://github.com/coder/coder/pull/16629
and https://github.com/coder/coder/pull/16585.
This commit is contained in:
Hugo Dutka
2025-03-03 12:31:56 +01:00
committed by GitHub
parent c074f77a4f
commit a5842e5ad1

View File

@ -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,
@ -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.