Skip to main content

Add-On Configuration

Each add-on is stored in a folder. The file structure looks like this:

addon_name/
translations/
en.(json/yaml/yml)
apparmor.txt
build.(json/yaml/yml)
CHANGELOG.md
config.(json/yaml/yml)
DOCS.md
Dockerfile
icon.png
logo.png
README.md
run.sh

Add-on script

As with every Docker container, you will need a script to run when the container is started. A user might run many add-ons, so it is encouraged to try to stick to Bash scripts if you're doing simple things.

All our images have also bashio installed. It contains a set of commonly used operations and can be used to be included in add-ons to reduce code duplication across add-ons and therefore making it easier to develop and maintain add-ons.

When developing your script:

  • /data is a volume for persistent storage.
  • /data/options.json contains the user configuration. You can use Bashio to parse this data.
CONFIG_PATH=/data/options.json

TARGET="$(bashio::config 'target')"

So if your options contain

{ "target": "beer" }

then there will be a variable TARGET containing beer in the environment of your bash file afterwards.

Add-on Dockerfile

All add-ons are based on latest Alpine Linux image. Home Assistant will automatically substitute the right base image based on the machine architecture. Add tzdata if you need run in a different timezone. tzdata Is is already added to our base images.

ARG BUILD_FROM
FROM $BUILD_FROM

ENV LANG C.UTF-8

# Install requirements for add-on
RUN apk add --no-cache example_alpine_package

# Copy data for add-on
COPY run.sh /
RUN chmod a+x /run.sh

CMD [ "/run.sh" ]

If you don't use local build on device or our build script, make sure that the Dockerfile have also a set of labels include:

LABEL io.hass.version="VERSION" io.hass.type="addon" io.hass.arch="armhf|aarch64|i386|amd64"

It is possible to use own base image with build.(json/yaml/yml) or if you do not need support for automatic multi-arch building you can also use a simple docker FROM.

Build Args

We support the following build arguments by default:

ARGDescription
BUILD_FROMHold image for dynamic builds or buildings over our systems.
BUILD_VERSIONAdd-on version (read from config.(json/yaml/yml)).
BUILD_ARCHHold current build arch inside.

Add-on config

The configuration for an add-on is stored in config.(json/yaml/yml).

