Home Assistant

Description / name	Input element
Your domain name

Overview

Home Assistant is a localized, open-source home automation server system that operates independently of external cloud services, though it can optionally use them.

Manual

Releases

Community

---

Deployment

sb install sandbox-homeassistant

Usage

Visit https://homeassistant.iYOUR_DOMAIN_NAMEi.

Basics

Home Assistant is pretty versatile and works with a lot of different apps/containers, some of which we have roles for. See MQTT for using Mosquitto to communicate with local and remote devices. We also have Node Red, which is a platform for multiple types of automations.

Nabu Casa

You don't NEED to use Nabu Casa to access Home Assistant remotely. You can use a reverse proxy to access it remotely. However, if you want to use Nabu Casa, you can use the Nabu Casa integration to connect to Home Assistant. It is a paid service, but it is a good way to support the Home Assistant project. That said, the Home Assistant role is set up to work with a reverse proxy, so you can use that instead.

Addons

You can also use the Home Assistant Community Store (HACS) to add more functionality to Home Assistant. For instance, adding the Node Red Companion, a "custom" integration for node-red-contrib-home-assistant-websocket. It allows you to integrate Node-RED with Home Assistant. For more information, see the Node Red page.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   homeassistant_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like homeassistant_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like homeassistant_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

homeassistant_name

# Type: string
homeassistant_name: homeassistant

homeassistant_role_web_subdomain

# Type: string
homeassistant_role_web_subdomain: "{{ homeassistant_name }}"

homeassistant_role_web_domain

# Type: string
homeassistant_role_web_domain: "{{ user.domain }}"

homeassistant_role_web_port

# Type: string
homeassistant_role_web_port: "8123"

homeassistant_role_web_url

# Type: string
homeassistant_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='homeassistant') + '.' + lookup('role_var', '_web_domain', role='homeassistant')
                             if (lookup('role_var', '_web_subdomain', role='homeassistant') | length > 0)
                             else lookup('role_var', '_web_domain', role='homeassistant')) }}"

homeassistant_role_dns_record

# Type: string
homeassistant_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='homeassistant') }}"

homeassistant_role_dns_zone

# Type: string
homeassistant_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='homeassistant') }}"

homeassistant_role_dns_proxy

# Type: bool (true/false)
homeassistant_role_dns_proxy: "{{ dns_proxied }}"

homeassistant_role_traefik_sso_middleware

# Type: string
homeassistant_role_traefik_sso_middleware: ""

homeassistant_role_traefik_middleware_default

# Type: string
homeassistant_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

homeassistant_role_traefik_middleware_custom

# Type: string
homeassistant_role_traefik_middleware_custom: ""

homeassistant_role_traefik_certresolver

# Type: string
homeassistant_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

homeassistant_role_traefik_enabled

# Type: bool (true/false)
homeassistant_role_traefik_enabled: true

homeassistant_role_traefik_api_enabled

# Type: bool (true/false)
homeassistant_role_traefik_api_enabled: false

homeassistant_role_traefik_api_endpoint

# Type: string
homeassistant_role_traefik_api_endpoint: ""

Container

homeassistant_role_docker_container

# Type: string
homeassistant_role_docker_container: "{{ homeassistant_name }}"

Image

homeassistant_role_docker_image_pull

# Type: bool (true/false)
homeassistant_role_docker_image_pull: true

homeassistant_role_docker_image_repo

# Type: string
homeassistant_role_docker_image_repo: "lscr.io/linuxserver/homeassistant"

homeassistant_role_docker_image_tag

# Type: string
homeassistant_role_docker_image_tag: "latest"

homeassistant_role_docker_image

# Type: string
homeassistant_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='homeassistant') }}:{{ lookup('role_var', '_docker_image_tag', role='homeassistant') }}"

Envs

homeassistant_role_docker_envs_default

# Type: dict
homeassistant_role_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"

homeassistant_role_docker_envs_custom

# Type: dict
homeassistant_role_docker_envs_custom: {}

Volumes

homeassistant_role_docker_volumes_default

# Type: list
homeassistant_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='homeassistant') }}:/config"
  - "/etc/localtime:/etc/localtime:ro"
  - "/run/dbus:/run/dbus:ro"

