eclipse-mosquitto Docker official image overview

⁠Quick reference

• Maintained by:
  the Eclipse Foundation⁠

• Where to get help:
  the Docker Community Slack⁠, Server Fault⁠, Unix & Linux⁠, or Stack Overflow⁠

⁠Supported tags and respective Dockerfile links

• 2.1.1-alpine, 2.1-alpine, alpine, 2, latest⁠

• 2.0.22, 2.0.22-openssl, 2.0, 2.0-openssl, 2-openssl, openssl⁠

• 1.6.15-openssl, 1.6-openssl⁠

⁠Quick reference (cont.)

• Where to file issues:
  https://github.com/eclipse/mosquitto/issues⁠

• Supported architectures: (more info⁠)
  amd64⁠, arm32v6⁠, arm64v8⁠, i386⁠, ppc64le⁠, s390x⁠

• Published image artifact details:
  repo-info repo's repos/eclipse-mosquitto/ directory⁠ (history⁠)
  (image metadata, transfer size, etc)

• Image updates:
  official-images repo's library/eclipse-mosquitto label⁠
  official-images repo's library/eclipse-mosquitto file⁠ (history⁠)

• Source of this description:
  docs repo's eclipse-mosquitto/ directory⁠ (history⁠)

⁠What is Eclipse Mosquitto?

Eclipse Mosquitto is an open source implementation of a server for versions 5, 3.1.1, and 3.1 of the MQTT protocol. Main homepage: http://mosquitto.org/⁠

⁠Eclipse Mosquitto and Cedalo

Cedalo⁠ provides commercial support, enterprise MQTT products, professional services and training for Eclipse Mosquitto.

⁠How to use this image

⁠Directories

Three directories have been created in the image to be used for configuration, persistent storage and logs.

/mosquitto/config
/mosquitto/data
/mosquitto/log

It is suggested to mirror this structure for your local configuration.

⁠Configuration

When running the image, the default configuration values are used. To use a custom configuration file, create your mosquitto.conf in $PWD/mosquitto/config/mosquitto.conf, then mount the config directory to /mosquitto/config.

$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" eclipse-mosquitto

Configuration can be changed to:

• persist data to /mosquitto/data
• log to /mosquitto/log/mosquitto.log

i.e. add the following to mosquitto.conf:

persistence true
persistence_location /mosquitto/data/
log_dest file /mosquitto/log/mosquitto.log

Note: If a volume is used, the data will persist between containers.

⁠Run

Run a container using the new image:

$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto

or:

$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" -v "$PWD/mosquitto/data:/mosquitto/data" -v "$PWD/mosquitto/log:/mosquitto/log" eclipse-mosquitto

Note: if the mosquitto configuration (mosquitto.conf) was modified to use non-default ports, the docker run command will need to be updated to expose the ports that have been configured.

For example, if you use port 1883 and port 8080:

$ docker run -it -p 1883:1883 -p 8080:8080 -v "$PWD/mosquitto/config:/mosquitto/config" eclipse-mosquitto

⁠Image Variants

The eclipse-mosquitto images come in many flavors, each designed for a specific use case.

⁠eclipse-mosquitto:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

⁠eclipse-mosquitto:<version>-alpine

This image is based on the popular Alpine Linux project⁠, available in the alpine official image⁠. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use musl libc⁠ instead of glibc and friends⁠, so software will often run into issues depending on the depth of their libc requirements/assumptions. See this Hacker News comment thread⁠ for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the alpine image description⁠ for examples of how to install packages if you are unfamiliar).

⁠License

Eclipse Mosquitto is released under the EPL⁠/EDL⁠

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's eclipse-mosquitto/ directory⁠.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.