From 3a4a8f413cecd65122ed94c1e29c1fa3a1a9f69a Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Tue, 27 Aug 2024 12:02:27 -0400 Subject: [PATCH] Document manual_only option for addon boot mode (#2286) * Document manual_forced option for addon boot mode * `manual_forced` to `manual_only` --- docs/add-ons/configuration.md | 2 +- docs/api/supervisor/endpoints.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index 26d3fb95..3456b634 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -141,7 +141,7 @@ Avoid using `config.yaml` as filename in your add-on for anything other than the | `url` | url | | Homepage of the add-on. Here you can explain the add-on and options. | `startup` | string | `application` | `initialize` will start the add-on on setup of Home Assistant. `system` is for things like databases and not dependent on other things. `services` will start before Home Assistant, while `application` is started afterwards. Finally `once` is for applications that don't run as a daemon. | `webui` | string | | A URL for the web interface of this add-on. 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`. -| `boot` | string | `auto` | `auto` start at boot is controlled by the system. `manual` configures the add-on to only be started manually. +| `boot` | string | `auto` | `auto` start at boot is controlled by the system and `manual` configures the add-on to only be started manually. If addon should never be started at boot automatically, use `manual_only` to prevent users from changing it. | `ports` | dict | | Network ports to expose from the container. Format is `"container-port/type": host-port`. If the host port is `null` then the mapping is disabled. | `ports_description` | dict | | Network ports description mapping. Format is `"container-port/type": "description of this port"`. Alternatively use [Port description translations](#port-description-translations). | `host_network` | bool | `false` | If `true`, the add-on runs on the host network. diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index 64efc590..be93e443 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -116,6 +116,7 @@ Get details about an add-on | auto_update | boolean | `true` if auto update is enabled | | available | boolean | `true` if the add-on is available | | boot | string | "auto" or "manual" | +| boot_config | string | Default boot mode of addon or "manual_only" if boot mode cannot be auto | | build | boolean | `true` if local add-on | | changelog | boolean | `true` if changelog is available | | description | string | The add-on description | @@ -191,6 +192,7 @@ Get details about an add-on "auto_update": false, "available": false, "boot": "auto", + "boot_config": "auto", "build": false, "changelog": false, "description": "description",