diff --git a/docs/Backup-and-Restore.md b/docs/Backup-and-Restore.md index 3dae4ab19..48de688a1 100755 --- a/docs/Backup-and-Restore.md +++ b/docs/Backup-and-Restore.md @@ -8,6 +8,7 @@ The backup command can be executed from IOTstack's menu, or from a cronjob. 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. There are 2 ways to run backups: + * From the menu: `Backup and Restore` > `Run backup` * Running the following command: `bash ./scripts/backup.sh` @@ -21,6 +22,7 @@ The current directory of bash must be in IOTstack's directory, to ensure that it ``` ./scripts/backup.sh {TYPE=3} {USER=$(whoami)} ``` + * Types: * 1 = Backup with Date * 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 If this parameter is not supplied when run as root, the script will ask for the username as input Backups: + * You can find the backups in the ./backups/ folder. With rolling being in ./backups/rolling/ and date backups in ./backups/backup/ * Log files can also be found in the ./backups/logs/ directory. ### Examples: + * `./scripts/backup.sh` * `./scripts/backup.sh 3` @@ -52,6 +56,7 @@ This will only produce a backup in the rollowing folder and change all the permi ## Restore There are 2 ways to run a restore: + * From the menu: `Backup and Restore` > `Restore from backup` * Running the following command: `bash ./scripts/restore.sh` @@ -64,6 +69,7 @@ There are 2 ways to run a restore: ./scripts/restore.sh {FILENAME=backup.tar.gz} {noask} ``` The restore script takes 2 arguments: + * 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) * NoAsk: If a second parameter is present, is acts as setting the no ask flag to true. diff --git a/docs/Containers/MariaDB.md b/docs/Containers/MariaDB.md index 6f89b82b4..90a3739dd 100644 --- a/docs/Containers/MariaDB.md +++ b/docs/Containers/MariaDB.md @@ -1,3 +1,4 @@ +# MariaDB ## Source * [Docker hub](https://hub.docker.com/r/linuxserver/mariadb/) @@ -59,6 +60,8 @@ You can open a terminal session within the mariadb container via: $ docker exec -it mariadb bash ``` +To connect to the database: `mysql -uroot -p` + To close the terminal session, either: * type "exit" and press return; or diff --git a/docs/Home.md b/docs/Home.md deleted file mode 100644 index a78332df9..000000000 --- a/docs/Home.md +++ /dev/null @@ -1,75 +0,0 @@ -# Wiki - -The README is moving to the Wiki, It's easier to add content and example to the Wiki vs the README.md - -* [Getting Started](https://sensorsiot.github.io/IOTstack/Getting-Started) -* [Updating the project](https://sensorsiot.github.io/IOTstack/Updating-the-Project) -* [How the script works](https://sensorsiot.github.io/IOTstack/How-the-script-works) -* [Understanding Containers](https://sensorsiot.github.io/IOTstack/Understanding-Containers) - -*** - -# Docker - -* [Commands](https://sensorsiot.github.io/IOTstack/Docker-commands) -* [Docker Networks](https://sensorsiot.github.io/IOTstack/Networking) - -*** - -# Containers -* [Portainer](https://sensorsiot.github.io/IOTstack/Containers/Portainer) -* [Portainer-ce](https://sensorsiot.github.io/IOTstack/Containers/Portainer-ce) -* [Portainer Agent](https://sensorsiot.github.io/IOTstack/Containers/Portainer-agent) -* [Node-RED](https://sensorsiot.github.io/IOTstack/Containers/Node-RED) -* [Grafana](https://sensorsiot.github.io/IOTstack/Containers/Grafana) -* [Mosquitto](https://sensorsiot.github.io/IOTstack/Containers/Mosquitto) -* [PostgreSQL](https://sensorsiot.github.io/IOTstack/Containers/PostgreSQL) -* [Adminer](https://sensorsiot.github.io/IOTstack/Containers/Adminer) -* [openHAB](https://sensorsiot.github.io/IOTstack/Containers/openHAB) -* [Home Assistant](https://sensorsiot.github.io/IOTstack/Containers/Home-Assistant) -* [Pi-Hole](https://sensorsiot.github.io/IOTstack/Containers/Pi-hole) -* [zigbee2MQTT](https://sensorsiot.github.io/IOTstack/Containers/Zigbee2MQTT) -* [Plex](https://sensorsiot.github.io/IOTstack/Containers/Plex) -* [TasmoAdmin](https://sensorsiot.github.io/IOTstack/Containers/TasmoAdmin) -* [RTL_433](https://sensorsiot.github.io/IOTstack/Containers/RTL_433-docker) -* [EspruinoHub (testing)](https://sensorsiot.github.io/IOTstack/Containers/EspruinoHub) -* [Next-Cloud](https://sensorsiot.github.io/IOTstack/Containers/NextCloud) -* [MariaDB](https://sensorsiot.github.io/IOTstack/Containers/MariaDB) -* [MotionEye](https://sensorsiot.github.io/IOTstack/Containers/MotionEye) -* [Blynk Server](https://sensorsiot.github.io/IOTstack/Containers/Blynk_server) -* [diyHue](https://sensorsiot.github.io/IOTstack/Containers/diyHue) -* [Python](https://sensorsiot.github.io/IOTstack/Containers/Python) -* [Heimdall](https://sensorsiot.github.io/IOTstack/Containers/Heimdall) -* [DashMachine](https://sensorsiot.github.io/IOTstack/Containers/DashMachine) -* [Homer](https://sensorsiot.github.io/IOTstack/Containers/Homer) -* [Custom containers](https://sensorsiot.github.io/IOTstack/Containers/Custom) - -*** - -# Native installs - -* [RTL_433](https://sensorsiot.github.io/IOTstack/Native-RTL_433) -* [RPIEasy](https://sensorsiot.github.io/IOTstack/RPIEasy_native) - -*** - -# Backups - -* [Docker backups](https://sensorsiot.github.io/IOTstack/Backup-and-Restore) -* Recovery (coming soon) -*** - -# Remote Access - -* [VPN and Dynamic DNS](https://sensorsiot.github.io/IOTstack/Accessing-your-Device-from-the-internet) -* [x2go](https://sensorsiot.github.io/IOTstack/Containers/x2go) - -*** - -# Miscellaneous - -* [log2ram](https://sensorsiot.github.io/IOTstack/Misc) -* [Dropbox-Uploader](https://sensorsiot.github.io/IOTstack/Misc) - -*** - diff --git a/docs/Updating-the-Project.md b/docs/Updating-the-Project.md index 5b495e66e..93654c185 100644 --- a/docs/Updating-the-Project.md +++ b/docs/Updating-the-Project.md @@ -2,7 +2,7 @@ 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. -Quick instructions: +## Quick instructions 1. backup your current settings: `cp docker-compose.yml docker-compose.yml.bak` 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: 6. update running containers to latest: `docker-compose up --build -d` *Troubleshooting:* if a container fails to restart after update + * try restarting the whole stack: `docker-compose restart` * backup your stack settings: `cp docker-compose.yml docker-compose.yml.bak` * Check log output of the failing service: `docker-compose logs *service-name*` - * try googling and fixing problems in docker-compose.yml manually. + * try googling and fixing problems in docker-compose.yml manually. * try recreating the failing service definition using menu.sh: - * `./menu.sh`, select Build Stack, unselect the failing service, press enter - to build, and then exit. - * `./menu.sh`, select Build Stack, select the service back again, press enter - to build, and then exit. - * Try starting now: `docker-compose up -d` -* Go to the IOTStack Discord and ask for help. + 1. `./menu.sh`, select Build Stack, unselect the failing service, press + enter to build, and then exit. + 2. `./menu.sh`, select Build Stack, select the service back again, press + enter to build, and then exit. + 3. Try starting now: `docker-compose up -d` +* Go to the [IOTStack Discord](https://discord.gg/ZpKHnks) and describe your + problem. We're happy to help. ## Details, partly outdated -**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** +!!! warning + 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 Git offers build in functionality to fetch the latest changes.