homeassistant_role_docker_volumes_custom

# Type: list
homeassistant_role_docker_volumes_custom: []

Hostname

homeassistant_role_docker_hostname

# Type: string
homeassistant_role_docker_hostname: "{{ homeassistant_name }}"

Networks

homeassistant_role_docker_networks_alias

# Type: string
homeassistant_role_docker_networks_alias: "{{ homeassistant_name }}"

homeassistant_role_docker_networks_default

# Type: list
homeassistant_role_docker_networks_default: []

homeassistant_role_docker_networks_custom

# Type: list
homeassistant_role_docker_networks_custom: []

Network Mode

homeassistant_role_docker_network_mode

# Type: string
homeassistant_role_docker_network_mode: "host"

Restart Policy

homeassistant_role_docker_restart_policy

# Type: string
homeassistant_role_docker_restart_policy: unless-stopped

State

homeassistant_role_docker_state

# Type: string
homeassistant_role_docker_state: started

Privileged

homeassistant_role_docker_privileged

# Type: bool (true/false)
homeassistant_role_docker_privileged: true

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

homeassistant_role_docker_blkio_weight

# Type: int
homeassistant_role_docker_blkio_weight:

homeassistant_role_docker_cpu_period

# Type: int
homeassistant_role_docker_cpu_period:

homeassistant_role_docker_cpu_quota

# Type: int
homeassistant_role_docker_cpu_quota:

homeassistant_role_docker_cpu_shares

# Type: int
homeassistant_role_docker_cpu_shares:

homeassistant_role_docker_cpus

# Type: string
homeassistant_role_docker_cpus:

homeassistant_role_docker_cpuset_cpus

# Type: string
homeassistant_role_docker_cpuset_cpus:

homeassistant_role_docker_cpuset_mems

# Type: string
homeassistant_role_docker_cpuset_mems:

homeassistant_role_docker_kernel_memory

# Type: string
homeassistant_role_docker_kernel_memory:

homeassistant_role_docker_memory

# Type: string
homeassistant_role_docker_memory:

homeassistant_role_docker_memory_reservation

# Type: string
homeassistant_role_docker_memory_reservation:

homeassistant_role_docker_memory_swap

# Type: string
homeassistant_role_docker_memory_swap:

homeassistant_role_docker_memory_swappiness

# Type: int
homeassistant_role_docker_memory_swappiness:

homeassistant_role_docker_shm_size

# Type: string
homeassistant_role_docker_shm_size:

Security & Devices

homeassistant_role_docker_cap_drop

# Type: list
homeassistant_role_docker_cap_drop:

homeassistant_role_docker_cgroupns_mode

# Type: string
homeassistant_role_docker_cgroupns_mode:

homeassistant_role_docker_device_cgroup_rules

# Type: list
homeassistant_role_docker_device_cgroup_rules:

homeassistant_role_docker_device_read_bps

# Type: list
homeassistant_role_docker_device_read_bps:

homeassistant_role_docker_device_read_iops

# Type: list
homeassistant_role_docker_device_read_iops:

homeassistant_role_docker_device_requests

# Type: list
homeassistant_role_docker_device_requests:

homeassistant_role_docker_device_write_bps

# Type: list
homeassistant_role_docker_device_write_bps:

homeassistant_role_docker_device_write_iops

# Type: list
homeassistant_role_docker_device_write_iops:

homeassistant_role_docker_devices

# Type: list
homeassistant_role_docker_devices:

homeassistant_role_docker_devices_default

# Type: string
homeassistant_role_docker_devices_default:

homeassistant_role_docker_groups

# Type: list
homeassistant_role_docker_groups:

homeassistant_role_docker_security_opts

# Type: list
homeassistant_role_docker_security_opts:

homeassistant_role_docker_user

# Type: string
homeassistant_role_docker_user:

homeassistant_role_docker_userns_mode

# Type: string
homeassistant_role_docker_userns_mode:

Networking

homeassistant_role_docker_dns_opts

# Type: list
homeassistant_role_docker_dns_opts:

homeassistant_role_docker_dns_search_domains

# Type: list
homeassistant_role_docker_dns_search_domains:

