MQTT¶

Overview¶

MQTT is a lightweight messaging protocol that is designed for use in constrained devices and low-bandwidth, high-latency, or unreliable networks. It is commonly used in Internet of Things (IoT) devices/applications for efficient and reliable communication between devices.

Manual

Releases

Community

Deployment¶

sb install sandbox-mqtt

Usage¶

MQTT does not have a web interface, so you will need to use a client to interact with it.

Basics¶

You can connect MQTT to Home Assistant and Node Red via docker hostname. Add the MQTT integration in Home Assistant and use mqtt as the hostname/Broker, and 1883 as the port. In Node Red, you can use the mqtt node to connect to the MQTT server.

While MQTT can be set up to use a username and password, it is not recommended to expose it to the internet. So by default, MQTT is not exposed to the internet, nor does it have a username and password.

To add a username and password, you will need to edit the mosquitto.conf file. You can find the file in the /opt/mqtt/config/ directory. You will need to add the following lines to the file:

mosquitto.conf

allow_anonymous false # (1)!
user <username> # (2)!
password <password> # (3)!

This line will disable anonymous access to the MQTT server. It is currently set to true by default.
This line will add a username to the MQTT server. Replace <username> with your desired username.
This line will add a password to the MQTT server. Replace <password> with your desired password.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
mqtt_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like mqtt_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 mqtt_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDockerDocker+Global Override Options

mqtt_name

# Type: string
mqtt_name: mqtt

Container

mqtt_role_docker_container

# Type: string
mqtt_role_docker_container: "{{ mqtt_name }}"

Image

mqtt_role_docker_image_pull

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

mqtt_role_docker_image_tag

# Type: string
mqtt_role_docker_image_tag: "latest"

mqtt_role_docker_image_repo

# Type: string
mqtt_role_docker_image_repo: "eclipse-mosquitto"

mqtt_role_docker_image

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

Envs

mqtt_role_docker_envs_default

# Type: dict
mqtt_role_docker_envs_default:
  TZ: "{{ tz }}"

mqtt_role_docker_envs_custom

# Type: dict
mqtt_role_docker_envs_custom: {}

Volumes

mqtt_role_docker_volumes_default

# Type: list
mqtt_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='mqtt') }}/config:/mosquitto/config"
  - "{{ lookup('role_var', '_paths_location', role='mqtt') }}/data:/mosquitto/data"
  - "{{ lookup('role_var', '_paths_location', role='mqtt') }}/log:/mosquitto/log"
  - "/etc/localtime:/etc/localtime:ro"

mqtt_role_docker_volumes_custom

# Type: list
mqtt_role_docker_volumes_custom: []

Hostname

mqtt_role_docker_hostname

# Type: string
mqtt_role_docker_hostname: "{{ mqtt_name }}"

Networks

mqtt_role_docker_networks_alias

# Type: string
mqtt_role_docker_networks_alias: "{{ mqtt_name }}"

mqtt_role_docker_networks_default

# Type: list
mqtt_role_docker_networks_default: []

mqtt_role_docker_networks_custom

# Type: list
mqtt_role_docker_networks_custom: []

Restart Policy

mqtt_role_docker_restart_policy

# Type: string
mqtt_role_docker_restart_policy: unless-stopped

State

mqtt_role_docker_state

# Type: string
mqtt_role_docker_state: started

User

mqtt_role_docker_user

# Type: string
mqtt_role_docker_user: "{{ uid }}:{{ gid }}"

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

Resource Limits

mqtt_role_docker_blkio_weight

# Type: int
mqtt_role_docker_blkio_weight:

mqtt_role_docker_cpu_period

# Type: int
mqtt_role_docker_cpu_period:

mqtt_role_docker_cpu_quota

# Type: int
mqtt_role_docker_cpu_quota:

mqtt_role_docker_cpu_shares

# Type: int
mqtt_role_docker_cpu_shares:

mqtt_role_docker_cpus

