diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index 84c78894..22964e86 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -115,7 +115,9 @@ map: image: repo/{arch}-my-custom-addon ``` -Note: Avoid the use of this filename for anything other than add-on configuration, as the Supervisor does a recursive lookup. +:::note +Avoid using `config.yaml` as filename in your add-on for anything other than the add-on configuration. The Supervisor does a recursively search for `config.yaml` in the add-on repository. +:: ### Required configuration options @@ -210,6 +212,13 @@ size: 15 count: 1.2 ``` +::note +If you remove a configuration option from an add-on already deployed to users, it is recommended to delete the option to avoid a warning like `Option '' does not exist in the schema for ()`. + +To remove an option the Supervisor addons API can be used. Using bashio this boils down to `bashio::addon.option ''` (without additional argument to delete this option key). Typically this should be called inside an if block checking if the option is still set using `bashio::config.exists ''`. +:: + + The `schema` looks like `options` but describes how we should validate the user input. For example: ```yaml