DEV Community

abbazs
abbazs

Posted on

A step-by-step guide for starting a mosquitto broker service in a containers with docker-compose

#docker #mqtt #mosquitto #broker

A step-by-step guide for starting a mosquitto broker service in a containers with docker-compose

Prerequisites

Before we start, make sure you have the following installed on your machine:

  • Docker
  • docker-compose

You can install the prerequisites following this tutorial.

  1. Open your terminal and create a new directory called mosquitto: 
   mkdir mosquitto
Enter fullscreen mode Exit fullscreen mode
  1. Change to the mosquitto directory: 
   cd mosquitto
Enter fullscreen mode Exit fullscreen mode
  1. Create the config folder and the mosquitto.conf and password.txt files inside it (with the content as following): 
   mkdir config
   echo 'listener 1883
   persistence true
   persistence_location /mosquitto/data/
   log_dest file /mosquitto/log/mosquitto.log
   allow_anonymous false
   password_file /mosquitto/config/password.txt' > config/mosquitto.conf
   echo "admin:\$7\$101\$xuOfObQdv0Hi2p0A\$o+J3vzbpm0hekukYw73tT3fiB2Ogi1UCJgbzNyFA0GOgxAo79hqfTeXVr062KoD5nCphwV+1V/NxlMzwnV5Kvg==" > config/password.txt
Enter fullscreen mode Exit fullscreen mode
  1. Create the log folder and the mosquitto.log file inside it: 
   mkdir log
   touch log/mosquitto.log
Enter fullscreen mode Exit fullscreen mode
  1. Set the read and write permissions for all users for the following files: 
   chmod o+w log/mosquitto.log
   chmod 766 -R config
Enter fullscreen mode Exit fullscreen mode
  1. Create the docker-compose.yml file with the following content: 
   version: '3.8'
   networks:
   mqtt-net:
       driver: bridge
       ipam:
       driver: default
       config:
           - subnet: 172.100.10.0/24
   services:
    mqtt-broker:
        image: eclipse-mosquitto:latest
        user: mosquitto
        volumes:
        - type: bind
            source: ./config/
            target: /mosquitto/config/
            read_only: false
        - type: bind
            source: ./log/
            target: /mosquitto/log/
            read_only: false
        - type: volume
            source: data
            target: /mosquitto/data/
        ports:
        - target: 1883
            published: 1883
            protocol: tcp
            mode: host
        - target: 9001
            published: 9001
            protocol: tcp
            mode: host
        networks:
            mqtt-net:
                ipv4_address: 172.100.10.10
    mqtt-pub:
        image: eclipse-mosquitto:latest
        command: sh -c "mosquitto_pub -h mqtt-broker -t test -m 'Hello World' -u admin -P password"
        depends_on:
            - mqtt-broker
        networks:
            mqtt-net:
                ipv4_address: 172.100.10.11
    mqtt-sub:
        image: eclipse-mosquitto:latest
        command: sh -c "mosquitto_sub -h mqtt-broker -t test -u admin -P password"
        depends_on:
            - mqtt-broker
        networks:
            mqtt-net:
                ipv4_address: 172.100.10.12
   volumes:
   data:
       name: "mqtt-broker-data"
Enter fullscreen mode Exit fullscreen mode

Note that we have assigned a static IP address of 172.100.10.10 to the mqtt-broker service.

  1. Build and start the containers by running the following command: 
   docker-compose up --build
Enter fullscreen mode Exit fullscreen mode

This should bring up 3 services namely mqtt-broker, mqtt-pub, mqtt-sub. And the mqtt-pub service will immediatly exit since it just exits after publishing a message.

The default username and password for mqtt-broker is admin and password respectively.

  1. We can now publish messages using the mqtt-pub service using the docker compose. 
   docker compose run mqtt-pub sh -c "mosquitto_pub -h mqtt-broker -t test -m 'Hello World' -u admin -P password"
   docker compose run mqtt-pub sh -c "mosquitto_pub -h mqtt-broker -t test -m 'Message 2' -u admin -P password"
   docker compose run mqtt-pub sh -c "mosquitto_pub -h mqtt-broker -t test -m 'Message 3' -u admin -P password"
Enter fullscreen mode Exit fullscreen mode

And we shall be able to see the output as following:

   mqtt-mqtt-sub-1     | Hello World
   mqtt-mqtt-sub-1     | Message 2
   mqtt-mqtt-sub-1     | Message 3
Enter fullscreen mode Exit fullscreen mode
  1. To change the password of admin user (after changing the password the service needs to be restarted): 
   docker compose exec mqtt-broker mosquitto_passwd -b /mosquitto/config/password.txt admin NEWPASSWORD
Enter fullscreen mode Exit fullscreen mode

Understanding the command:

  1. docker: This is the command used to interact with Docker, a containerization platform used to run applications in isolated environments.

  2. compose: This is an option used with the docker command to run a multi-container Docker application using a Compose file.

  3. exec: This is an option used with the docker-compose command to execute a command inside a running container.

  4. mqtt-broker: This is the name of the service in the Compose file that corresponds to the MQTT broker container.

  5. mosquitto_passwd: This is the command to set or update a password in the password file used by the Mosquitto MQTT broker.

  6. -b: This is an option for the mosquitto_passwd command that specifies that the next argument is the password to be added or updated.

  7. /mosquitto/config/password.txt: This is the path to the password file in the Mosquitto container.

  8. admin: This is the username to which the password will be added or updated.

  9. NEWPASSWORD: This is the new password that will be set for the admin user in the Mosquitto password file.

In summary, this command sets or updates the password for the admin user in the Mosquitto password file located at /mosquitto/config/password.txt with the new password NEWPASSWORD, inside the running mqtt-broker container in a Docker Compose environment.

Restart the container:

   docker compose restart mqtt-broker
Enter fullscreen mode Exit fullscreen mode
  1. Since we changed the admin password, we no longer will be able to start the mqtt-pub service as docker compose up mqtt-sub. We need to start it using the following command: 
   docker compose run mqtt-sub sh -c "mosquitto_sub -h mqtt-broker -t test -u admin -P CHANGED_PASSWORD"
Enter fullscreen mode Exit fullscreen mode

Now we can publish a message (using another terminal) and see that being refelceted in the mqtt-sub container service.

   docker compose run mqtt-pub sh -c "mosquitto_pub -h mqtt-broker -t test -m 'Hello World' -u admin -P CHANGED_PASSWORD"
Enter fullscreen mode Exit fullscreen mode

Top comments (1)

Collapse
 
ceentaxerror profile image
Syntax • • Edited

Your indentation is all screwed up. Any chance you can fix it for future travellers?

Docker compose build errors out because you are defining the driver twice, once as bridge then again as default.

Should be:

networks:
    mqtt-net:
        driver: bridge
        ipam:
            config:
                 - subnet: 172.100.10.0/24
Enter fullscreen mode Exit fullscreen mode

You also get the message "volumes must be a mapping", this is because there is an indentation error on the data: field.

Should be:

volumes:
     data:
         name: "mqtt-broker-data"
Enter fullscreen mode Exit fullscreen mode

But after all of that still getting an invalid IPv4 address for the subscriber.

Any ideas?

Read next

code42cate profile image

Day 7: Docker Volumes

Jonas Scholz -

code42cate profile image

Day 4: Your first Container

Jonas Scholz -

code42cate profile image

Day 6: Docker Image Layers

Jonas Scholz -

code42cate profile image

Day 5: Interacting with Containers

Jonas Scholz -