# Type: string
mqtt_role_docker_cpus:

mqtt_role_docker_cpuset_cpus

# Type: string
mqtt_role_docker_cpuset_cpus:

mqtt_role_docker_cpuset_mems

# Type: string
mqtt_role_docker_cpuset_mems:

mqtt_role_docker_kernel_memory

# Type: string
mqtt_role_docker_kernel_memory:

mqtt_role_docker_memory

# Type: string
mqtt_role_docker_memory:

mqtt_role_docker_memory_reservation

# Type: string
mqtt_role_docker_memory_reservation:

mqtt_role_docker_memory_swap

# Type: string
mqtt_role_docker_memory_swap:

mqtt_role_docker_memory_swappiness

# Type: int
mqtt_role_docker_memory_swappiness:

mqtt_role_docker_shm_size

# Type: string
mqtt_role_docker_shm_size:

Security & Devices

mqtt_role_docker_cap_drop

# Type: list
mqtt_role_docker_cap_drop:

mqtt_role_docker_cgroupns_mode

# Type: string
mqtt_role_docker_cgroupns_mode:

mqtt_role_docker_device_cgroup_rules

# Type: list
mqtt_role_docker_device_cgroup_rules:

mqtt_role_docker_device_read_bps

# Type: list
mqtt_role_docker_device_read_bps:

mqtt_role_docker_device_read_iops

# Type: list
mqtt_role_docker_device_read_iops:

mqtt_role_docker_device_requests

# Type: list
mqtt_role_docker_device_requests:

mqtt_role_docker_device_write_bps

# Type: list
mqtt_role_docker_device_write_bps:

mqtt_role_docker_device_write_iops

# Type: list
mqtt_role_docker_device_write_iops:

mqtt_role_docker_devices

# Type: list
mqtt_role_docker_devices:

mqtt_role_docker_devices_default

# Type: string
mqtt_role_docker_devices_default:

mqtt_role_docker_groups

# Type: list
mqtt_role_docker_groups:

mqtt_role_docker_privileged

# Type: bool (true/false)
mqtt_role_docker_privileged:

mqtt_role_docker_security_opts

# Type: list
mqtt_role_docker_security_opts:

mqtt_role_docker_userns_mode

# Type: string
mqtt_role_docker_userns_mode:

Networking

mqtt_role_docker_dns_opts

# Type: list
mqtt_role_docker_dns_opts:

mqtt_role_docker_dns_search_domains

# Type: list
mqtt_role_docker_dns_search_domains:

mqtt_role_docker_dns_servers

# Type: list
mqtt_role_docker_dns_servers:

mqtt_role_docker_domainname

# Type: string
mqtt_role_docker_domainname:

mqtt_role_docker_exposed_ports

# Type: list
mqtt_role_docker_exposed_ports:

mqtt_role_docker_hosts

# Type: dict
mqtt_role_docker_hosts:

mqtt_role_docker_hosts_use_common

# Type: bool (true/false)
mqtt_role_docker_hosts_use_common:

mqtt_role_docker_ipc_mode

# Type: string
mqtt_role_docker_ipc_mode:

mqtt_role_docker_links

# Type: list
mqtt_role_docker_links:

mqtt_role_docker_network_mode

# Type: string
mqtt_role_docker_network_mode:

mqtt_role_docker_pid_mode

# Type: string
mqtt_role_docker_pid_mode:

mqtt_role_docker_ports

# Type: list
mqtt_role_docker_ports:

mqtt_role_docker_uts

# Type: string
mqtt_role_docker_uts:

Storage

mqtt_role_docker_keep_volumes

# Type: bool (true/false)
mqtt_role_docker_keep_volumes:

mqtt_role_docker_mounts

# Type: list
mqtt_role_docker_mounts:

mqtt_role_docker_storage_opts

# Type: dict
mqtt_role_docker_storage_opts:

mqtt_role_docker_tmpfs