homeassistant_role_docker_dns_servers

# Type: list
homeassistant_role_docker_dns_servers:

homeassistant_role_docker_domainname

# Type: string
homeassistant_role_docker_domainname:

homeassistant_role_docker_exposed_ports

# Type: list
homeassistant_role_docker_exposed_ports:

homeassistant_role_docker_hosts

# Type: dict
homeassistant_role_docker_hosts:

homeassistant_role_docker_hosts_use_common

# Type: bool (true/false)
homeassistant_role_docker_hosts_use_common:

homeassistant_role_docker_ipc_mode

# Type: string
homeassistant_role_docker_ipc_mode:

homeassistant_role_docker_links

# Type: list
homeassistant_role_docker_links:

homeassistant_role_docker_pid_mode

# Type: string
homeassistant_role_docker_pid_mode:

homeassistant_role_docker_ports

# Type: list
homeassistant_role_docker_ports:

homeassistant_role_docker_uts

# Type: string
homeassistant_role_docker_uts:

Storage

homeassistant_role_docker_keep_volumes

# Type: bool (true/false)
homeassistant_role_docker_keep_volumes:

homeassistant_role_docker_mounts

# Type: list
homeassistant_role_docker_mounts:

homeassistant_role_docker_storage_opts

# Type: dict
homeassistant_role_docker_storage_opts:

homeassistant_role_docker_tmpfs

# Type: list
homeassistant_role_docker_tmpfs:

homeassistant_role_docker_volume_driver

# Type: string
homeassistant_role_docker_volume_driver:

homeassistant_role_docker_volumes_from

# Type: list
homeassistant_role_docker_volumes_from:

homeassistant_role_docker_volumes_global

# Type: bool (true/false)
homeassistant_role_docker_volumes_global:

homeassistant_role_docker_working_dir

# Type: string
homeassistant_role_docker_working_dir:

Monitoring & Lifecycle

homeassistant_role_docker_auto_remove

# Type: bool (true/false)
homeassistant_role_docker_auto_remove:

homeassistant_role_docker_cleanup

# Type: bool (true/false)
homeassistant_role_docker_cleanup:

homeassistant_role_docker_force_kill

# Type: string
homeassistant_role_docker_force_kill:

homeassistant_role_docker_healthcheck

# Type: dict
homeassistant_role_docker_healthcheck:

homeassistant_role_docker_healthy_wait_timeout

# Type: int
homeassistant_role_docker_healthy_wait_timeout:

homeassistant_role_docker_init

# Type: bool (true/false)
homeassistant_role_docker_init:

homeassistant_role_docker_kill_signal

# Type: string
homeassistant_role_docker_kill_signal:

homeassistant_role_docker_log_driver

# Type: string
homeassistant_role_docker_log_driver:

homeassistant_role_docker_log_options

# Type: dict
homeassistant_role_docker_log_options:

homeassistant_role_docker_oom_killer

# Type: bool (true/false)
homeassistant_role_docker_oom_killer:

homeassistant_role_docker_oom_score_adj

# Type: int
homeassistant_role_docker_oom_score_adj:

homeassistant_role_docker_output_logs

# Type: bool (true/false)
homeassistant_role_docker_output_logs:

homeassistant_role_docker_paused

# Type: bool (true/false)
homeassistant_role_docker_paused:

homeassistant_role_docker_recreate

# Type: bool (true/false)
homeassistant_role_docker_recreate:

homeassistant_role_docker_restart_retries

# Type: int
homeassistant_role_docker_restart_retries:

homeassistant_role_docker_stop_timeout

# Type: int
homeassistant_role_docker_stop_timeout:

Other Options

homeassistant_role_docker_capabilities

# Type: list
homeassistant_role_docker_capabilities:

homeassistant_role_docker_cgroup_parent

# Type: string
homeassistant_role_docker_cgroup_parent:

homeassistant_role_docker_commands

# Type: list
homeassistant_role_docker_commands:

homeassistant_role_docker_create_timeout

# Type: int
homeassistant_role_docker_create_timeout:

homeassistant_role_docker_entrypoint

# Type: string
homeassistant_role_docker_entrypoint:

homeassistant_role_docker_env_file

