Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf475555

Browse files
EdwardAngertclaudematifali
authored
docs: document that default GitHub app requires device flow (#17162)
## IssueCloses#16824Document that the default GitHub authentication app provided by Coderrequires device flow, and that this behavior cannot be overridden.## Changes MadeClaude updated the GitHub authentication documentation to:1. Add a prominent warning in the Default Configuration sectionexplaining that the default GitHub app requires device flow and ignoresthe `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting2. Clarify the Device Flow section to indicate that: - Device flow is always enabled for the default GitHub app - Device flow is optional for custom GitHub OAuth apps- The `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting is ignored when usingthe default app[preview](https://coder.com/docs/@16824-github-device-flow/admin/users/github-auth)<sub>🤖 Generated with [Claude Code](https://claude.ai/code)</sub>---------Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>Co-authored-by: Claude <noreply@anthropic.com>Co-authored-by: M Atif Ali <atif@coder.com>
1 parente9863ab commitf475555

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

‎docs/admin/users/github-auth.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ This access is necessary for the Coder server to complete the authentication
1515
process. To the best of our knowledge, Coder, the company, does not gain access
1616
to this data by administering the GitHub app.
1717

18+
>[!IMPORTANT]
19+
>The default GitHub app requires[device flow](#device-flow) to authenticate.
20+
>This is enabled by default when using the default GitHub app. If you disable
21+
>device flow using`CODER_OAUTH2_GITHUB_DEVICE_FLOW=false`, it will be ignored.
22+
1823
By default, only the admin user can sign up. To allow additional users to sign
1924
up with GitHub, add the following environment variable:
2025

@@ -124,11 +129,16 @@ organizations. This can be enforced from the organization settings page in the
124129

125130
Coder supports
126131
[device flow](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#device-flow)
127-
for GitHub OAuth. To enable it, set:
132+
for GitHub OAuth. This is enabled by default for the default GitHub app and cannot be disabled
133+
for that app. For your own custom GitHub OAuth app, you can enable device flow by setting:
128134

129135
```env
130136
CODER_OAUTH2_GITHUB_DEVICE_FLOW=true
131137
```
132138

133-
This is optional. We recommend using the standard OAuth flow instead, as it is
134-
more convenient for end users.
139+
Device flow is optional for custom GitHub OAuth apps. We generally recommend using
140+
the standard OAuth flow instead, as it is more convenient for end users.
141+
142+
>[!NOTE]
143+
>If you're using the default GitHub app, device flow is always enabled regardless of
144+
>the`CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp