Galaxy
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

homeassistant_docker

Source Code Build Status License: MIT

Setup Home Assistant server. Open source home automation that puts local control and privacy first.


Default Variables

homeassistant_cap_add

Default value

homeassistant_cap_add: []

homeassistant_cap_drop

Default value

homeassistant_cap_drop: []

homeassistant_cmdline_content

Default value

homeassistant_cmdline_content: console=tty1 root=/dev/mmcblk0p3 rootfstype=ext4 elevator=deadline
  rootwait

homeassistant_cmdline_override_enabled

Override /boot/cmdline.txt with given conten. This can be necessary if you use searial hardware, but be careful! Wrong configuration may leave your system unusable!

Default value

homeassistant_cmdline_override_enabled: false

homeassistant_container_name

Default value

homeassistant_container_name: homeassistant

homeassistant_cpu_shares

Default value

homeassistant_cpu_shares: _unset_

Example usage

homeassistant_cpu_shares: '1024'

homeassistant_data_dir

Default value

homeassistant_data_dir: /opt/homeassistant/config

homeassistant_devices

Define required devices e.g. /dev/ttyACM0.

Example usage

homeassistant_devices:
  - src: "{{ homeassistant_serial_port }}"
    dest: "{{ homeassistant_serial_port }}"
    opt: z

homeassistant_exclude_modemmanager

Prevent ModemManger from binding to serial devices and therefor blocking controllers like a CC2531. Devices can be skipped by a udev rule.

Default value

homeassistant_exclude_modemmanager: false

homeassistant_exposed_ports

Default value

homeassistant_exposed_ports: []

homeassistant_extra_hosts

Default value

homeassistant_extra_hosts: []

homeassistant_image

Default value

homeassistant_image: homeassistant/home-assistant:{{ homeassistant_version }}

homeassistant_memory_limit

Default value

homeassistant_memory_limit: _unset_

Example usage

homeassistant_memory_limit: 512m

homeassistant_memory_reservation

Default value

homeassistant_memory_reservation: _unset_

Example usage

homeassistant_memory_reservation: 256m

homeassistant_networks

Default value

homeassistant_networks:
  - name: default

Example usage

homeassistant_networks:
  - name: default
    # optional network driver, defaults to 'bride'
    driver: host
    external: false

homeassistant_networks_applied

Default value

homeassistant_networks_applied:
  - default

homeassistant_pids_limit

Default value

homeassistant_pids_limit: _unset_

homeassistant_plugin_dir

Default value

homeassistant_plugin_dir: /opt/homeassistant/config/www/plugins

homeassistant_plugins

Plugins will be downloaded to homeassistant_plugin_dir and need to be a single raw file.

Default value

homeassistant_plugins: []

Example usage

homeassistant_plugins:
 - name: button-card.js
   url: https://github.com/custom-cards/button-card/releases/download/v3.4.2/button-card.js
 - name: card-tools.js
   url: https://raw.githubusercontent.com/thomasloven/lovelace-card-tools/11/card-tools.js

homeassistant_restart_policy

Default value

homeassistant_restart_policy: always

homeassistant_security_opt

Default value

homeassistant_security_opt: []

homeassistant_serial_device

Default value

homeassistant_serial_device:
  - vendor_id: '0000'
    product_id: xxxx

homeassistant_service_directory

Default value

homeassistant_service_directory: /var/lib/docker/services/homeassistant

homeassistant_service_stopped

Default value

homeassistant_service_stopped: false

homeassistant_timezone

Default value

homeassistant_timezone: Europe/Berlin

homeassistant_version

Default value

homeassistant_version: latest

homeassistant_volumes

Define required docker volumes.

Default value

homeassistant_volumes:
  - name: '{{ homeassistant_data_dir }}'
    dest: /config
    bind: true

Example usage

homeassistant_volumes:
  # Instead of the name you could specify a path on the container host system,
  # but you also have to enable bind mount for this volume
  - name: data
    # target location inside the container
    dest: /var/www/app/data
    # enable bind mount, if false volume will be configured as named volume
    # keep in mind you MUST set bind in any case
    bind: True
    # Options for bind mounts
    bind_opt: "ro,z"

Dependencies

None.