# Type: list
mqtt_role_docker_tmpfs:

mqtt_role_docker_volume_driver

# Type: string
mqtt_role_docker_volume_driver:

mqtt_role_docker_volumes_from

# Type: list
mqtt_role_docker_volumes_from:

mqtt_role_docker_volumes_global

# Type: bool (true/false)
mqtt_role_docker_volumes_global:

mqtt_role_docker_working_dir

# Type: string
mqtt_role_docker_working_dir:

Monitoring & Lifecycle

mqtt_role_docker_auto_remove

# Type: bool (true/false)
mqtt_role_docker_auto_remove:

mqtt_role_docker_cleanup

# Type: bool (true/false)
mqtt_role_docker_cleanup:

mqtt_role_docker_force_kill

# Type: string
mqtt_role_docker_force_kill:

mqtt_role_docker_healthcheck

# Type: dict
mqtt_role_docker_healthcheck:

mqtt_role_docker_healthy_wait_timeout

# Type: int
mqtt_role_docker_healthy_wait_timeout:

mqtt_role_docker_init

# Type: bool (true/false)
mqtt_role_docker_init:

mqtt_role_docker_kill_signal

# Type: string
mqtt_role_docker_kill_signal:

mqtt_role_docker_log_driver

# Type: string
mqtt_role_docker_log_driver:

mqtt_role_docker_log_options

# Type: dict
mqtt_role_docker_log_options:

mqtt_role_docker_oom_killer

# Type: bool (true/false)
mqtt_role_docker_oom_killer:

mqtt_role_docker_oom_score_adj

# Type: int
mqtt_role_docker_oom_score_adj:

mqtt_role_docker_output_logs

# Type: bool (true/false)
mqtt_role_docker_output_logs:

mqtt_role_docker_paused

# Type: bool (true/false)
mqtt_role_docker_paused:

mqtt_role_docker_recreate

# Type: bool (true/false)
mqtt_role_docker_recreate:

mqtt_role_docker_restart_retries

# Type: int
mqtt_role_docker_restart_retries:

mqtt_role_docker_stop_timeout

# Type: int
mqtt_role_docker_stop_timeout:

Other Options

mqtt_role_docker_capabilities

# Type: list
mqtt_role_docker_capabilities:

mqtt_role_docker_cgroup_parent

# Type: string
mqtt_role_docker_cgroup_parent:

mqtt_role_docker_commands

# Type: list
mqtt_role_docker_commands:

mqtt_role_docker_create_timeout

# Type: int
mqtt_role_docker_create_timeout:

mqtt_role_docker_entrypoint

# Type: string
mqtt_role_docker_entrypoint:

mqtt_role_docker_env_file

# Type: string
mqtt_role_docker_env_file:

mqtt_role_docker_labels

# Type: dict
mqtt_role_docker_labels:

mqtt_role_docker_labels_use_common

# Type: bool (true/false)
mqtt_role_docker_labels_use_common:

mqtt_role_docker_read_only

# Type: bool (true/false)
mqtt_role_docker_read_only:

mqtt_role_docker_runtime

# Type: string
mqtt_role_docker_runtime:

mqtt_role_docker_sysctls

# Type: list
mqtt_role_docker_sysctls:

mqtt_role_docker_ulimits

# Type: list
mqtt_role_docker_ulimits:

mqtt_role_autoheal_enabled

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

mqtt_role_depends_on

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

mqtt_role_depends_on_delay

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

mqtt_role_depends_on_healthchecks

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

mqtt_role_diun_enabled

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

mqtt_role_docker_controller

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

mqtt_role_docker_image_repo

# Type: string
mqtt_role_docker_image_repo:

mqtt_role_docker_image_tag

# Type: string
mqtt_role_docker_image_tag:

mqtt_role_docker_volumes_download

# Type: bool (true/false)
mqtt_role_docker_volumes_download:

mqtt_role_paths_location

# Type: string
mqtt_role_paths_location: