docker2mqtt - Deliver docker status information over MQTT

This program uses docker events to watch for changes in your docker containers, and docker stats for metrics about those containers, and delivers current status to MQTT. It will also publish Home Assistant MQTT Discovery messages so that (binary) sensors automatically show up in Home Assistant.

This is part of a family of similar tools:

• miaucl/linux2mqtt
• miaucl/docker2mqtt
• miaucl/systemctl2mqtt

Installation and Deployment

It is available as python package on pypi/docker2mqtt or as a docker image on ghcr.io/docker2mqtt.

Pypi package

pip install docker2mqtt
docker2mqtt --name MyDockerName --events -vvvvv

Usage

from docker2mqtt import Docker2Mqtt, DEFAULT_CONFIG

cfg = Docker2MqttConfig({ 
  **DEFAULT_CONFIG,
  "host": "mosquitto",
  "enable_events": True
})

try:
  docker2mqtt = Docker2Mqtt(cfg)
  docker2mqtt.loop_busy()

except Exception as ex:
  # Do something

Docker image

Use docker to launch this. Please note that you must give it access to your docker socket, which is typically located at /var/run/docker.sock. A typical invocation is:

docker run --network mqtt -e MQTT_HOST=mosquitto -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/miaucl/docker2mqtt

You can also use docker compose:

services:
  docker2mqtt:
    container_name: docker2mqtt
    image: ghcr.io/miaucl/docker2mqtt
    environment:
      - DOCKER2MQTT_HOSTNAME=my_docker_host
      - MQTT_HOST=mosquitto
      - MQTT_USER=username
      - MQTT_PASSWD=password
      - EVENTS=true
      - STATS=true
    restart: unless-stopped
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro

Default Configuration

You can use environment variables to control the behavior.

Consuming The Data

Data is published to the topic docker/<DOCKER2MQTT_HOSTNAME>/<container>/events using JSON serialization. It will arrive whenever a change happens and its type can be inspected in type_definitions.py or the documentation.

Data is also published to the topic docker/<DOCKER2MQTT_HOSTNAME>/<container>/stats using JSON serialization. It will arrive every STATS_RECORD_SECONDS seconds or so and its type can be inspected in type_definitions.py or the documentation.

Home Assistant

Once docker2mqtt is collecting data and publishing it to MQTT, it's rather trivial to use the data in Home Assistant.

A few assumptions:

• Home Assistant is already configured to use a MQTT broker. Setting up MQTT and HA is beyond the scope of this documentation. However, there are a lot of great tutorials on YouTube. An external broker (or as add-on) like Mosquitto will need to be installed and the HA MQTT integration configured.
• The HA MQTT integration is configured to use homeassistant as the MQTT autodiscovery prefix. This is the default for the integration and also the default for docker2mqtt. If you have changed this from the default, use the --prefix parameter to specify the correct one.
• You're not using TLS to connect to the MQTT broker. Currently docker2mqtt only works with unencrypted connections. Username / password authentication can be specified with the --username and --password parameters, but TLS encryption is not yet supported.

After you start the service (binary) sensors should show up in Home Assistant immediately. Look for sensors that start with (binary_)sensor.docker. Metadata about the container will be available as attributes for events, which you can then expose using template sensors if you wish.

Logging

docker2mqtt can log to a directory in addition to the console using the --logdir parameter. The specified directory can be absolute or relative and is created if it doesn't exist. The verbosity parameter applies to file logging and the log file size is limited to 1M bytes and 5 previous files are kept.

docker2mqtt --name Server1 -vvvvv --logdir /var/log/docker2mqtt/

Documentation

Using mkdocs, the documentation and reference is generated and available on github pages.

Dev

Setup the dev environment using VSCode, it is highly recommended.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements_dev.txt

Install pre-commit

pre-commit install

# Run the commit hooks manually
pre-commit run --all-files

Following VSCode integrations may be helpful:

• ruff
• mypy
• markdownlint

A final version can only be released from the master branch. To pass the gates of the publish workflow, the version must match in both the tag and docker2mqtt/__init__.py.

To release a prerelease version, it must be done from a feature branch (not master). Prerelease versions are explicitly marked as such on the GitHub release page.

Credits

This is a detached fork from the repo https://github.com/skullydazed/docker2mqtt, which does not seem to get evolved anymore.

CHANGELOG

DEPRECATED

This changelog is no longer maintained and will not be updated in future releases. Please refer to the release notes on GitHub for the latest changes.

2.2.0

• Add option to group all entities into a single device in home assistant

2.1.0

• Update version package identifier and bump setuptools
• Fix mypy setup

2.0.5

• Re-release due to bad deploy pipeline

2.0.4

• Update the discovery jsons for home assistant

2.0.3

• Transform the mqtt port cli arg to int as a str is not accepted by the paho.mqtt library
• Fix the container filter not only at startup but also at runtime

2.0.2

• Add version cli options to display package version
• Separate the entrypoints for cli (using cli arguments) and docker (using env vars)

2.0.1

• Fix white- and blacklist config via docker env where and empty string resulted in a pass-all regex overwriting the blacklist.

2.0.0

• Rework of the complete structure, but no functional changes.