Skip to content

Commit 2bf3f35

Browse files
committed
eclipse-mosquitto: Update license and improve documentation
1 parent 34ca869 commit 2bf3f35

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

eclipse-mosquitto/content.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# What is Eclipse Mosquitto?
22

3-
Eclipse Mosquitto is an open source implementation of a server for versions 5, 3.1.1, and 3.1 of the MQTT protocol. Main homepages: http://mosquitto.org/
3+
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/
44

55
%%LOGO%%
66

7+
# Eclipse Mosquitto and Cedalo
8+
9+
[Cedalo](https://cedalo.com/?utm_source=docker-mosquitto&utm_medium=text&utm_campaign=cedalo-name) provides commercial support, enterprise MQTT products, professional services and training for Eclipse Mosquitto.
10+
711
# How to use this image
812

913
## Directories
@@ -14,12 +18,14 @@ Three directories have been created in the image to be used for configuration, p
1418
/mosquitto/data
1519
/mosquitto/log
1620

21+
It is suggested to mirror this structure for your local configuration.
22+
1723
## Configuration
1824

19-
When running the image, the default configuration values are used. To use a custom configuration file, mount a **local** configuration file to `/mosquitto/config/mosquitto.conf`
25+
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`.
2026

2127
```console
22-
$ docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/config/mosquitto.conf %%IMAGE%%
28+
$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" %%IMAGE%%
2329
```
2430

2531
Configuration can be changed to:
@@ -40,7 +46,19 @@ i.e. add the following to `mosquitto.conf`:
4046
Run a container using the new image:
4147

4248
```console
43-
$ docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/config/mosquitto.conf -v /mosquitto/data -v /mosquitto/log %%IMAGE%%
49+
$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" -v /mosquitto/data -v /mosquitto/log %%IMAGE%%
50+
```
51+
52+
or:
53+
54+
```console
55+
$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" -v "$PWD/mosquitto/data:/mosquitto/data" -v "$PWD/mosquitto/log:/mosquitto/log" %%IMAGE%%
4456
```
4557

4658
**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.
59+
60+
For example, if you use port 1883 and port 8080:
61+
62+
```console
63+
$ docker run -it -p 1883:1883 -p 8080:8080 -v "$PWD/mosquitto/config:/mosquitto/config" %%IMAGE%%
64+
```

eclipse-mosquitto/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
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)
1+
Eclipse Mosquitto is released under the [EPL](https://www.eclipse.org/legal/epl-v20.html)/[EDL](https://eclipse.org/org/documents/edl-v10.php)

eclipse-mosquitto/metadata.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"hub": {
33
"categories": [
4+
"internet-of-things",
45
"message-queues"
56
]
67
}

0 commit comments

Comments
 (0)