Skip to content

Commit af0e650

Browse files
committed
docs: fix syntax and cleanup
1 parent 1c11384 commit af0e650

File tree

4 files changed

+21
-84
lines changed

4 files changed

+21
-84
lines changed

docs/Backup-and-Restore.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The backup command can be executed from IOTstack's menu, or from a cronjob.
88
To ensure that all your data is saved correctly, the stack should be brought down. This is mainly due to databases potentially being in a state that could cause data loss.
99

1010
There are 2 ways to run backups:
11+
1112
* From the menu: `Backup and Restore` > `Run backup`
1213
* Running the following command: `bash ./scripts/backup.sh`
1314

@@ -21,6 +22,7 @@ The current directory of bash must be in IOTstack's directory, to ensure that it
2122
```
2223
./scripts/backup.sh {TYPE=3} {USER=$(whoami)}
2324
```
25+
2426
* Types:
2527
* 1 = Backup with Date
2628
* A tarball file will be created that contains the date and time the backup was started, in the filename.
@@ -33,10 +35,12 @@ The current directory of bash must be in IOTstack's directory, to ensure that it
3335
If this parameter is not supplied when run as root, the script will ask for the username as input
3436

3537
Backups:
38+
3639
* You can find the backups in the ./backups/ folder. With rolling being in ./backups/rolling/ and date backups in ./backups/backup/
3740
* Log files can also be found in the ./backups/logs/ directory.
3841

3942
### Examples:
43+
4044
* `./scripts/backup.sh`
4145
* `./scripts/backup.sh 3`
4246

@@ -52,6 +56,7 @@ This will only produce a backup in the rollowing folder and change all the permi
5256

5357
## Restore
5458
There are 2 ways to run a restore:
59+
5560
* From the menu: `Backup and Restore` > `Restore from backup`
5661
* Running the following command: `bash ./scripts/restore.sh`
5762

@@ -64,6 +69,7 @@ There are 2 ways to run a restore:
6469
./scripts/restore.sh {FILENAME=backup.tar.gz} {noask}
6570
```
6671
The restore script takes 2 arguments:
72+
6773
* Filename: The name of the backup file. The file must be present in the `./backups/` directory, or a subfolder in it. That means it should be moved from `./backups/backup` to `./backups/`, or that you need to specify the `backup` portion of the directory (see examples)
6874
* NoAsk: If a second parameter is present, is acts as setting the no ask flag to true.
6975

docs/Containers/MariaDB.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# MariaDB
12
## Source
23

34
* [Docker hub](https://hub.docker.com/r/linuxserver/mariadb/)
@@ -59,6 +60,8 @@ You can open a terminal session within the mariadb container via:
5960
$ docker exec -it mariadb bash
6061
```
6162

63+
To connect to the database: `mysql -uroot -p`
64+
6265
To close the terminal session, either:
6366

6467
* type "exit" and press <kbd>return</kbd>; or

docs/Home.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

docs/Updating-the-Project.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Periodically updates are made to project which include new or modified container template, changes to backups or additional features. As these are released your local copy of this project will become out of date. This section deals with how to bring your project to the latest published state.
44

5-
Quick instructions:
5+
## Quick instructions
66

77
1. backup your current settings: `cp docker-compose.yml docker-compose.yml.bak`
88
2. check `git status` for any local changes you may have made to project files. Save and preserve your changes by doing a commit: `git commit -a -m "local customization"`. Or revert them using: `git checkout -- path/to/changed_file`.
@@ -12,21 +12,24 @@ Quick instructions:
1212
6. update running containers to latest: `docker-compose up --build -d`
1313

1414
*Troubleshooting:* if a container fails to restart after update
15+
1516
* try restarting the whole stack: `docker-compose restart`
1617
* backup your stack settings: `cp docker-compose.yml docker-compose.yml.bak`
1718
* Check log output of the failing service: `docker-compose logs *service-name*`
18-
* try googling and fixing problems in docker-compose.yml manually.
19+
* try googling and fixing problems in docker-compose.yml manually.
1920
* try recreating the failing service definition using menu.sh:
20-
* `./menu.sh`, select Build Stack, unselect the failing service, press enter
21-
to build, and then exit.
22-
* `./menu.sh`, select Build Stack, select the service back again, press enter
23-
to build, and then exit.
24-
* Try starting now: `docker-compose up -d`
25-
* Go to the IOTStack Discord and ask for help.
21+
1. `./menu.sh`, select Build Stack, unselect the failing service, press
22+
enter to build, and then exit.
23+
2. `./menu.sh`, select Build Stack, select the service back again, press
24+
enter to build, and then exit.
25+
3. Try starting now: `docker-compose up -d`
26+
* Go to the [IOTStack Discord](https://discord.gg/ZpKHnks) and describe your
27+
problem. We're happy to help.
2628

2729
## Details, partly outdated
2830

29-
**If you ran the git checkout -- 'git ls-files -m' as suggested in the old wiki entry then please check your duck.sh because it removed your domain and token**
31+
!!! warning
32+
If you ran `git checkout -- 'git ls-files -m'` as suggested in the old wiki entry then please check your duck.sh because it removed your domain and token
3033

3134
Git offers build in functionality to fetch the latest changes.
3235

0 commit comments

Comments
 (0)