Przeglądaj źródła

eclipse-mosquitto: Update license and improve documentation

Roger Light 1 rok temu
rodzic
commit
2bf3f35668

+ 22 - 4
eclipse-mosquitto/content.md

@@ -1,9 +1,13 @@
 # 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 homepages: http://mosquitto.org/
+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/
 
 %%LOGO%%
 
+# Eclipse Mosquitto and Cedalo
+
+[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.
+
 # How to use this image
 
 ## Directories
@@ -14,12 +18,14 @@ Three directories have been created in the image to be used for configuration, p
 	/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, mount a **local** configuration file to `/mosquitto/config/mosquitto.conf`
+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 -p 9001:9001 -v mosquitto.conf:/mosquitto/config/mosquitto.conf %%IMAGE%%
+$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" %%IMAGE%%
 ```
 
 Configuration can be changed to:
@@ -40,7 +46,19 @@ i.e. add the following to `mosquitto.conf`:
 Run a container using the new image:
 
 ```console
-$ docker run -it -p 1883:1883 -p 9001:9001 -v mosquitto.conf:/mosquitto/config/mosquitto.conf -v /mosquitto/data -v /mosquitto/log %%IMAGE%%
+$ docker run -it -p 1883:1883 -v "$PWD/mosquitto/config:/mosquitto/config" -v /mosquitto/data -v /mosquitto/log %%IMAGE%%
+```
+
+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" %%IMAGE%%
 ```
 
 **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" %%IMAGE%%
+```

+ 1 - 1
eclipse-mosquitto/license.md

@@ -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)
+Eclipse Mosquitto is released under the [EPL](https://www.eclipse.org/legal/epl-v20.html)/[EDL](https://eclipse.org/org/documents/edl-v10.php)

+ 1 - 0
eclipse-mosquitto/metadata.json

@@ -1,6 +1,7 @@
 {
   "hub": {
     "categories": [
+      "internet-of-things",
       "message-queues"
     ]
   }