Skip to content

docs: document that default GitHub app requires device flow #17162

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

Jump to bottom
Merged
merged 3 commits into from
Apr 6, 2025
Merged

docs: document that default GitHub app requires device flow #17162

merged 3 commits into from
Apr 6, 2025

Conversation

EdwardAngert
Copy link
Contributor

@EdwardAngert EdwardAngert commented Mar 28, 2025 •
edited
Loading

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

🤖 Generated with Claude Code

@EdwardAngert
docs: document that default GitHub app requires device flow
fd4f950 
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>
@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Mar 28, 2025
@EdwardAngert EdwardAngert requested a review from hugodutka March 28, 2025 19:44
@EdwardAngert EdwardAngert self-assigned this Mar 28, 2025
matifali
matifali approved these changes Mar 29, 2025
View reviewed changes
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor suggestion but LGTM.

hugodutka
hugodutka approved these changes Apr 1, 2025
View reviewed changes
Copy link
Contributor

@hugodutka hugodutka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc change looks good, but this PR doesn't close the issue. It doesn't address the 2nd requirement:

  1. log a warning in coder server

@EdwardAngert
Copy link
Contributor Author

The doc change looks good, but this PR doesn't close the issue. It doesn't address the 2nd requirement:

  1. log a warning in coder server

thanks @hugodutka - do you know if we already have some documentation on how a user would add a log in Coder server? I'm not seeing anything I can copy or point to in the docs

@EdwardAngert @matifali
Update docs/admin/users/github-auth.md
7ba4380 
Co-authored-by: M Atif Ali <atif@coder.com>
@hugodutka
Copy link
Contributor

@EdwardAngert by "log a warning in coder server" I meant that coder itself should detect when a user tries to disable the device flow with the default config and log a warning in the terminal that this operation is invalid.

@EdwardAngert
Copy link
Contributor Author

@EdwardAngert by "log a warning in coder server" I meant that coder itself should detect when a user tries to disable the device flow with the default config and log a warning in the terminal that this operation is invalid.

I see, @hugodutka, thanks!

I created a new issue for that feature request #17228

this way, we can merge this PR as resolving the docs need and the eng teams can scope the feature request

@EdwardAngert EdwardAngert merged commit f475555 into main Apr 6, 2025
28 checks passed
@EdwardAngert EdwardAngert deleted the 16824-github-device-flow branch April 6, 2025 01:44
@github-actions github-actions bot locked and limited conversation to collaborators Apr 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@matifali matifali matifali approved these changes

@hugodutka hugodutka hugodutka approved these changes

@bpmct bpmct Awaiting requested review from bpmct

@stirby stirby Awaiting requested review from stirby

Assignees

@EdwardAngert EdwardAngert

Labels
docs Area: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document that the default GitHub app requires device flow
3 participants
@EdwardAngert @hugodutka @matifali