# Mqttwarn

Mqttwarn is a command-line tool for home automation users that subscribes to Message Queuing Telemetry Transport (MQTT) topics and notifies pluggable services. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/3075/mqttwarn

## Description

Mqttwarn is a command-line tool for home automation users that subscribes to Message Queuing Telemetry Transport (MQTT) topics and notifies pluggable services.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

62/100 (Good), based on 4 of 5 factors.
- Maintained: 65 (last commit 122 days ago)
- Popular: 60 (984 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 83 (no serious findings, 2 minor, CI, tests)

## Links

- Unraid: https://ca.unraid.net/apps/mqttwarn-11ykgck19lvue0?q=mqttwarn
- GitHub: https://github.com/mqtt-tools/mqttwarn
- Documentation: https://mqttwarn.readthedocs.io/

## Common questions

### How do I create mqttwarn's initial configuration files?

Run "mqttwarn make-config > mqttwarn.ini" and "mqttwarn make-udf > udf.py". Without these files, mqttwarn has no settings to read and no place for custom Python helpers.

### Where do I set the MQTT broker and message destinations?

In mqttwarn.ini, set the broker hostname and port, then use launch and targets to choose which handlers run and where messages go. If the broker is wrong or a target is omitted, messages will not be delivered.

### What does the Docker setup need so mqttwarn can find its rules and broker?

Mount the folder containing mqttwarn.ini into /etc/mqttwarn and connect the container to a broker such as Mosquitto. If the config is not mounted or the broker is unreachable, the container starts but cannot find rules or messages.

### What notification services can mqttwarn forward to?

It supports over 70 notification handler plugins and integrates with the Apprise notification library for additional targets.

---
Source: Our Local Host (https://ourlocalhost.com/app/3075/mqttwarn), the self-hosted and open-source app directory.
