Skip to content

Commit 226d95b

Browse files
authored
Merge pull request #489 from Paraphraser/20220205-docs-master
20220206 documentation - master branch
2 parents f2bb48d + 285aaeb commit 226d95b

File tree

6 files changed

+24
-13
lines changed

6 files changed

+24
-13
lines changed

docs/Containers/Blynk_server.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The remaining instructions in the *Dockerfile* customise the ***base image*** to
115115

116116
The ***local image*** is instantiated to become your running container.
117117

118-
When you run the `docker images` command after Blynk Server has been built, you will see two rows that are relevant:
118+
When you run the `docker images` command after Blynk Server has been built, you *may* see two rows that are relevant:
119119

120120
```bash
121121
$ docker images
@@ -127,7 +127,9 @@ ubuntu latest 897590a6c564 7 days ago 49.8MB
127127
* `ubuntu ` is the ***base image***; and
128128
* `iotstack_blynk_server ` is the ***local image***.
129129

130-
You will see the same pattern in *Portainer*, which reports the ***base image*** as "unused". You should not remove the ***base*** image, even though it appears to be unused.
130+
You *may* see the same pattern in *Portainer*, which reports the ***base image*** as "unused". You should not remove the ***base*** image, even though it appears to be unused.
131+
132+
> 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.
131133
132134
## <a name="logging"> Logging </a>
133135

@@ -216,6 +218,8 @@ At the time of writing, version 0.41.16 was the most up-to-date. Suppose that ve
216218
$ docker system prune -f
217219
```
218220

221+
The second `prune` will only be needed if there is an old *base image* and that, in turn, depends on the version of `docker-compose` you are using and how your version of `docker-compose` builds local images.
222+
219223
## <a name="usingBlynkServer"> Using Blynk Server </a>
220224

221225
See the [References](#references) for documentation links.

docs/Containers/Mosquitto.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The remaining instructions in the *Dockerfile* customise the *base image* to pro
128128

129129
The *local image* is instantiated to become your running container.
130130

131-
When you run the `docker images` command after Mosquitto has been built, you will see two rows for Mosquitto:
131+
When you run the `docker images` command after Mosquitto has been built, you *may* see two rows for Mosquitto:
132132

133133
```bash
134134
$ docker images
@@ -140,7 +140,9 @@ eclipse-mosquitto latest 46ad1893f049 4 weeks ago 8.31MB
140140
* `eclipse-mosquitto` is the *base image*; and
141141
* `iotstack_mosquitto` is the *local image*.
142142

143-
You will see the same pattern in Portainer, which reports the *base image* as "unused". You should not remove the *base* image, even though it appears to be unused.
143+
You *may* see the same pattern in Portainer, which reports the *base image* as "unused". You should not remove the *base* image, even though it appears to be unused.
144+
145+
> 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.
144146
145147
### <a name="migration"> Migration considerations </a>
146148

@@ -632,7 +634,7 @@ Breaking it down into parts:
632634

633635
Your existing Mosquitto container continues to run while the rebuild proceeds. Once the freshly-built *local image* is ready, the `up` tells `docker-compose` to do a new-for-old swap. There is barely any downtime for your MQTT broker service.
634636

635-
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*.
637+
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.
636638

637639
### <a name="versionPinning"> Mosquitto version pinning </a>
638640

docs/Containers/NextCloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ $ docker system prune
288288
$ docker system prune
289289
```
290290

291-
The first "prune" removes the old *local* image, the second removes the old *base* image.
291+
The first "prune" removes the old *local* image, the second removes 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.
292292

293293
## <a name="backups"> Backups </a>
294294

docs/Containers/Node-RED.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Notes:
115115

116116
> Acknowledgement: Successful installation of the SQLite node is thanks to @fragolinux.
117117

118-
When you run the `docker images` command after Node-RED has been built, you will see two rows for Node-RED:
118+
When you run the `docker images` command after Node-RED has been built, you *may* see two rows for Node-RED:
119119

120120
```bash
121121
$ docker images
@@ -127,12 +127,14 @@ nodered/node-red latest deb99584fa75 5 days ago
127127
* `nodered/node-red` is the *base image*; and
128128
* `iotstack_nodered` is the *local image*. The *local* image is the one that is instantiated to become the running container.
129129

130-
You will see the same pattern in Portainer, which reports the *base image* as "unused":
130+
You *may* see the same pattern in Portainer, which reports the *base image* as "unused":
131131

132132
![nodered-portainer-unused-image](./images/nodered-portainer-unused-image.png)
133133

134134
You should not remove the *base* image, even though it appears to be unused.
135135

136+
> 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.
137+
136138
## <a name="securingNodeRed"> Securing Node-RED </a>
137139

138140
### <a name="nodeRedEncryptionKey"> Setting an encryption key for your credentials </a>
@@ -858,7 +860,8 @@ Breaking it down into parts:
858860

859861
Your existing Node-RED container continues to run while the rebuild proceeds. Once the freshly-built *local image* is ready, the `up` tells `docker-compose` to do a new-for-old swap. There is barely any downtime for your Node-RED service.
860862

861-
The `prune` is the simplest way of cleaning up old images. Sometimes you need to run this twice, the first time to clean up the old local image, the second time for the old base image.
863+
The `prune` is the simplest way of cleaning up old images. Sometimes you need to run this twice, the first time to clean up the old local image, the second time for 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.
864+
862865

863866
## <a name="customisingNodeRed"> Customising Node-RED </a>
864867

docs/Containers/Telegraf.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The remaining instructions in the *Dockerfile* customise the ***base image*** to
118118

119119
The ***local image*** is instantiated to become your running container.
120120

121-
When you run the `docker images` command after Telegraf has been built, you will see two rows for Telegraf:
121+
When you run the `docker images` command after Telegraf has been built, you *may* see two rows for Telegraf:
122122

123123
```bash
124124
$ docker images
@@ -130,7 +130,9 @@ telegraf latest a721ac170fad 3 days ago 273MB
130130
* `telegraf ` is the ***base image***; and
131131
* `iotstack_telegraf ` is the ***local image***.
132132

133-
You will see the same pattern in *Portainer*, which reports the ***base image*** as "unused". You should not remove the ***base*** image, even though it appears to be unused.
133+
You *may* see the same pattern in *Portainer*, which reports the ***base image*** as "unused". You should not remove the ***base*** image, even though it appears to be unused.
134+
135+
> 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.
134136
135137
### <a name="migration"> Migration considerations </a>
136138

@@ -331,7 +333,7 @@ Breaking it down into parts:
331333

332334
Your existing Telegraf container continues to run while the rebuild proceeds. Once the freshly-built ***local image*** is ready, the `up` tells `docker-compose` to do a new-for-old swap. There is barely any downtime for your service.
333335

334-
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***.
336+
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.
335337

336338
### <a name="versionPinning"> Telegraf version pinning </a>
337339

docs/Containers/Zigbee2MQTT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,4 +259,4 @@ $ docker system prune
259259

260260
Note:
261261

262-
* Sometimes it is necessary to repeat the `docker system prune` command.
262+
* Sometimes it is necessary to repeat the `docker system prune` command but it depends on the version of `docker-compose` you are using and how your version of `docker-compose` builds local images.

0 commit comments

Comments
 (0)