AppDaemon / appdaemon

:page_facing_up: Python Apps for Home Automation
Other
852 stars 418 forks source link

Documentation to point to new configuration location #1881

Open andyb2000 opened 12 months ago

andyb2000 commented 12 months ago

Is there an existing feature request for this?

Your feature request

Not sure where this best sits but thought I should mention, people with HASSOS and docker may find difficulty after the last update where addon configuration is moved.

I created this note on the issue over on hassio-addons https://github.com/hassio-addons/addon-appdaemon/issues/287#issuecomment-1825445234

But thought maybe a note in documentation to help people find it being in "/mnt/data/supervisor/addon_configs/a0d7b954_appdaemon/appdaemon.yaml"

frenck commented 11 months ago

That is not correct, people should not actively use that path at all.

andyb2000 commented 11 months ago

The problem being, people don't know the correct path to use. If people don't use SAMBA shares, then how do we access the new addon_configs location? There needs to be a bit more documentation to correctly point people to this path.

Previously I used "File Editor" to amend appdaemon config, it can no longer access the "addon_configs" folder location so there needs to be a clear path/option for people who want to edit these files.

frenck commented 11 months ago

If people don't use SAMBA shares, then how do we access the new addon_configs location? There needs to be a bit more documentation to correctly point people to this path.

First of all: That is an add-on issue, not an AppDaemon issue. Second: The path you suggest, is not how people should access it. It is an internal path of the host system (which is not fixed), that users shouldn't be accessing. This thus lead to bad practices. Samba, VSCode, SSH add-ons and the File editors provide access to these files.

andyb2000 commented 11 months ago

I'm not arguing that the path I pasted is not best practice, more that it was the only way I could access it and many others judging by forum posts with people with similar issues. SSH and File Editors don't have access to the AppDaemon app configuration folders which is the issue, providing a clear guide in the documentation on where to access add-on configuration folders is what I'm suggesting.

Reading the app development documentation at - https://appdaemon.readthedocs.io/en/latest/APPGUIDE.html#configuration-of-apps "The App configuration files exist under the apps directory and can be called anything as long as they end in .yaml or .toml." confirms that it should be in this location, but in https://appdaemon.readthedocs.io/en/latest/CONFIGURE.html it doesn't suggest where an average user would find the configuration file being used which is where I think the confusion is.

PeWu commented 11 months ago

I had the same issue – I could only find the AppDaemon configs in /mnt/data/supervisor/addon_configs/a0d7b954_appdaemon/appdaemon.yaml. It took some time to figure out what is going on.

It turns out that the addon_configs folder is part of a new HA feature: https://developers.home-assistant.io/blog/2023/11/06/public-addon-config/ Only new versions of addons use this feature. I needed to upgrade the VSCode addon to the newest version to make it see the addon_configs folder. Similarly, only after upgrading the Terminal & SSH Addon, the addon_configs folder started showing.