https://github.com/david-lor/mqtt2docker

Shell scripts to interact with Docker containers through MQTT
https://github.com/david-lor/mqtt2docker

bash bash-script container container-management containers docker docker-container docker-socket mqtt mqtt-bridge mqtt-client mqtt-protocol script shell shell-script

Last synced: 17 days ago
JSON representation

Shell scripts to interact with Docker containers through MQTT

• Host: GitHub
• URL: https://github.com/david-lor/mqtt2docker
• Owner: David-Lor
• License: apache-2.0
• Created: 2019-11-18T17:29:56.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-19T18:37:09.000Z (almost 5 years ago)
• Last Synced: 2024-10-02T21:41:12.406Z (about 1 month ago)
• Topics: bash, bash-script, container, container-management, containers, docker, docker-container, docker-socket, mqtt, mqtt-bridge, mqtt-client, mqtt-protocol, script, shell, shell-script
• Language: Shell
• Homepage:
• Size: 7.81 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# MQTT2Docker

Bash scripts to perform simple Docker container management through MQTT, and send container events to MQTT.

## Scripts

- **mqtt2docker** subscribes to MQTT and performs simple operations (like Start, Stop) on containers

- **docker2mqtt** subscribes to Docker events API and publishes them on MQTT

### mqtt2docker

Publish messages to `mqtt//cmd` to send commands to a container.

Example: START a container named `portainer`: send a message to the topic `mqtt/portainer/cmd` with the payload `start` (payload is not case-sensitive)

#### Commands (payloads) available

- **START**

- **STOP**

- **RESTART**

- **PAUSE**

- **UNPAUSE**

- **KILL**

### docker2mqtt

The script will publish all events occurring on a container to `mqtt//stat`.

Example: when a container named `portainer` starts: a message to the topic `mqtt/portainer/stat` is published with the payload `start`.

### Env variables

Use environment variables as configurations:

- **MQTT_HOST**: host where the MQTT broker is running (if not specified: `localhost`)

- **MQTT_UID**: UID of the user that will run the `mosquitto_sub`/`mosquitto_pub` commands (if not specified: `1000`)

```bash

sudo bash MQTT_HOST=127.0.0.1 MQTT_UID=1000 mqtt2docker.sh

```

### Premises

- Scripts read or write on the Docker API socket (`/var/run/docker.sock`), so they must run as root

- Scripts are written in pure Bash, but require `mosquitto-client` (MQTT client) and `jq` (JSON parser) packages

- Calls to `mosquitto_pub` and `mosquitto_sub` are performed by another user different than root

- Both scripts can run on Docker containers mapping the `/var/run/docker.sock` as a bind volume

## TODO

- Create Docker images

- (More) Setting customization - or pass arguments to the script to be part of the `mosquitto_sub`/`mosquitto_pub` args

- Add binary pub/sub endpoints (ON/OFF - like payloads)

## Changelog

- 0.1 - Initial release