Skip to content

Commit 04572b1

Browse files
committed
docs: add Troubleshooting.md
Move "the nuclear option" from Getting Started. Resolves #180 adding github gists link
1 parent 4170273 commit 04572b1

File tree

3 files changed

+71
-46
lines changed

3 files changed

+71
-46
lines changed

docs/Basic_setup/Troubleshooting.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
2+
## Resources
3+
4+
* Search github [issues](https://github.com/SensorsIot/IOTstack/issues?q=).
5+
Note: Also closed issues or pull-requests may have valuable hints.
6+
7+
* Ask questions on [IOTStack Discord](https://discord.gg/ZpKHnks). Or report
8+
how you were able to fix a problem.
9+
10+
* There are over 40 gists about IOTstack. These address a diverse range of
11+
topics from small convenience scripts to complete guides. These are
12+
individual contributions that aren't reviewed.
13+
14+
You can add your own keywords into the search:
15+
[https://gist.github.com/search?q=iotstack](https://gist.github.com/search?q=iotstack)
16+
17+
## FAQ
18+
19+
!!! danger "Breaking update"
20+
A change done 2022-01-18 will require [manual steps](
21+
../Updates/migration-network-change.md)
22+
or you may get an error like:
23+
`ERROR: Service "influxdb" uses an undefined network "iotstack_nw"`
24+
25+
26+
## Getting a clean slate
27+
28+
If you create a mess and can't see how to recover, try proceeding like this:
29+
30+
``` console
31+
$ cd ~/IOTstack
32+
$ docker-compose down
33+
$ cd
34+
$ mv IOTstack IOTstack.old
35+
$ git clone https://github.com/SensorsIot/IOTstack.git IOTstack
36+
```
37+
38+
In words:
39+
40+
1. Be in the right directory.
41+
2. Take the stack down.
42+
3. The `cd` command without any arguments changes your working directory to
43+
your home directory (variously known as `~` or `$HOME` or `/home/pi`).
44+
4. Move your existing IOTstack directory out of the way. If you get a
45+
permissions problem:
46+
47+
* Re-try the command with `sudo`; and
48+
* Read [a word about the `sudo` command](What-is-sudo.md). Needing `sudo`
49+
in this situation is an example of over-using `sudo`.
50+
51+
5. Check out a clean copy of IOTstack.
52+
53+
Now, you have a clean slate and can start afresh by running the menu:
54+
55+
``` console
56+
$ cd ~/IOTstack
57+
$ ./menu.sh
58+
```
59+
60+
The `IOTstack.old` directory remains available as a reference for as long as
61+
you need it. Once you have no further use for it, you can clean it up via:
62+
63+
``` console
64+
$ cd
65+
$ sudo rm -rf ./IOTstack.old # (1)
66+
```
67+
68+
1. The `sudo` command is needed in this situation because some files and
69+
folders (eg the "volumes" directory and most of its contents) are owned by
70+
root.

docs/Basic_setup/index.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -738,49 +738,3 @@ To pin an image to a specific version:
738738
$ docker-compose up -d --build mosquitto
739739
```
740740

741-
## the nuclear option - use with caution
742-
743-
If you create a mess and can't see how to recover, try proceeding like this:
744-
745-
``` console
746-
$ cd ~/IOTstack
747-
$ docker-compose down
748-
$ cd
749-
$ mv IOTstack IOTstack.old
750-
$ git clone https://github.com/SensorsIot/IOTstack.git IOTstack
751-
```
752-
753-
In words:
754-
755-
1. Be in the right directory.
756-
2. Take the stack down.
757-
3. The `cd` command without any arguments changes your working directory to your home directory (variously known as `~` or `$HOME` or `/home/pi`).
758-
4. Move your existing IOTstack directory out of the way. If you get a permissions problem:
759-
760-
* Re-try the command with `sudo`; and
761-
* Read [a word about the `sudo` command](#a-word-about-the-sudo-command). Needing `sudo` in this situation is an example of over-using `sudo`.
762-
763-
5. Check out a clean copy of IOTstack.
764-
765-
Now, you have a clean slate. You can either start afresh by running the menu:
766-
767-
``` console
768-
$ cd ~/IOTstack
769-
$ ./menu.sh
770-
```
771-
772-
Alternatively, you can mix and match by making selective copies from the old directory. For example:
773-
774-
``` console
775-
$ cd
776-
$ cp IOTstack.old/docker-compose.yml IOTstack/
777-
```
778-
779-
The `IOTstack.old` directory remains available as a reference for as long as you need it. Once you have no further use for it, you can clean it up via:
780-
781-
``` console
782-
$ cd
783-
$ sudo rm -rf ./IOTstack.old
784-
```
785-
786-
The `sudo` command is needed in this situation because some files and folders (eg the "volumes" directory and most of its contents) are owned by root.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ theme:
2323
icon: material/weather-night
2424
name: Switch to light mode
2525
features:
26+
- content.code.annotate
2627
- tabs
2728
- navigation.tabs
2829
- navigation.tabs.sticky

0 commit comments

Comments
 (0)