Add-ons can now have a public folder for config or data files, which users can see and modify, but it is still backed up with the add-on.
Many add-ons ask users to provide files as part of the addon configuration. Or generate
files that they want users to be able to see and potentially modify. They typically
handle this by including
share in the list of folders to map.
The problem with this is twofold:
- Nothing in
shareis backed up with the add-on. So, backups of that add-on do not include all the necessary files to run it after restore.
- Add-ons that map
confighave far more access than they should since
configincludes all secrets and credentials used in your Home Assistant integrations.
There is now a better solution for add-on developers. Add-ons can include
in the list of folders to map. Then, the supervisor will create a folder for that add-on
/addon_configs/<your addon slug> and map that to
/config within the add-on
container. If your addon needs to be able to create and modify files in this folder
in addition to collecting files from users, use
To read more about this feature and some of the use cases, see Add-on advanced options.
Backwards compatibility with
You may notice that the new public config folder is mapped to
/config. Which is
previously where Home Assistant's config folder was mapped if you added
This option is intended to replace the need for add-ons to map Home Assistant's
config into their container. As such, an add-on cannot include both
addon_config in the
Going forward, if you do need to make Home Assistant's config available to your
add-on, you should list
homeassistant_config as a folder in the
map field. Then
Home Assistant's config folder will be mapped to
/homeassistant within the container.
Some add-ons need access to all these add-on-specific config folders. For example:
- Studio Code Server
Essentially, these add-ons provide alternative means of editing the configuration
files of Home Assistant and its add-ons. Add-ons like these should add
to the list of folders in the map field. This will map the entire addon configs
folder within the container at