Skip to content

Commit cc8defa

Browse files
committed
docs/Getting Started: Small fixes and improvments
* Reword volume-mount section for better clarity * Fix scripted install section to link to PiBuilder (was linking to deprecated gist) * Convert "patch 2" steps to numbered list for better readability
1 parent 9643209 commit cc8defa

File tree

1 file changed

+30
-49
lines changed

1 file changed

+30
-49
lines changed

docs/Basic_setup/index.md

Lines changed: 30 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,8 @@ Please don't read these assumptions as saying that IOTstack will not run on othe
116116

117117
### scripted
118118

119-
If you prefer to automate your installations using scripts, see:
120-
121-
* [Installing Docker for IOTstack](https://gist.github.com/Paraphraser/d119ae81f9e60a94e1209986d8c9e42f#scripting-iotstack-installations).
119+
If you prefer to automate your installations using scripts, see
120+
[PiBuilder](https://github.com/Paraphraser/PiBuilder).
122121

123122
## Required system patches
124123

@@ -130,7 +129,6 @@ Run the following commands:
130129

131130
``` console
132131
$ sudo bash -c '[ $(egrep -c "^allowinterfaces eth\*,wlan\*" /etc/dhcpcd.conf) -eq 0 ] && echo "allowinterfaces eth*,wlan*" >> /etc/dhcpcd.conf'
133-
$ sudo reboot
134132
```
135133

136134
See [Issue 219](https://github.com/SensorsIot/IOTstack/issues/219) and [Issue 253](https://github.com/SensorsIot/IOTstack/issues/253) for more information.
@@ -139,32 +137,32 @@ See [Issue 219](https://github.com/SensorsIot/IOTstack/issues/219) and [Issue 25
139137

140138
This patch is **ONLY** for Raspbian Buster. Do **NOT** install this patch if you are running Raspbian Bullseye.
141139

142-
#### step 1: check your OS release
140+
1. check your OS release
143141

144-
Run the following command:
142+
Run the following command:
145143

146-
``` console
147-
$ grep "PRETTY_NAME" /etc/os-release
148-
PRETTY_NAME="Raspbian GNU/Linux 10 (buster)"
149-
```
144+
``` console
145+
$ grep "PRETTY_NAME" /etc/os-release
146+
PRETTY_NAME="Raspbian GNU/Linux 10 (buster)"
147+
```
150148

151-
If you see the word "buster", proceed to step 2. Otherwise, skip this patch.
149+
If you see the word "buster", proceed to step 2. Otherwise, skip this patch.
152150

153-
#### step 2: if you are indeed running "buster"
151+
2. if you are indeed running "buster"
154152

155-
Without this patch on Buster, Docker images will fail if:
153+
Without this patch on Buster, Docker images will fail if:
156154

157-
* the image is based on Alpine and the image's maintainer updates to [Alpine 3.13](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirement); and/or
158-
* an image's maintainer updates to a library that depends on 64-bit values for *Unix epoch time* (the so-called Y2038 problem).
155+
* the image is based on Alpine and the image's maintainer updates to [Alpine 3.13](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirement); and/or
156+
* an image's maintainer updates to a library that depends on 64-bit values for *Unix epoch time* (the so-called Y2038 problem).
159157

160-
To install the patch:
158+
To install the patch:
161159

162-
``` console
163-
$ sudo apt-key adv --keyserver hkps://keyserver.ubuntu.com:443 --recv-keys 04EE7237B7D453EC 648ACFD622F3D138
164-
$ echo "deb http://httpredir.debian.org/debian buster-backports main contrib non-free" | sudo tee -a "/etc/apt/sources.list.d/debian-backports.list"
165-
$ sudo apt update
166-
$ sudo apt install libseccomp2 -t buster-backports
167-
```
160+
``` console
161+
$ sudo apt-key adv --keyserver hkps://keyserver.ubuntu.com:443 --recv-keys 04EE7237B7D453EC 648ACFD622F3D138
162+
$ echo "deb http://httpredir.debian.org/debian buster-backports main contrib non-free" | sudo tee -a "/etc/apt/sources.list.d/debian-backports.list"
163+
$ sudo apt update
164+
$ sudo apt install libseccomp2 -t buster-backports
165+
```
168166

169167
### patch 3 - kernel control groups
170168

@@ -173,10 +171,11 @@ usage. This makes commands like `docker stats` fully work. Also needed for full
173171
monitoring of docker resource usage by the telegraf container.
174172

175173
Enable by running (takes effect after reboot):
176-
```
177-
echo $(cat /boot/cmdline.txt) cgroup_memory=1 cgroup_enable=memory | sudo tee /boot/cmdline.txt
178-
```
179174

175+
``` console
176+
$ echo $(cat /boot/cmdline.txt) cgroup_memory=1 cgroup_enable=memory | sudo tee /boot/cmdline.txt
177+
$ sudo reboot
178+
```
180179

181180
## the IOTstack menu
182181

@@ -501,33 +500,15 @@ You read this as two paths, separated by a colon. The:
501500
* external path is `./volumes/nodered/data`
502501
* internal path is `/data`
503502

504-
In this context, the leading "." means "the folder containing `docker-compose.yml`", so the external path is actually:
503+
In this context, the leading "." means "the folder containing`docker-compose.yml`", so the external path is actually:
505504

506505
* `~/IOTstack/volumes/nodered/data`
507506

508-
If a process running **inside** the container modifies any file or folder within:
509-
510-
```
511-
/data
512-
```
513-
514-
the change is mirrored **outside** the container at the same relative path within:
515-
516-
```
517-
~/IOTstack/volumes/nodered/data
518-
```
519-
520-
The same is true in reverse. Any change made to any file or folder **outside** the container within:
521-
522-
```
523-
~/IOTstack/volumes/nodered/data
524-
```
525-
526-
is mirrored at the same relative path **inside** the container at:
527-
528-
```
529-
/data
530-
```
507+
This type of volume is a
508+
[bind-mount](https://docs.docker.com/storage/bind-mounts/), where the
509+
container's internal path is directly linked to the external path. All
510+
file-system operations, reads and writes, are mapped to directly to the files
511+
and folders at the external path.
531512

532513
### deleting persistent data
533514

0 commit comments

Comments
 (0)