You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Containers/Mosquitto.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ $ cd ~/IOTstack
82
82
$ docker-compose up -d
83
83
```
84
84
85
-
> See also the [Migration considerations](#migration-considerations) (below).
85
+
> See also the [Migration considerations](#migration) (below).
86
86
87
87
`docker-compose` reads the *Compose* file. When it arrives at the `mosquitto` fragment, it finds:
88
88
@@ -107,7 +107,7 @@ Note:
107
107
…
108
108
```
109
109
110
-
The single-line `build` produces *exactly* the same result as the four-line `build`, save that the single-line form does not support [pinning Mosquitto to a specific version](#mosquitto-version-pinning).
110
+
The single-line `build` produces *exactly* the same result as the four-line `build`, save that the single-line form does not support [pinning Mosquitto to a specific version](#versionPinning).
111
111
112
112
The `./.templates/mosquitto/.` path associated with the `build` tells `docker-compose` to look for:
113
113
@@ -159,7 +159,7 @@ You *may* see the same pattern in Portainer, which reports the *base image* as "
159
159
160
160
> Whether you see one or two rows depends on the version of `docker-compose` you are using and how your version of `docker-compose` builds local images.
Under the original IOTstack implementation of Mosquitto (just "as it comes" from *DockerHub*), the service definition expected the configuration files to be at:
* See also [customising health-check](#customising-health-check). If you are creating usernames and passwords, you may also want to create credentials for the health-check agent.
321
+
* See also [customising health-check](#healthCheckCustom). If you are creating usernames and passwords, you may also want to create credentials for the health-check agent.
322
322
323
323
#### check password file
324
324
@@ -514,7 +514,7 @@ The agent is invoked 30 seconds after the container starts, and every 30 seconds
514
514
* Subscribes to the same broker for the same topic for a single message event.
515
515
* Compares the payload sent with the payload received. If the payloads (ie time-stamps) match, the agent concludes that the Mosquitto broker (the process running inside the same container) is functioning properly for round-trip messaging.
Portainer's *Containers* display contains a *Status* column which shows health-check results for all containers that support the feature.
520
520
@@ -560,7 +560,7 @@ Notes:
560
560
* If you enable authentication for your Mosquitto broker, you will need to add `-u «user»` and `-P «password»` parameters to this command.
561
561
* You should expect to see a new message appear approximately every 30 seconds. That indicates the health-check agent is functioning normally. Use <kbd>control</kbd>+<kbd>c</kbd> to terminate the command.
You can customise the operation of the health-check agent by editing the `mosquitto` service definition in your *Compose* file:
566
566
@@ -580,7 +580,7 @@ You can customise the operation of the health-check agent by editing the `mosqui
580
580
581
581
Note:
582
582
583
-
* You will also need to use the same topic string in the `mosquitto_sub` command shown at [monitoring health-check](#monitoring-health-check).
583
+
* You will also need to use the same topic string in the `mosquitto_sub` command shown at [monitoring health-check](#healthCheckMonitor).
584
584
585
585
3. If you have enabled authentication for your Mosquitto broker service, you will need to provide appropriate credentials for your health-check agent:
586
586
@@ -651,7 +651,7 @@ Your existing Mosquitto container continues to run while the rebuild proceeds. O
651
651
652
652
The `prune` is the simplest way of cleaning up. The first call removes the old *local image*. The second call cleans up the old *base image*. Whether an old *base image* exists depends on the version of `docker-compose` you are using and how your version of `docker-compose` builds local images.
653
653
654
-
### <aname="mosquitto-version-pinning"></a>Mosquitto version pinning
654
+
### <aname="versionPinning"></a>Mosquitto version pinning
655
655
656
656
If an update to Mosquitto introduces a breaking change, you can revert to an earlier know-good version by pinning to that version. Here's how:
0 commit comments