Skip to content

Commit a8a37cf

Browse files
authored
Merge pull request #367 from Paraphraser/20210614-gettingStarted-master
Changes to "getting started" documentation - master branch
2 parents 30841f7 + 40792f2 commit a8a37cf

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

docs/Getting-Started.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ If you are still running on gcgarner/IOTstack and need to migrate to SensorsIot/
113113

114114
* [Migrating IOTstack from gcgarner to SensorsIot](./gcgarner-migration.md).
115115

116-
## <a name="recommendedPatches"> recommended system patch </a>
116+
## <a name="recommendedPatches"> recommended system patches </a>
117+
118+
### <a name="patch1DHCP"> patch 1 – restrict DHCP </a>
117119

118120
Run the following commands:
119121

@@ -124,6 +126,17 @@ $ sudo reboot
124126

125127
See [Issue 219](https://github.com/SensorsIot/IOTstack/issues/219) and [Issue 253](https://github.com/SensorsIot/IOTstack/issues/253) for more information.
126128

129+
### <a name="patch2DHCP"> patch 2 – update libseccomp2</a>
130+
131+
If you don't have this patch in place, Docker images that are based on Alpine will fail if an image's maintainer updates to [Alpine 3.13](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.13.0#time64_requirement).
132+
133+
```
134+
$ sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 04EE7237B7D453EC 648ACFD622F3D138
135+
$ echo "deb http://httpredir.debian.org/debian buster-backports main contrib non-free" | sudo tee -a "/etc/apt/sources.list.d/debian-backports.list"
136+
$ sudo apt update
137+
$ sudo apt install libseccomp2 -t buster-backports
138+
```
139+
127140
## <a name="aboutSudo"> a word about the `sudo` command </a>
128141

129142
Many first-time users of IOTstack get into difficulty by misusing the `sudo` command. The problem is best understood by example. In the following, you would expect `~` (tilde) to expand to `/home/pi`. It does:
@@ -237,6 +250,38 @@ The old and new menus differ in the options they offer. You should come back and
237250

238251
## <a name="switchingMenus"> switching menus </a>
239252

253+
At the time of writing, IOTstack supports three menus:
254+
255+
* "Old Menu" on the `old-menu` branch. This was inherited from [gcgarner/IOTstack](https://github.com/gcgarner/IOTstack).
256+
* "New Menu" on the `master` branch. This is the current menu.
257+
* "New New Menu" on the `experimental` branch. This is under development.
258+
259+
With a few precautions, you can switch between git branches as much as you like without breaking anything. The basic check you should perform is:
260+
261+
```
262+
$ cd ~/IOTstack
263+
$ git status
264+
```
265+
266+
Check the results to see if any files are marked as "modified". For example:
267+
268+
```
269+
modified: .templates/mosquitto/Dockerfile
270+
```
271+
272+
Key point:
273+
274+
* Files marked "untracked" do not matter. You only need to check for "modified" files because those have the potential to stop you from switching branches cleanly.
275+
276+
The way to avoid potential problems is to move any modified files to one side and restore the unmodified original. For example:
277+
278+
```
279+
$ mv .templates/mosquitto/Dockerfile .templates/mosquitto/Dockerfile.save
280+
$ git checkout -- .templates/mosquitto/Dockerfile
281+
```
282+
283+
When `git status` reports no more "modified" files, it is safe to switch your branch.
284+
240285
### <a name="menuMasterBranch"> current menu (master branch) </a>
241286

242287
```

0 commit comments

Comments
 (0)