{
"name": "xy",
"version": "1.2",
"slug": "folder",
"description": "long description",
"arch": ["amd64"],
"url": "website with more information about add-on (e.g., a forum thread for support)",
"startup": "application",
"boot": "auto",
"ports": {
"123/tcp": 123
},
"map": ["config:rw", "ssl"],
"image": "repo/{arch}-my-custom-addon"
}
name: xy
version: '1.2'
slug: folder
description: long description
arch:
- amd64
url: website with more information about add-on (e.g., a forum thread for support)
startup: application
boot: auto
ports:
123/tcp: 123
map:
- config:rw
- ssl
image: repo/{arch}-my-custom-addon
KeyTypeRequiredDescription
namestringyesName of the add-on.
versionstringyesVersion of the add-on. If using a docker image with the image option, this needs to match the tag of the image that is already published.
slugstringyesSlug of the add-on. This needs to be unique in the scope of the repository that the add-on is published in and URI friendly.
descriptionstringyesDescription of the add-on.
archlistyesList of supported arch: armhf, armv7, aarch64, amd64, i386.
machinelistnoDefault it support any machine type. You can select that this add-on run only on specific machines. You can use ! before a machine type to negate it.
urlurlnoHomepage of the add-on. Here you can explain the add-ons and options.
startupstringnoDefault application. initialize will start 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.
webuistringnoAn 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 options with: [PROTO:option_name]://[HOST]:[PORT:2839]/dashboard and it's looked up if it is true and it's going to https.
bootstringnoDefault auto. auto start at boot is controlled by the system. manual for only manual starting.
portsdictnoNetwork 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_descriptiondictnoNetwork ports description mapping. Format is "container-port/type": "description of this port".
host_networkboolnoIf true, the add-on runs on host network.
host_ipcboolnoDefault false. Allow to share the IPC namespace with others.
host_dbusboolnoDefault false. Map the host D-Bus service into the add-on.
host_pidboolnoDefault false. Allow to run container on host PID namespace. Works only for not protected add-ons.
deviceslistnoDevice list to map into the add-on. Format is: <path_on_host>. E.g., /dev/ttyAMA0
homeassistantstringnoPin a minimum required Home Assistant Core version for the add-on. Value is a version string like 0.91.2.
hassio_rolestrnoDefault default. Role-based access to Supervisor API. Available: default, homeassistant, backup, manager or admin
hassio_apiboolnoThis add-on can access the Supervisor's REST API. Use http://supervisor.
homeassistant_apiboolnoThis add-on can access to the Home Assistant REST API proxy. Use http://supervisor/core/api.
docker_apiboolnoAllow read-only access to Docker API for add-on. Works only for not protected add-ons.
privilegedlistnoPrivilege for access to hardware/system. Available access: NET_ADMIN, SYS_ADMIN, SYS_RAWIO, SYS_TIME, SYS_NICE, SYS_RESOURCE, SYS_PTRACE, SYS_MODULE or DAC_READ_SEARCH
full_accessboolnoGive 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 this is not needed.
apparmorbool/stringnoEnable or disable AppArmor support. If it is enable, you can also use custom profiles with the name of the profile.
maplistnoList of maps for additional Home Assistant folders. Possible values: config, ssl, addons, backup, share or media. Defaults to ro, which you can change by adding :rw to the end of the name.
environmentdictnoA dictionary of environment variable to run add-on.
audioboolnoMark this add-on to use internal audio system. We map a working PulseAudio setup into container. If your application does not support PulseAudio, you may need to install: Alpine Linux alsa-plugins-pulse or Debian/Ubuntu libasound2-plugins.
videoboolnoMark this add-on to use the internal video system. All available devices will be mapped into the add-on.
gpioboolnoIf this is set to true, /sys/class/gpio will map into add-on for access to GPIO interface from kernel. Some libraries also need /dev/mem and SYS_RAWIO for read/write access to this device. On systems with AppArmor enabled, you need to disable AppArmor or provide you own profile for the add-on, which is better for security.
usbboolnoIf this is set to true, it would map the raw USB access /dev/bus/usb into add-on with plug&play support.
uartboolnoDefault false. Auto mapping all UART/serial devices from the host into the add-on.
udevboolnoDefault false. Set this true, gets the host udev database read-only mounted into the add-on.
devicetreeboolnoBoolean. If this is set to True, /device-tree will map into add-on.
kernel_modulesboolnoMap host kernel modules and config into add-on (readonly) and give you SYS_MODULE permission.
stdinboolnoBoolean. If enabled, you can use the STDIN with Home Assistant API.
legacyboolnoBoolean. If the Docker image has no hass.io labels, you can enable the legacy mode to use the config data.
optionsdictnoDefault options value of the add-on.
schemadictnoSchema for options value of the add-on. It can be false to disable schema validation and options.
imagestringnoFor use with Docker Hub and other container registries. This should be set to the name of the image only (E.g, ghcr.io/home-assistant/{arch}-addon-example). If you use this option, set the active docker tag using the version option.
timeoutintegernoDefault 10 (seconds). The timeout to wait until the Docker daemon is done or will be killed.
tmpfsboolnoIf this is set to true, the containers /tmp is using tmpfs, a memory file system.
discoverylistnoA list of services that this add-on provides for Home Assistant. Currently supported: mqtt
serviceslistnoA list of services that will be provided or consumed with this add-on. Format is service:function and functions are: provide (this add-on can provide this service), want (this add-on can use this service) or need (this add-on need this service to work correctly).
auth_apiboolnoAllow access to Home Assistant user backend.
ingressboolnoEnable the ingress feature for the add-on.
ingress_portintegernoDefault 8099. For add-ons that run on the host network, you can use 0 and read the port later via API.
ingress_entrystringnoModify the URL entry point from /.
ingress_streamboolnoDefault false, when enabled POST requests to the add-on are streamed
panel_iconstringnoDefault: mdi:puzzle. MDI icon for the menu panel integration.
panel_titlestringnoDefault is the add-on name, but can be modified with this option.
panel_adminboolnoDefault true. Make menu entry only available with admin privileged.
backupstringnohot (default) or cold. If cold, the supervisor turns the add-on off before taking a backup (the pre/post options are ignored when cold is used).
backup_prestringnoCommand to execute in the context of the add-on before the backup is taken.
backup_poststringnoCommand to execute in the context of the add-on after the backup was taken.
backup_excludelistnoList of file/path (with glob support) that are excluded from backups.
advancedboolnoDefault false. Make addon visible in simple mode.
stagestringnoDefault stable. Flag add-on with follow attribute: stable, experimental or deprecated
initboolnoDefault true. Disable the Docker default system init. Use this if the image has its own init system.
watchdogstringnoAn URL for monitor an application 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 options 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 work for add-ons on host or internal network.
realtimeboolnoGive add-on access to host schedule including SYS_NICE for change execution time/priority.
journaldboolnoDefault 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.

