Update documentation about UI bug in configuration editor

[lmagyar]

Proposed Changes

This issue is much more serious than it seems, users always show configurations where most of the default enabled options are enabled manually, and complain that disabled options are not working or hard to make them to work.

They waste hours on forums and debugging a configuration issue caused by a very misleading UI config editor!

Related Issues

fixes #462

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation
  • Enhanced guidance for configuring the Tailscale add-on.
  • Added cautionary notes to help users avoid configuration pitfalls with the Home Assistant UI.
    • Advises against using the "Show unused optional configuration options" switch to prevent confusion.
    • Emphasizes the necessity of manually updating optional settings via YAML for accurate configuration.
    • Warns that the UI may misrepresent the state of optional configuration options, leading to potential misunderstandings.

[coderabbitai[bot]]

Walkthrough

This pull request updates the Tailscale add-on documentation for Home Assistant by adding three distinct cautionary notes. These notes advise users to avoid using the "Show unused optional configuration options" switch, require manual updates to the YAML configuration for optional parameters, and warn that the Home Assistant UI may misrepresent the state of certain options. No changes were made to any exported or public entities.

Changes

File(s)	Change Summary
tailscale/DOCS.md	Added three cautionary blocks: one against using the "Show unused optional configuration options" switch, one reminding users to manually update YAML, and one noting that the UI may misrepresent disabled options.

Possibly related PRs

• hassio-addons/addon-tailscale#464: The changes in the main PR regarding cautionary notes on configuration options in the Home Assistant UI are related to the retrieved PR's updates on the limitations of the web UI for configuration, as both address user misunderstandings about configuration processes in tailscale/DOCS.md.

Suggested reviewers

• frenck

Poem

I'm a rabbit with a digital beat,
Hopping through docs with cautious feat,
I’ve added tips to keep configs right,
Guiding users from morning till night,
With a twitch of my nose, I celebrate clear light!
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[frenck]

Thinking about this more, let's remove the optional flags.

That should take care of everything. If this is problematic, lets just make everything mandatory.

[lmagyar]

make everything mandatory

1 option is problematic: advertise_routes

Where:

• undefined = use routes from the HA managed/supported interfaces
• empty list [] = disabled

Here I can't figure out a nice way to configure the current default behaviour, ie. using the supported interfaces. The advertise_routes: ~ or advertise_routes: null is not accepted by the UI.

Converting it into an empty list, would break existing configs.

Using:

options:
  # advertise_routes: # intentionally left empty
schema:
  advertise_routes:
    - "match(^...$)"

And populating it on startup can work, but fails if user tries to edit the config before starting the add-on up.

I run out of ideas.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[lmagyar]

not stale

[lmagyar]

Thinking about this, maybe this can work:

options:
  advertise_routes:
    - local subnets
schema:
  advertise_routes:
    - "match(^(local.subnets|...)$)"

But what to do, if users configure this? We can merge/remove duplicate entries, seems reasonable, and already implemented in the scripts:

advertise_routes:
  - local subnets
  - 192.168.1.0/24

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[lmagyar]

not stale

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[lmagyar]

I've made the necessary changes (docs, config.yaml, code) in my fork to make all the config options non-optional (mandatory), it can be seen here: https://github.com/lmagyar/homeassistant-addon-tailscale-beta/commit/684da82142bce49db26fe15faf78538df3c7f253

Though it has several merge conflicts currently with this official add-on and I wait until the open PR-s are merged/closed and then will I make the conflict resolution.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[ananthb]

Not stale.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[lmagyar]

Closing in favor of #541.