Skip to content

No list of available oconfiguration.yaml options #37795

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.

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

Open
Destarianon opened this issue Mar 4, 2025 · 3 comments
Open

No list of available oconfiguration.yaml options #37795

Destarianon opened this issue Mar 4, 2025 · 3 comments
Labels
configuration Stale The PR had no activity for quite some time, and is marked as Stale

Comments

@Destarianon
Copy link

Feedback

Finding options for something as simple as enabling TLS requires looking up multiple pages across multiple websites, some out of date and conflicting. Having a list of all available configuration options seems like it should be a priority in documentation and HA doesn't seem to have that first-party anywhere.

URL

https://www.home-assistant.io/docs/configuration/

Version

2025.2.5

Additional information

No response

@Destarianon Destarianon changed the title No list of available oconfiguration.yaml No list of available oconfiguration.yaml options Mar 4, 2025
@frenck
Copy link
Member

frenck commented Mar 4, 2025

Having a list of all available configuration options seems like it should be a priority in documentation

Those are thousands of configuration options. I get what you are saying, but there is no sane way to create a single page for that.

Additionally, options are part of integrations. In this specific case, I think you mean setting up TLS for the HTTP integration? Or..?

../Frenck

@Destarianon
Copy link
Author

I think my main concerned can be boiled down to navigation. Even if you navigate to the integrations list, and it's only mentioned in the configuration.yaml page, not linked directly, you have to know that the correct integration is called "HTTP" in order to find the options you are looking for, it's opaque until you already know what you want to use.

I understand it would be nearly impossible to maintain a list of all options for all potential integrations, but for "built-in" functionality that is natively a part of home assistant, I would expect to find a unified list of integrations at the least. Rather than having to sift through 3000+ 3rd party integrations to find what is part of the core feature set, it seems reasonable that those core integrations should be called out separately.

I would also point to documentation set up in a format like the following:
https://discord.js.org/docs/
or
https://docs.docker.com/reference/cli/docker/

Formatted as a reference book, where it is easy to navigate through various modules and see all potential options. It is also fairly common practice that these documents are generated programmatically during builds so the reference book is always a full skeleton, even if a human has not gone through to flesh out the documentation beyond "be aware this option exists".

Copy link

github-actions bot commented May 4, 2025

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved.
If this issue is still relevant, please let us know by leaving a comment 👍
This issue has now has been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the Stale The PR had no activity for quite some time, and is marked as Stale label May 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration Stale The PR had no activity for quite some time, and is marked as Stale
Projects
None yet
Development

No branches or pull requests

2 participants