Ansible Role: zwave-js-ui on Docker


An Ansible role to setup and run the zzwave-js-ui Docker container.

Contents

• Requirements
• Role Variables
  • zwave-js-ui settings
  • Container Settings
  • Docker volumes and folders
  • Docker Networks
  • Traefik Proxy
• Dependencies
• Example Playbooks
• License
• Author Information

Requirements

Requires Docker. Reecommended role for Docker installation: geerlingguy.docker.

Role Variables

See defaults/main.yml for a complete list.

zwave-js-ui settings

# Timezone code for the container. Timezone codes can be found at:
# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
zwavejsui_docker_timezone: "America/New_York"

# ZWave serial device to attach to the Docker container. Note: Do not use /dev/ttyUSBX serial
# devices, as those mappings can change over time. Instead, use the /dev/serial/by-id/X serial
# device for your Z-Wave stick.
#
# Example:
#
#   $ ls -al /dev/serial/by-id/
#   lrwxrwxrwx 1 root root 13 Sep  6 18:57 usb-1234_5678-ge11 -> ../../ttyACM0
#
zwavejsui_docker_device: "/dev/serial/by-id/usb-1234_5678-ge11"

Container Settings

# Name of the Docker container.
zwavejsui_docker_name: "zwave-js-ui"

# Base name of the Docker image to use for the container.
zwavejsui_docker_image_name: "zwavejs/zwave-js-ui"

# Specific Docker image version to use for the container.
zwavejsui_docker_image_version: "latest"

# TCP port number to expose to handle HTTP traffic.
zwavejsui_docker_web_port: "8091"

# TCP port number to expose for MQTT traffic.
zwavejsui_docker_ws_port: "3000"

# Number of vCPUs to allocate to the container.
zwavejsui_docker_cpus: "1"

# Amount of memory to allocate to the container.
zwavejsui_docker_memory: "512M"

Docker volumes and folders

# Create and use Docker volumes for storing data. True creates volumes and attaches them to the
# container. False creates folders and bind mounts them to the container.
zwavejsui_docker_use_volumes: true

# Name of the Docker volume to create to store data files. Only used when
# [zwavejsui_docker_use_volumes] is true.
zwavejsui_docker_volume_name: "zwavejsui"

# Directory on filesystem to use for storing data files. Only used when
# [zwavejsui_docker_use_volumes] is false.
zwavejsui_docker_data_dir: "/var/lib/zwavejsui"

Docker Networks

# Name of the default Docker network for the container. The container will *always* attach to this
# network. If [zwavejsui_docker_network_create] is true, this is also the name of the network which
# will be created.
zwavejsui_docker_network: "zwave-js-ui"

# List of additional networks the container should attach to. Elements should be dictionaries like
# https://docs.ansible.com/ansible/latest/collections/community/docker/docker_container_module.html#parameter-networks.
zwavejsui_docker_extra_networks: []

# List of aliases for this container in the default network. These names can be used in the default
# network to reach this container.
zwavejsui_docker_network_aliases: []

# The container’s IPv4 address in the default network. Defaults to using DHCP.
zwavejsui_docker_network_ipv4: null

# The container’s IPv6 address in the default network. Defaults to using DHCP. Only applies if
# IPv6 is enabled in the default network.
zwavejsui_docker_network_ipv6: null

# Create the default Docker network. True creates network and attaches the container to it. False
# does not create the network.
zwavejsui_docker_network_create: false

Traefik Proxy

# Enable use of Traefik as a proxy.
zwavejsui_docker_available_externally: "true"

# Host name to use for the Traefik endpoint. Combined with [zwavejsui_docker_host_domain] to form
# the FQDN for the endpoint.
zwavejsui_docker_hostname: "zwavejsui"

# Domain name to use for the Traefik endpoint. Combined with [zwavejsui_docker_hostname] to form
# the FQDN for the endpoint. Also used by Traefik to create the necessary Let's Encrypt certificate.
zwavejsui_docker_host_domain: "example.com"

Dependencies

None.

Example Playbooks

TODO

License

GNU AFFERO GPL

Author Information

Sean Laurent