mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-12 20:06:28 +00:00
Updated documentation for adding support for addon target configuration (#1974)
Co-authored-by: Jeff Oakley <jeff.oakley@LearningCircleSoftware.com> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
6ff8634fdb
commit
7ac7af4cd5
@ -110,8 +110,12 @@ url: "website with more information about the add-on (e.g., a forum thread for s
|
||||
ports:
|
||||
123/tcp: 123
|
||||
map:
|
||||
- config:rw
|
||||
- ssl
|
||||
- type: share
|
||||
read_only: False
|
||||
- type: ssl
|
||||
- type: homeassistant_config
|
||||
read_only: False
|
||||
path: /custom/config/path
|
||||
image: repo/{arch}-my-custom-addon
|
||||
```
|
||||
|
||||
@ -154,7 +158,7 @@ Avoid using `config.yaml` as filename in your add-on for anything other than the
|
||||
| `privileged` | list | | Privilege for access to hardware/system. Available access: `BPF`, `DAC_READ_SEARCH`, `IPC_LOCK`, `NET_ADMIN`, `NET_RAW`, `PERFMON`, `SYS_ADMIN`, `SYS_MODULE`, `SYS_NICE`, `SYS_PTRACE`, `SYS_RAWIO`, `SYS_RESOURCE` or `SYS_TIME`.
|
||||
| `full_access` | bool | `false` | Give full access to hardware like the privileged mode in Docker. Works only for not protected add-ons. Consider using other add-on options instead of this, like `devices`. If you enable this option, don't add `devices`, `uart`, `usb` or `gpio` as this is not needed.
|
||||
| `apparmor` | bool/string | `false` | Enable or disable AppArmor support. If it is enabled, you can also use custom profiles with the name of the profile.
|
||||
| `map` | list | | List of Home Assistant directories to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, and `all_addon_configs`. Defaults to `ro`, which you can change by adding `:rw` to the end of the name.
|
||||
| `map` | list | | List of Home Assistant directory types to bind mount into your container. Possible values: `homeassistant_config`, `addon_config`, `ssl`, `addons`, `backup`, `share`, `media`, `all_addon_configs`, and `data`. Defaults to read-only, which you can change by adding the property `read_only: false`. By default, all paths map to `/<type-name>` inside the addon container, but an optional `path` property can also be supplied to configure the path (Example: `path: /custom/config/path`). If used, the path must not be empty, unique from any other path defined for the addon, and not the root path. Note that the `data` directory is always mapped and writable, but the `path` property can be set using the same conventions.
|
||||
| `environment` | dict | | A dictionary of environment variables to run the add-on with.
|
||||
| `audio` | bool | `false` | Mark this add-on to use the internal audio system. We map a working PulseAudio setup into the container. If your application does not support PulseAudio, you may need to install: Alpine Linux `alsa-plugins-pulse` or Debian/Ubuntu `libasound2-plugins`.
|
||||
| `video` | bool | `false` | Mark this add-on to use the internal video system. All available devices will be mapped into the add-on.
|
||||
|
Loading…
x
Reference in New Issue
Block a user