Skip to content

Commit ad26fae

Browse files
authored
Merge pull request #324 from Paraphraser/20210417-doco-gettingstarted
Documentation - Getting Started - Wiki rendering problem
2 parents ede12e0 + fdfea47 commit ad26fae

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/Getting-Started.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ IOTstack makes the following assumptions:
2121
$ sudo apt update
2222
$ sudo apt upgrade -y
2323
```
24-
24+
2525
3. You are logged-in as the user "pi"
2626
4. User "pi" has the user ID 1000
2727
5. The home directory for user "pi" is `/home/pi/`
@@ -40,7 +40,7 @@ The first five assumptions are Raspberry Pi defaults on a clean installation. Th
4040
```
4141
$ sudo apt install -y curl
4242
```
43-
43+
4444
2. Run the following command:
4545

4646
```
@@ -53,7 +53,7 @@ The first five assumptions are Raspberry Pi defaults on a clean installation. Th
5353
$ cd ~/IOTstack
5454
$ ./menu.sh
5555
```
56-
56+
5757
4. Bring up your stack:
5858

5959
```
@@ -68,39 +68,39 @@ The first five assumptions are Raspberry Pi defaults on a clean installation. Th
6868
```
6969
$ sudo apt install -y git
7070
```
71-
71+
7272
2. Clone IOTstack:
7373

7474
* If you want "new menu":
7575

7676
```
7777
$ git clone https://github.com/SensorsIot/IOTstack.git ~/IOTstack
7878
```
79-
79+
8080
* If you prefer "old menu":
8181

8282
```
8383
$ git clone -b old-menu https://github.com/SensorsIot/IOTstack.git ~/IOTstack
8484
```
85-
85+
8686
3. Run the menu and choose your containers:
8787

8888
```
8989
$ cd ~/IOTstack
9090
$ ./menu.sh
9191
```
92-
92+
9393
Note:
94-
94+
9595
* If you are running "old menu" for the first time, you will be guided to "Install Docker". That will end in a reboot, after which you should re-enter the menu and choose your containers.
96-
96+
9797
4. Bring up your stack:
9898

9999
```
100100
$ cd ~/IOTstack
101101
$ docker-compose up -d
102102
```
103-
103+
104104
### <a name="scriptedInstall"> scripted </a>
105105

106106
If you prefer to automate your installations using scripts, see:
@@ -161,9 +161,9 @@ Please try to minimise your use of `sudo` when you are working with IOTstack. He
161161
$ grep -c 'sudo' ~/IOTstack/menu.sh
162162
28
163163
```
164-
164+
165165
There are numerous uses of `sudo` within `menu.sh`. That means the designer thought about when `sudo` was needed.
166-
166+
167167
2. Did the command you **just executed** work without `sudo`? Note the emphasis on the past tense. If yes, then your work is done. If no, and the error suggests elevated privileges are necessary, then re-execute the last command like this:
168168

169169
```
@@ -336,14 +336,15 @@ To start the stack:
336336
$ cd ~/IOTstack
337337
$ docker-compose up -d «container»
338338
```
339+
339340
### <a name="downIOTstack"> stopping your IOTstack </a>
340341

341342
Stopping aka "downing" the stack stops and deletes all containers, and removes the internal network:
342-
343+
343344
```
344345
$ cd ~/IOTstack
345346
$ docker-compose down
346-
```
347+
```
347348

348349
To stop the stack without removing containers, run:
349350

@@ -361,7 +362,7 @@ $ cd ~/IOTstack
361362
$ docker-compose stop «container»
362363
```
363364

364-
This puts the container in a kind of suspended animation. You can resume the container with
365+
This puts the container in a kind of suspended animation. You can resume the container with
365366

366367
```
367368
$ cd ~/IOTstack
@@ -479,13 +480,13 @@ the change is mirrored **outside** the container at the same relative path withi
479480

480481
```
481482
~/IOTstack/volumes/nodered/data
482-
```
483+
```
483484

484485
The same is true in reverse. Any change made to any file or folder **outside** the container within:
485486

486487
```
487488
~/IOTstack/volumes/nodered/data
488-
```
489+
```
489490

490491
is mirrored at the same relative path **inside** the container at:
491492

@@ -553,7 +554,7 @@ There are two kinds of images used in IOTstack:
553554
The easiest way to work out which type of image you are looking at is to inspect the container's service definition in your `docker-compose.yml` file. If the service definition contains the:
554555

555556
* `image:` keyword then the image is **not** built using a Dockerfile.
556-
* `build:` keyword then the image **is** built using a Dockerfile.
557+
* `build:` keyword then the image **is** built using a Dockerfile.
557558

558559
#### <a name="updateNonDockerfile"> updating images not built from Dockerfiles </a>
559560

@@ -588,7 +589,7 @@ Node-RED also provides a good example of why your Dockerfile might change: if yo
588589

589590
Note:
590591

591-
* You can also add nodes to Node-RED using Manage Palette.
592+
* You can also add nodes to Node-RED using Manage Palette.
592593

593594
##### <a name="buildDockerfile"> when Dockerfile changes (*local* image only) </a>
594595

0 commit comments

Comments
 (0)