jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-26 02:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document manual_only option for addon boot mode (#2286)

Browse Source 
* Document manual_forced option for addon boot mode

* `manual_forced` to `manual_only`
This commit is contained in:
Mike Degatano 2024-08-27 12:02:27 -04:00 committed by GitHub
parent e93d47c363
commit 3a4a8f413c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/add-ons/configuration.md
View File

@ -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.

2
docs/api/supervisor/endpoints.md
View File

@ -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",