Open
Add comprehensive GitHub Copilot authentication documentation#175
Conversation
- Add "GitHub Token & Authentication" section explaining: - When tokens are needed (Bridge vs Local CLI) - How to create tokens and verify subscriptions - Classic vs fine-grained PAT permissions and requirements - PAT vs interactive login authentication methods - Token configuration for Bridge add-on - Expand "Authentication Errors" troubleshooting with: - Detailed steps for Bridge add-on authentication failures - Explanation of token permissions (classic and fine-grained) - How to check add-on logs for real errors - "auth probe failed" warning clarification (expected with PATs) - Guidance on when to try classic vs fine-grained PATs - Troubleshooting for local CLI mode - Add token requirements checklist for users to self-diagnose Addresses issue #130: User unable to authenticate with Bridge addon using classic PAT
- Remove unnecessary 'read:user' scope from classic PAT documentation - Clarify that 'auth probe failed' warning appears even with valid tokens - Make rate limit retry timing less specific
- Clarify 'even with valid tokens' for better readability - Add specific timeframe for rate limit recovery guidance
Copilot
AI
changed the title
[WIP] Fix authentication failure in Home Assistant
Add comprehensive GitHub Copilot authentication documentation
Jun 24, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Home Assistant integration documentation to reduce user confusion around authenticating the GitHub Copilot Bridge add-on, especially clarifying expected “auth probe failed” warnings vs real authentication failures.
Changes:
- Adds a new “GitHub Token & Authentication” section explaining token placement for Bridge vs local CLI mode, token types, and a self-diagnosis checklist.
- Expands “Authentication Errors” troubleshooting with Bridge add-on–specific steps and an “auth probe failed” explanation.
Comment on lines
+141
to
+142
| - **With Bridge add-on**: Configure token in the add-on's `github_token` field only (NOT in the integration) | ||
| - **Local CLI mode** (no Bridge): Configure token in the integration's GitHub Token field |
Comment on lines
+188
to
+190
| - Configure your GitHub token **only** in the add-on's `github_token` field (Settings → Add-ons → GitHub Copilot Bridge → Configuration) | ||
| - The integration does **not** ask for or store a token when using the Bridge add-on | ||
| - The bridge server handles all authentication on its own |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Users attempting to authenticate the Bridge addon with a classic PAT are confused about token configuration and mistakenly interpret the expected "auth probe failed" warning as an authentication failure. Documentation clarifies token setup, authentication methods, and distinguishes expected warnings from real errors.
Changes to README.md
New "GitHub Token & Authentication" section
copilotscope only)Expanded "Authentication Errors" section
New "About the 'auth probe failed' Warning" subsection
Key messaging
Users will now understand: