Eclipse Mosquitto Docker Image

Quick reference

• Maintained by:
  https://github.com/eclipse/mosquitto

• Where to get help:
  https://dockr.ly/comm-slack, Server Fault, https://unix.stackexchange.com/help/on-topic, or https://stackoverflow.com/help/on-topic

Supported tags and respective Dockerfile links

• https://github.com/eclipse-mosquitto/mosquitto/blob/5b74cce8a4fe2a73b57df6c703bfde2cfd535d60/docker/2.1-alpine/Dockerfile

• https://github.com/eclipse-mosquitto/mosquitto/blob/5b74cce8a4fe2a73b57df6c703bfde2cfd535d60/docker/2.0-openssl/Dockerfile

• https://github.com/eclipse-mosquitto/mosquitto/blob/5b74cce8a4fe2a73b57df6c703bfde2cfd535d60/docker/1.6-openssl/Dockerfile

Quick reference (cont.)

• Where to file issues:
  https://github.com/eclipse/mosquitto/issues?q=is:issue+is:pr

• Supported architectures: (https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/eclipse-mosquitto/, https://hub.docker.com/r/arm32v6/eclipse-mosquitto/, https://hub.docker.com/r/arm64v8/eclipse-mosquitto/, https://hub.docker.com/r/i386/eclipse-mosquitto/, https://hub.docker.com/r/ppc64le/eclipse-mosquitto/, https://hub.docker.com/r/s390x/eclipse-mosquitto/

• Published image artifact details:
  https://github.com/docker-library/repo-info/blob/master/repos/eclipse-mosquitto (https://github.com/docker-library/repo-info/commits/master/repos/eclipse-mosquitto)
  (image metadata, transfer size, etc)

• Image updates:
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Feclipse-mosquitto
  https://github.com/docker-library/official-images/blob/master/library/eclipse-mosquitto (https://github.com/docker-library/official-images/commits/master/library/eclipse-mosquitto)

• Source of this description:
  https://github.com/docker-library/docs/tree/master/eclipse-mosquitto (https://github.com/docker-library/docs/commits/master/eclipse-mosquitto)

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.

console
$ 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:

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

or:

console
$ 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:

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

Image tags

The supported-tags list at the top of this page is authoritative. Official eclipse-mosquitto images are Alpine-based. Tag naming does not follow a generic "plain version" vs "version-alpine" split:

• 2.1.x: tags such as 2.1.2-alpine, 2.1-alpine, alpine, 2, and latest all refer to the current Alpine 2.1 image. There is no separate non-Alpine 2.1 tag.
• 2.0.x (OpenSSL): tags such as 2.0.22, 2.0.22-openssl, 2.0, 2.0-openssl, 2-openssl, and openssl refer to the Alpine 2.0 OpenSSL image (TLS-PSK and related OpenSSL features). Prefer an explicit 2.0* / *-openssl tag if you need this line; do not assume openssl alone means "latest Mosquitto".
• 1.6.x (OpenSSL): tags such as 1.6.15-openssl and 1.6-openssl refer to the Alpine 1.6 OpenSSL image.

If you are unsure which tag to use for current Mosquitto, prefer latest or a pinned 2.1*-alpine tag from the supported-tags list.

License

Eclipse Mosquitto is released under the https://www.eclipse.org/legal/epl-v20.html/https://eclipse.org/org/documents/edl-v10.php

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 https://github.com/docker-library/repo-info/tree/master/repos/eclipse-mosquitto.

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.