# Type: string
homeassistant_role_docker_env_file:

homeassistant_role_docker_labels

# Type: dict
homeassistant_role_docker_labels:

homeassistant_role_docker_labels_use_common

# Type: bool (true/false)
homeassistant_role_docker_labels_use_common:

homeassistant_role_docker_read_only

# Type: bool (true/false)
homeassistant_role_docker_read_only:

homeassistant_role_docker_runtime

# Type: string
homeassistant_role_docker_runtime:

homeassistant_role_docker_sysctls

# Type: list
homeassistant_role_docker_sysctls:

homeassistant_role_docker_ulimits

# Type: list
homeassistant_role_docker_ulimits:

homeassistant_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
homeassistant_role_autoheal_enabled: true

homeassistant_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
homeassistant_role_depends_on: ""

homeassistant_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
homeassistant_role_depends_on_delay: "0"

homeassistant_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
homeassistant_role_depends_on_healthchecks:

homeassistant_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
homeassistant_role_diun_enabled: true

homeassistant_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
homeassistant_role_dns_enabled: true

homeassistant_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
homeassistant_role_docker_controller: true

homeassistant_role_docker_image_repo

# Type: string
homeassistant_role_docker_image_repo:

homeassistant_role_docker_image_tag

# Type: string
homeassistant_role_docker_image_tag:

homeassistant_role_docker_volumes_download

# Type: bool (true/false)
homeassistant_role_docker_volumes_download:

homeassistant_role_paths_location

# Type: string
homeassistant_role_paths_location:

homeassistant_role_themepark_addons

# Type: string
homeassistant_role_themepark_addons:

homeassistant_role_themepark_app

# Type: string
homeassistant_role_themepark_app:

homeassistant_role_themepark_theme

# Type: string
homeassistant_role_themepark_theme:

homeassistant_role_traefik_api_endpoint

# Type: dict/omit
homeassistant_role_traefik_api_endpoint:

homeassistant_role_traefik_api_middleware

# Type: string
homeassistant_role_traefik_api_middleware:

homeassistant_role_traefik_api_middleware_http

# Type: string
homeassistant_role_traefik_api_middleware_http:

homeassistant_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
homeassistant_role_traefik_autodetect_enabled: false

homeassistant_role_traefik_certresolver

# Type: string
homeassistant_role_traefik_certresolver:

homeassistant_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
homeassistant_role_traefik_crowdsec_enabled: false

homeassistant_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
homeassistant_role_traefik_error_pages_enabled: false

homeassistant_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
homeassistant_role_traefik_gzip_enabled: false

homeassistant_role_traefik_middleware_http

# Type: string
homeassistant_role_traefik_middleware_http:

homeassistant_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
homeassistant_role_traefik_middleware_http_api_insecure:

homeassistant_role_traefik_middleware_http_insecure

# Type: bool (true/false)
homeassistant_role_traefik_middleware_http_insecure:

homeassistant_role_traefik_priority

# Type: string
homeassistant_role_traefik_priority:

homeassistant_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
homeassistant_role_traefik_robot_enabled: true

homeassistant_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
homeassistant_role_traefik_tailscale_enabled: false

homeassistant_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
homeassistant_role_traefik_wildcard_enabled: true

homeassistant_role_web_domain

# Type: string
homeassistant_role_web_domain:

homeassistant_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
homeassistant_role_web_fqdn_override:

Example Override

homeassistant_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "homeassistant2.{{ user.domain }}"
  - "homeassistant.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

homeassistant_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
homeassistant_role_web_host_override:

Example Override

homeassistant_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'homeassistant2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

homeassistant_role_web_http_port

# Type: string (quoted number)
homeassistant_role_web_http_port:

homeassistant_role_web_http_scheme

# Type: string ("http"/"https")
homeassistant_role_web_http_scheme:

homeassistant_role_web_http_serverstransport

# Type: dict/omit
homeassistant_role_web_http_serverstransport:

homeassistant_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
homeassistant_role_web_scheme:

homeassistant_role_web_serverstransport

# Type: dict/omit
homeassistant_role_web_serverstransport:

homeassistant_role_web_subdomain

# Type: string
homeassistant_role_web_subdomain: