From fa73df9110c07093036c13556d27c66819a7e6c8 Mon Sep 17 00:00:00 2001 From: Stefan Agner Date: Mon, 13 Feb 2023 14:41:41 +0100 Subject: [PATCH] Document host_uts add-on support (#1310) --- docs/add-ons/configuration.md | 1 + docs/add-ons/presentation.md | 1 + docs/api/supervisor/endpoints.md | 2 ++ 3 files changed, 4 insertions(+) diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index 8af42551..453d6be4 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -142,6 +142,7 @@ Note: Avoid the use of this filename for anything other than add-on configurati | `host_ipc` | bool | `false` | Allow the IPC namespace to be shared with others. | `host_dbus` | bool | `false` | Map the host D-Bus service into the add-on. | `host_pid` | bool | `false` | Allow the container to run on the host PID namespace. Works only for not protected add-ons. **Warning:** Does not work with S6 Overlay. If need this to be `true` and you use the normal add-on base image you disable S6 by overriding `/init`. Or use an alternate base image. +| `host_uts` | bool | `false` | Use the hosts UTS namespace. | `devices` | list | | Device list to map into the add-on. Format is: ``. E.g., `/dev/ttyAMA0` | `homeassistant` | string | | Pin a minimum required Home Assistant Core version for the add-on. Value is a version string like `2022.10.5`. | `hassio_role` | str | `default` |Role-based access to Supervisor API. Available: `default`, `homeassistant`, `backup`, `manager` or `admin` diff --git a/docs/add-ons/presentation.md b/docs/add-ons/presentation.md index cc37ef24..842e6612 100644 --- a/docs/add-ons/presentation.md +++ b/docs/add-ons/presentation.md @@ -218,5 +218,6 @@ Each add-on starts with a base rating of 5, on a scale of 1 to 6. Depending on d | Use `host_network: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | -1 | | | Use `hassio_role: admin` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | -2 | | | Use `host_pid: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | -2 | | +| Use `host_uts: true` and `privileged: SYS_ADMIN` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | -1 | | | Use `full_access: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | Security set to 1 | Overrides all other adjustments | | Use `docker_api: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | Security set to 1 | Overrides all other adjustments | diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index 42c5d32a..08730977 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -108,6 +108,7 @@ Get details about an add-on | host_ipc | boolean | `true` if host ipc access is granted is enabled | | host_network | boolean | `true` if host network access is granted is enabled | | host_pid | boolean | `true` if host pid access is granted is enabled | +| host_uts | boolean | `true` if host UTS namespace access is enabled. | | hostname | string | The host name of the add-on | | icon | boolean | `true` if icon is available | | ingress | boolean | `true` if ingress is enabled | @@ -182,6 +183,7 @@ Get details about an add-on "host_ipc": false, "host_network": false, "host_pid": false, + "host_uts": false, "hostname": "awesome-addon", "icon": false, "ingress_entry": null,