Skip to content

Update documentation links and extend error messages#708

Open
lmagyar wants to merge 3 commits into
hassio-addons:mainfrom
lmagyar:pr-update-serve-funnel-links-messages
Open

Update documentation links and extend error messages#708
lmagyar wants to merge 3 commits into
hassio-addons:mainfrom
lmagyar:pr-update-serve-funnel-links-messages

Conversation

@lmagyar

@lmagyar lmagyar commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Proposed Changes

Better link to TS docs, better error messages for users who don't read docs.

Related Issues

Summary by CodeRabbit

  • Documentation
    • Updated the Tailscale Funnel “share_homeassistant” setup step to reference the correct link, and adjusted the related link definitions accordingly.
  • Bug Fixes
    • Improved Home Assistant sharing failure messages when Tailscale HTTPS or Funnel support is disabled.
    • Enhanced the exit-node configuration conflict message when both exit-node settings are enabled, making it clearer.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 29c22224-6676-4812-90b8-46d96db23528

📥 Commits

Reviewing files that changed from the base of the PR and between 7a96647 and 221c8c7.

📒 Files selected for processing (1)
  • tailscale/rootfs/etc/s6-overlay/s6-rc.d/post-tailscaled/run
✅ Files skipped from review due to trivial changes (1)
  • tailscale/rootfs/etc/s6-overlay/s6-rc.d/post-tailscaled/run

Walkthrough

Updated share_homeassistant Funnel failure messages, Funnel documentation links, and one exit-node configuration error message.

Changes

Share Home Assistant Funnel guidance

Layer / File(s) Summary
Runtime exit messages
tailscale/rootfs/etc/s6-overlay/s6-rc.d/share-homeassistant/run
The share-homeassistant run script emits split bashio::exit.nok messages for disabled HTTPS and Funnel support, including documentation guidance.
Funnel doc links
tailscale/DOCS.md
The Funnel setup instructions and link reference now use the funnel-node-attribute URL.
Exit-node error text
tailscale/rootfs/etc/s6-overlay/s6-rc.d/post-tailscaled/run
The post-tailscaled script emits a multi-line bashio::exit.nok message for the exit-node and advertise-exit-node configuration conflict.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • hassio-addons/app-tailscale#627: Also updates tailscale/DOCS.md link references for Tailscale-related guidance.
  • tailscale/rootfs/etc/s6-overlay/s6-rc.d/share-homeassistant/run and tailscale/DOCS.md are closely connected here through the updated Funnel guidance.
  • tailscale/rootfs/etc/s6-overlay/s6-rc.d/post-tailscaled/run is a related startup-message change in the same add-on boot flow.

Suggested reviewers

  • frenck

Poem

A bunny hopped through docs and scripts 🐇
To tune the words that failure scripts ship
When Funnel sleeps or exit-node rules bite
The guide now points and messages read right

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: documentation link updates and expanded error messages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@lmagyar lmagyar added documentation Solely about the documentation of the project. no-stale This issue or PR is exempted from the stable bot. labels Jun 26, 2026
@lmagyar lmagyar changed the title Update serve and funnel related documentation links and error messages Update documentation links and extend error messages Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Solely about the documentation of the project. no-stale This issue or PR is exempted from the stable bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant