From 1a25cf464ef54320e09794d283bdabd44a404fd8 Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Wed, 28 Feb 2024 05:24:39 -0500 Subject: [PATCH] Document new breaking_versions field for addons (#2056) --- docs/add-ons/configuration.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index bf10372e..44d6f98a 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -192,6 +192,7 @@ Avoid using `config.yaml` as filename in your add-on for anything other than the | `watchdog` | string | | A URL for monitoring the add-on health. Like `http://[HOST]:[PORT:2839]/dashboard`, the port needs the internal port, which will be replaced with the effective port. It is also possible to bind the protocol part to a configuration option with: `[PROTO:option_name]://[HOST]:[PORT:2839]/dashboard` and it's looked up if it is `true` and it's going to `https`. For simple TCP port monitoring you can use `tcp://[HOST]:[PORT:80]`. It works for add-ons on the host or internal network. | `realtime` | bool | `false` | Give add-on access to host schedule including `SYS_NICE` for change execution time/priority. | `journald` | bool | `false` | If set to `true`, the host's system journal will be mapped read-only into the add-on. Most of the time the journal will be in `/var/log/journal` however on some hosts you will find it in `/run/log/journal`. Add-ons relying on this capability should check if the directory `/var/log/journal` is populated and fallback on `/run/log/journal` if not. +| `breaking_versions` | list | | List of breaking versions of the addon. A manual update will always be required if the update is to a breaking version or would cross a breaking version, even if users have auto-update enabled for the addon. ### Options / Schema