Skip to content

Document that the default GitHub app requires device flow #16824

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.

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

Closed
hugodutka opened this issue Mar 6, 2025 · 0 comments · Fixed by #17162
Closed

Document that the default GitHub app requires device flow #16824

hugodutka opened this issue Mar 6, 2025 · 0 comments · Fixed by #17162
Labels
docs Area: coder.com/docs

Comments

@hugodutka
Copy link
Contributor

Right now if the user disables the device flow with the default GitHub app, we ignore it. We should

  1. Describe the behavior in documentation, and
  2. log a warning in coder server
@matifali matifali added the docs Area: coder.com/docs label Mar 13, 2025
EdwardAngert added a commit that referenced this issue Mar 28, 2025
Add clear documentation explaining that when using the default GitHub app:
- Device flow is always enabled
- Setting CODER_OAUTH2_GITHUB_DEVICE_FLOW=false will be ignored
- This behavior only applies to the default GitHub app

Fixes #16824

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
SasSwart pushed a commit that referenced this issue Apr 7, 2025
## Issue

Closes #16824

Document that the default GitHub authentication app provided by Coder
requires device flow, and that this behavior cannot be overridden.

## Changes Made

Claude updated the GitHub authentication documentation to:

1. Add a prominent warning in the Default Configuration section
explaining that the default GitHub app requires device flow and ignores
the `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting
2. 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 using
the 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants