Skip to content
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

Update documentation about UI bug in configuration editor #463

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update documentation about UI bug in configuration editor #463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffda0b6
warn users about the UI bug
lmagyar Feb 5, 2025
401127d
fix grammar in UI bug
lmagyar Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions tailscale/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,25 @@ userspace_networking: true
> change them through the Web UI, because all the changes made there would be
> lost when the add-on is restarted.

> [!CAUTION]
> Due to limitations in Home Assistant's UI, **do not use** the "Show unused
> optional configuration options" switch on the Configuration tab!
Comment on lines +87 to +89
Copy link
Member

@frenck frenck Feb 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is not something I want to document, I'm strongly against documenting bugs, I believe in fixing them.

It is a problem upstream.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How else warn users who spend hours to figure out, that the UI does the exact opposite what it shows?

Thats why nearly all the yaml configs users share show they enable the already by-default-enabled options, and they notice only after hours that the UI never saves the seemingly disabled options, the options they originally wanted to disable when they opened the config tab.

Copy link
Member

Choose a reason for hiding this comment

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

How else warn users who spend hours to figure out, that the UI does the exact opposite what it shows?

This is a concern for Home Assistant, not add-ons.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is an open RFC about add-on config options, this is opened 4 years ago, nothing happened. home-assistant/supervisor#2640

Meanwhile de facto issues/bugfixes are closed, that it is better to implement the RFC. home-assistant/supervisor#4606 home-assistant/supervisor#4607

Even your issue isn't fixed correctly. home-assistant/frontend#8614

If even you can't get something fixed by the frontend team, it will never be fixed.

17.000+ users of this add-on, fighting for hours to configure even the simplest thing, they deserve a warning about this issue.

When it get fixed, I will remove this warning from the docs.

Copy link

Choose a reason for hiding this comment

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

Complete newbie to Home Assistant here so take my opinion with a handful of salt—I was trying to figure out how to stop my HAOS instance from trying to advertise itself as an exit node, and was able to figure out how only thanks to this PR. Having this kind of warning front and center would've sped things up!

Copy link
Member

Choose a reason for hiding this comment

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

Sorry, I'm not adding this.

Working around issues will never fix it.

Copy link
Member

Choose a reason for hiding this comment

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

Complete newbie to Home Assistant here so take my opinion with a handful of salt—I was trying to figure out how to stop my HAOS instance from trying to advertise itself as an exit node, and was able to figure out how only thanks to this PR. Having this kind of warning front and center would've sped things up!

Please report the issue upstream. Learning to workaround the problem will help no-one.

../Frenck


> [!CAUTION]
> When you want to change the default behaviour of these optional configuration
> options, **add them to the YAML add-on configuration manually**, by using the
> "Edit in YAML" in the ... menu on the right and save them! Use the UI to edit
> them only after you added them manually!

> [!WARNING]
> Home Assistant's UI will show you all the optional configuration options
> turned off instead of grayed out. You will falsely believe that those are the
> values that will be stored, so you will enable options, that by default are
> already enabled when unused, and you will let options be disabled, that you
> originally wanted to disable. But the **UI will not add these disabled
> optional configuration options** to the YAML add-on configuration, and at the
> end nothing will change in the add-on's functionality after a restart!

### Option: `accept_dns`

If you are experiencing trouble with MagicDNS on this device and wish to
Expand Down
Loading