setup-mosquitto-with-docker

KO | EN

gitlite — search

#python #hacktoberfest #react #go #android #rust #linux #macos #nodejs #java #cli #awesome-list #pytorch #openai

setup-mosquitto-with-docker

(★ 390)

How to setup Mosquitto MQTT Broker using docker with Authentication and Websocket support.

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
caddy-mqtt.yml
Caddyfile
install-docker.sh
LICENSE
main.cpp
mqttx-client.png
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# How to setup Mosquitto MQTT Broker using docker 
These instructions will work on any Debian based OS including Ubuntu, RaspberryPi, WSL2 etc...  
(For non-Debian distros, commands for installation need to be tweaked)

_By default the config allows only to use local connections for security reasons but since authentication is enabled below, that's not the case._

## 1. Install docker

Latest instructions are [here](https://docs.docker.com/engine/install/ubuntu/) on docker website.  
You can also use this script - [install-docker.sh](/install-docker.sh)

## 2. Create base folder for mqtt configuration

```bash

mkdir mqtt5
cd mqtt5

# for storing mosquitto.conf and pwfile (for password)
mkdir config

```

## 3. Create Mosquitto config file - mosquitto.conf
```bash
nano config/mosquitto.conf
```

Basic configuration file content below including websocket config
```
allow_anonymous false
listener 1883
listener 9001
protocol websockets
persistence true
password_file /mosquitto/config/pwfile
persistence_file mosquitto.db
persistence_location /mosquitto/data/
```

## 4. Create Mosquitto password file - pwfile

```bash
touch config/pwfile
```

## 5. Create docker-compose file called 'docker-compose.yml'

```yml

version: "3.7"
services:
  # mqtt5 eclipse-mosquitto
  mqtt5:
    image: eclipse-mosquitto
    container_name: mqtt5
    ports:
      - "1883:1883" #default mqtt port
      - "9001:9001" #default mqtt port for websockets
    volumes:
      - ./config:/mosquitto/config:rw
      - ./data:/mosquitto/data:rw
      - ./log:/mosquitto/log:rw
    restart: unless-stopped

# volumes for mapping data,config and log
volumes:
  config:
  data:
  log:

networks:
  default:
    name: mqtt5-network

```
### 5.1 Public facing Mosquitto Websocket Server with Free SSL using Caddy Server

> [!NOTE]  
> Setup and automate FREE valid SSL for Mosquitto Websocket (WSS), using [Caddy Server](https://caddyserver.com/) with very minimal effort.

<details>
<summary>Click here to expand for instructions</summary>

#### Setting up CaddyServer

Lets check the steps for setting it up  
- Create folders for Caddy data and config
- Configure DNS with A record pointing to your MQTT public IP address  
- Create a config file called 'Caddyfile'
- Create a combined docker-compose file with Caddy + Mosquitto
- Create containers using docker-compose run

#### Create folders for Caddy
```bash
# Caddy data & config files where certificates etc are stored
mkdir caddy_data
mkdir caddy_config
```

#### DNS Setup
```bash
# Create a DNS A/AAAA record pointing your domain to the public IP address
mqtt.domain.com  A  <public-IP-address-for-MQTT-instance>
```
Make sure to wait for the DNS record to complete propagation (depending on TTL). Otherwise automatic SSL creation would not work.

#### Caddyfile for configuration
Caddy uses 2 volumes for data (storing certificates etc) & config.  
Create a file called 'Caddyfile' in the local folder for configuration, which will be mapped to /etc/caddy/Caddyfile through docker-compose file as below.

#### Content of configuration file called 'Caddyfile' 
```bash
# Config file in the current folder
touch Caddyfile
```
_Add below content to `Caddyfile`_ created above.
```
mqtt.domain.com {
        reverse_proxy ws://mqtt5:9001
}
```

#### Combined docker-compose.yml
```yaml
version: "3.7"
services:
  # mqtt5 eclipse-mosquitto
  mqtt5:
    image: eclipse-mosquitto
    container_name: mqtt5
    ports:
      - "1883:1883" #default mqtt port
      - "9001:9001" #default mqtt port for websockets
    volumes:
      - ./config:/mosquitto/config:rw
      - ./data:/mosquitto/data:rw
      - ./log:/mosquitto/log:rw
    restart: unless-stopped

# caddy for HTTPS and reverse-proxy
  caddy:
    image: caddy:latest
    container_name: caddy
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile
      - ./caddy_data:/data
      - ./caddy_config:/config

# volumes for mapping data,config and log
volumes:
  config:
  data:
  log:
  caddy_data:
  caddy_config:

networks:
  default:
    # Caddy and mosquitto should be in the same docker network
    name: caddy-mqtt
```

```bash
# MQTT Connection URL would be 
# WSS => Websocket Secure with SSL
wss://mqtt.domain.com:443
```
#### Using MQTTX Client
![alt text](https://raw.githubusercontent.com/sukesh-ak/setup-mosquitto-with-docker/main/mqttx-client.png)
</details>

## 6. Create and run docker container for MQTT

```bash
# In case you don't have docker-compose you can install it
sudo apt install docker-compose

# Run the docker container for mqtt
sudo docker-compose -p mqtt5 up -d
```

### Check if the container is up and working (note down container-id)

```bash
sudo docker ps
```

## 7. Create a user/password in the pwfile

```bash

# login interactively into the mqtt container
sudo docker exec -it <container-id> sh

# Create new password file and add user and it will prompt for password
mosquitto_passwd -c /mosquitto/config/pwfile user1

# Add additional users (remove the -c option) and it will prompt for password
mosquitto_passwd /mosquitto/config/pwfile user2

# delete user command format
mosquitto_passwd -D /mosquitto/config/pwfile <user-name-to-delete>

# type 'exit' to exit out of docker container prompt

```

Command line help for `mosquitto_passwd` command above
```
mosquitto_passwd is a tool for managing password files for mosquitto.

Usage: mosquitto_passwd [-H sha512 | -H sha512-pbkdf2] [-c | -D] passwordfile username
       mosquitto_passwd [-H sha512 | -H sha512-pbkdf2] [-c] -b passwordfile username password
       mosquitto_passwd -U passwordfile
 -b : run in batch mode to allow passing passwords on the command line.
 -c : create a new password file. This will overwrite existing files.
 -D : delete the username rather than adding/updating its password.
 -H : specify the hashing algorithm. Defaults to sha512-pbkdf2, which is recommended.
      Mosquitto 1.6 and earlier defaulted to sha512.
 -U : update a plain text password file to use hashed passwords
```

Then restart the container 
```bash
sudo docker restart <container-id>
```

## 8. Time to test !!!

### Install mosquitto client tools for testing
```bash

sudo apt install mosquitto-clients

```

### Let us start Subscriber now - topic name => 'hello/topic'

```bash

# Without authentication
mosquitto_sub -v -t 'hello/topic'

# With authentication
mosquitto_sub -v -t 'hello/topic' -u user1 -P <password>

# Alternate way in url format
# Format => mqtt(s)://[username[:password]@]host[:port]/topic
mosquitto_sub -v -L mqtt://user1:abc123@localhost/test/topic

```

### Let us start Publising to that topic

```bash

# Without authentication
mosquitto_pub -t 'hello/topic' -m 'hello MQTT'

# With authentication
mosquitto_pub -t 'hello/topic' -m 'hello MQTT' -u user1 -P <password>

# Alternate way in url format 
# Format => mqtt(s)://[username[:password]@]host[:port]/topic
mosquitto_pub -L mqtt://user1:abc123@localhost/test/topic -m 'hello MQTT'

```
## You can find C/C++ code for mosquitto client
Check [main.cpp](main.cpp) for the mosquitto client code.

## You can also install a nice MQTT Web Client
Read more about it here => https://mqttx.app/

```bash
sudo docker run -d --name mqttx-web -p 80:80 emqx/mqttx-web
```

## Source/Reference for Mosquitto
Github => https://github.com/eclipse/mosquitto

##
![Static Badge](https://img.shields.io/badge/SPONSORING-red?style=for-the-badge)    
If you use my projects or like them, consider sponsoring me. Anything helps and encourages me to keep going.  
See details here: https://github.com/sponsors/sukesh-ak

Your sponsorship would help me not only maintain the projects I'm involved in, but also support my other community activities and purchase hardware for testing these libraries. If you're an individual user who has enjoyed my projects or benefited from my community work, please consider donating as a sign of appreciation. If you run a business that uses my work in your products, sponsoring my development makes good business sense: it ensures that the projects your product relies on stay healthy and actively maintained.

Thank you for considering supporting my work!

setup-mosquitto-with-docker

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

setup-mosquitto-with-docker

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README