Skip to main content
Version: Next 🚧

MQTT

The mqtt trigger publishes JSON update payloads to an MQTT message broker with Home Assistant auto-discovery support.

Looking for Home Assistant?

If you are looking to integrate WUD with Home Assistant via MQTT Auto-Discovery (Update Entities, One-Click Install), please read the Home Assistant (MQTT) Guide.

⚙️ Configuration Variables​

WUD_TRIGGER_MQTT_{trigger_name}_URL
Requiredurl

URL of the MQTT broker

Allowed values:Valid `mqtt`, `mqtts`, `tcp`, `ws`, `wss` URL
WUD_TRIGGER_MQTT_{trigger_name}_CLIENTID
Optionalstringdefault: wud_$random

MQTT client ID to use for the broker connection

WUD_TRIGGER_MQTT_{trigger_name}_PASSWORD
Optionalstring

MQTT broker password

WUD_TRIGGER_MQTT_{trigger_name}_TLS_CACHAIN
Optionalpath

Path to CA certificate chain PEM file (for private CAs)

Allowed values:Valid PEM certificate chain path
WUD_TRIGGER_MQTT_{trigger_name}_TLS_CLIENTCERT
Optionalpath

Path to client certificate PEM file (for mutual TLS)

Allowed values:Valid PEM certificate path
WUD_TRIGGER_MQTT_{trigger_name}_TLS_CLIENTKEY
Optionalpath

Path to client private key PEM file (for mutual TLS)

Allowed values:Valid PEM private key path
WUD_TRIGGER_MQTT_{trigger_name}_TLS_REJECTUNAUTHORIZED
Optionalbooleandefault: true

Whether to reject unauthorized/untrusted server SSL certificates

WUD_TRIGGER_MQTT_{trigger_name}_TOPIC
Optionalstringdefault: wud/container

Base MQTT topic to which updates are published

WUD_TRIGGER_MQTT_{trigger_name}_USER
Optionalstring

MQTT broker username

info

This trigger supports all common trigger configuration options and runs in simple mode by default.

Customizing Entity Names & Icons in Home Assistant

You can customize how containers display in Home Assistant using the wud.display.name and wud.display.icon labels.

🚀 Examples​

Basic Mosquitto Broker Setup​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_MQTT_LOCAL_URL=mqtt://mosquitto:1883

Mutual TLS (mTLS) Authentication​

services:
  whatsupdocker:
    image: getwud/wud
    volumes:
      - /etc/certs/mqtt/client-key.pem:/wud/mqtt/client-key.pem:ro
      - /etc/certs/mqtt/client-cert.pem:/wud/mqtt/client-cert.pem:ro
      - /etc/certs/mqtt/ca.pem:/wud/mqtt/ca.pem:ro
    environment:
      - WUD_TRIGGER_MQTT_LOCAL_URL=mqtts://mosquitto:8883
      - WUD_TRIGGER_MQTT_LOCAL_TLS_CLIENTKEY=/wud/mqtt/client-key.pem
      - WUD_TRIGGER_MQTT_LOCAL_TLS_CLIENTCERT=/wud/mqtt/client-cert.pem
      - WUD_TRIGGER_MQTT_LOCAL_TLS_CACHAIN=/wud/mqtt/ca.pem