diff --git a/eclipse-mosquitto/README-short.md b/eclipse-mosquitto/README-short.md new file mode 100644 index 000000000..68d3365b6 --- /dev/null +++ b/eclipse-mosquitto/README-short.md @@ -0,0 +1 @@ +Eclipse Mosquitto is an open source message broker which implements MQTT protocol version 3.1 and 3.1.1. diff --git a/eclipse-mosquitto/content.md b/eclipse-mosquitto/content.md new file mode 100644 index 000000000..cac0c8437 --- /dev/null +++ b/eclipse-mosquitto/content.md @@ -0,0 +1,49 @@ +# What is Eclipse Mosquitto? + +Eclipse Mosquitto is an open source implementation of a server for version 3.1 and 3.1.1 of the MQTT protocol. Main homepage: http://mosquitto.org/ + +%%LOGO%% + +# How to use this image + +##Mount Points + +Three mount points have been created in the image to be used for configuration, persistent storage and logs. +``` +/mosquitto/config +/mosquitto/data +/mosquitto/log +``` + + +##Configuration + +When running the image, the default configuration values are used. +To use a custom configuration file, mount a **local** configuration file to `/mosquitto/conf/mosquitto.conf` +``` +docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf 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 -p 9001:9001 -v mosquitto.conf:/mosquitto/data/mosquitto.conf -v /mosquitto/data -v /mosquitto/log eclipse-mosquitto +``` +:boom: 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. diff --git a/eclipse-mosquitto/github-repo.md b/eclipse-mosquitto/github-repo.md new file mode 100644 index 000000000..f5c8c7a81 --- /dev/null +++ b/eclipse-mosquitto/github-repo.md @@ -0,0 +1 @@ +https://github.com/eclipse/mosquitto diff --git a/eclipse-mosquitto/license.md b/eclipse-mosquitto/license.md new file mode 100644 index 000000000..87d41d6b9 --- /dev/null +++ b/eclipse-mosquitto/license.md @@ -0,0 +1 @@ +Eclipse Mosquitto is released under the [EPL](https://www.eclipse.org/legal/epl-v10.html)/[EDL](https://eclipse.org/org/documents/edl-v10.php) diff --git a/eclipse-mosquitto/logo.png b/eclipse-mosquitto/logo.png new file mode 100644 index 000000000..fa85de456 Binary files /dev/null and b/eclipse-mosquitto/logo.png differ