Options / Schema

The options dictionary contains all available options and their default value. Set the default value to null if the value is required to be given by the user before the add-on can start, and it show it inside default values. Only nested arrays and dictionaries are supported with a deep of two size. If you want make an option optional, put ? to the end of data type, otherwise it will be a required value.

{
"message": "custom things",
"logins": [
{ "username": "beer", "password": "123456" },
{ "username": "cheep", "password": "654321" }
],
"random": ["haha", "hihi", "huhu", "hghg"],
"link": "http://example.com/",
"size": 15,
"count": 1.2
}

The schema looks like options but describes how we should validate the user input. For example:

{
"message": "str",
"logins": [
{ "username": "str", "password": "str" }
],
"random": ["match(^\\w*$)"],
"link": "url",
"size": "int(5,20)",
"count": "float",
"not_need": "str?"
}

We support:

  • str / str(min,) / str(,max) / str(min,max)
  • bool
  • int / int(min,) / int(,max) / int(min,max)
  • float / float(min,) / float(,max) / float(min,max)
  • email
  • url
  • password
  • port
  • match(REGEX)
  • list(val1|val2|...)
  • device / device(filter): Device filter can be following format: subsystem=TYPE i.e. subsystem=tty for serial devices.

Add-on extended build

Additional build options for an add-on is stored in build.(json/yaml/yml). This file will be read from our build systems. You need this only, if you not use the default images or need additional things.

{
"build_from": {
"armhf": "mycustom/base-image:latest"
},
"squash": false,
"args": {
"my_build_arg": "xy"
}
}
build_from:
armhf: mycustom/base-image:latest
squash: false
args:
my_build_arg: xy
KeyRequiredDescription
build_fromnoA dictionary with the hardware architecture as the key and the base Docker image as value.
squashnoDefault False. Be careful with this option, as you can not use the image for caching stuff after that!
argsnoAllow to set additional Docker build arguments as a dictionary.
labelsnoAllow to set additional Docker labels as a dictionary.
codenotarynoAllows to enable container signature with codenotary CAS.
codenotary.signernoOwner signer E-Mail address for this image.
codenotary.base_imagenoVerify the base container image. If you use our official images, use [email protected]

We provide a set of base images which should cover a lot of needs. If you don't want use the Alpine based version or need a specific image tag, feel free to pin this requirements for you build with build_from option.

Add-on translations

Add-ons can provide translation files for configuration options that are used in the UI.

Example path to translation file: addon/translations/{language_code}.(json/yaml/yml)

For {language_code} use a valid language code, like en, for a full list have a look here, en.yaml would be a valid filename.

configuration:
ssl:
name: SSL
description: Enable usage of SSL on the webserver inside the add-on