From 4102ca1d3f4690543fe2a2df41187e8ce305373a Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:14:04 +0200 Subject: [PATCH 01/15] update to docs location and place --- docs/Adminer.md | 4 ++ docs/Backups/.pages | 1 + docs/{ => Backups}/Backups.md | 0 docs/Blynk_server.md | 3 + docs/Docker/.pages | 1 + docs/{ => Docker}/Docker-commands.md | 0 docs/{ => Docker}/Networking.md | 0 docs/{ => Docker}/Understanding-Containers.md | 0 docs/EspruinoHub.md | 3 + docs/Grafana.md | 3 + docs/Home-Assistant.md | 3 + docs/Home.md | 71 ------------------- docs/InfluxDB.md | 3 + docs/MariaDB.md | 4 ++ docs/Mosquitto.md | 3 + docs/MotionEye.md | 3 + docs/Native installs/.pages | 1 + docs/{ => Native installs}/Native-RTL_433.md | 0 docs/{ => Native installs}/RPIEasy_native.md | 0 docs/NextCloud.md | 3 + docs/Node-RED.md | 3 + docs/Pi-hole.md | 3 + docs/Plex.md | 3 + docs/Portainer-agent.md | 3 + docs/Portainer.md | 3 + docs/PostgreSQL.md | 3 + docs/Python.md | 3 + docs/RTL_433-docker.md | 3 + ...Accessing-your-Device-from-the-internet.md | 0 docs/{ => Remote Access}/x2go.md | 3 + docs/TasmoAdmin.md | 3 + docs/Zigbee2MQTT.md | 3 + docs/deconz.md | 3 + docs/diyHue.md | 3 + docs/openHAB.md | 3 + mkdocs.yml | 6 ++ 36 files changed, 83 insertions(+), 71 deletions(-) create mode 100644 docs/Backups/.pages rename docs/{ => Backups}/Backups.md (100%) create mode 100644 docs/Docker/.pages rename docs/{ => Docker}/Docker-commands.md (100%) rename docs/{ => Docker}/Networking.md (100%) rename docs/{ => Docker}/Understanding-Containers.md (100%) delete mode 100644 docs/Home.md create mode 100644 docs/Native installs/.pages rename docs/{ => Native installs}/Native-RTL_433.md (100%) rename docs/{ => Native installs}/RPIEasy_native.md (100%) rename docs/{ => Remote Access}/Accessing-your-Device-from-the-internet.md (100%) rename docs/{ => Remote Access}/x2go.md (97%) diff --git a/docs/Adminer.md b/docs/Adminer.md index 2df6a824..67e7e34d 100644 --- a/docs/Adminer.md +++ b/docs/Adminer.md @@ -1,3 +1,7 @@ +--- +title: Adminer +--- + # Adminer ## References - [Docker](https://hub.docker.com/_/adminer) diff --git a/docs/Backups/.pages b/docs/Backups/.pages new file mode 100644 index 00000000..31e7395a --- /dev/null +++ b/docs/Backups/.pages @@ -0,0 +1 @@ +title: Backups \ No newline at end of file diff --git a/docs/Backups.md b/docs/Backups/Backups.md similarity index 100% rename from docs/Backups.md rename to docs/Backups/Backups.md diff --git a/docs/Blynk_server.md b/docs/Blynk_server.md index e255d518..78f63cd8 100644 --- a/docs/Blynk_server.md +++ b/docs/Blynk_server.md @@ -1,3 +1,6 @@ +--- +title: Blynk server +--- # Blynk server This is a custom implementation of Blynk Server diff --git a/docs/Docker/.pages b/docs/Docker/.pages new file mode 100644 index 00000000..313e05ce --- /dev/null +++ b/docs/Docker/.pages @@ -0,0 +1 @@ +title: Docker \ No newline at end of file diff --git a/docs/Docker-commands.md b/docs/Docker/Docker-commands.md similarity index 100% rename from docs/Docker-commands.md rename to docs/Docker/Docker-commands.md diff --git a/docs/Networking.md b/docs/Docker/Networking.md similarity index 100% rename from docs/Networking.md rename to docs/Docker/Networking.md diff --git a/docs/Understanding-Containers.md b/docs/Docker/Understanding-Containers.md similarity index 100% rename from docs/Understanding-Containers.md rename to docs/Docker/Understanding-Containers.md diff --git a/docs/EspruinoHub.md b/docs/EspruinoHub.md index 215a0de5..9590c1a1 100644 --- a/docs/EspruinoHub.md +++ b/docs/EspruinoHub.md @@ -1,3 +1,6 @@ +--- +title: Espruinohub +--- # Espruinohub This is a testing container diff --git a/docs/Grafana.md b/docs/Grafana.md index 824dd8e8..c1908f5f 100644 --- a/docs/Grafana.md +++ b/docs/Grafana.md @@ -1,3 +1,6 @@ +--- +title: Grafana +--- # Grafana ## References diff --git a/docs/Home-Assistant.md b/docs/Home-Assistant.md index 40f4d679..21d8d6ee 100644 --- a/docs/Home-Assistant.md +++ b/docs/Home-Assistant.md @@ -1,3 +1,6 @@ +--- +title: Home assistant +--- # Home assistant ## References - [Docker](https://hub.docker.com/r/homeassistant/home-assistant/) diff --git a/docs/Home.md b/docs/Home.md deleted file mode 100644 index dc8fdafc..00000000 --- a/docs/Home.md +++ /dev/null @@ -1,71 +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://github.com/SensorsIot/IOTstack/wiki/Getting-Started) -* [Updating the project](https://github.com/SensorsIot/IOTstack/wiki/Updating-the-Project) -* [How the script works](https://github.com/SensorsIot/IOTstack/wiki/How-the-script-works) -* [Understanding Containers](https://github.com/SensorsIot/IOTstack/wiki/Understanding-Containers) - -*** - -# Docker - -* [Commands](https://github.com/SensorsIot/IOTstack/wiki/Docker-commands) -* [Docker Networks](https://github.com/SensorsIot/IOTstack/wiki/Networking) - -*** - -# Containers -* [Portainer](https://github.com/SensorsIot/IOTstack/wiki/Portainer) -* [Portainer Agent](https://github.com/SensorsIot/IOTstack/wiki/Portainer-agent) -* [Node-RED](https://github.com/SensorsIot/IOTstack/wiki/Node-RED) -* [Grafana](https://github.com/SensorsIot/IOTstack/wiki/Grafana) -* [Mosquitto](https://github.com/SensorsIot/IOTstack/wiki/Mosquitto) -* [PostgreSQL](https://github.com/SensorsIot/IOTstack/wiki/PostgreSQL) -* [Adminer](https://github.com/SensorsIot/IOTstack/wiki/Adminer) -* [openHAB](https://github.com/SensorsIot/IOTstack/wiki/openHAB) -* [Home Assistant](https://github.com/SensorsIot/IOTstack/wiki/Home-Assistant) -* [Pi-Hole](https://github.com/SensorsIot/IOTstack/wiki/Pi-hole) -* [zigbee2MQTT](https://github.com/SensorsIot/IOTstack/wiki/Zigbee2MQTT) -* [Plex](https://github.com/SensorsIot/IOTstack/wiki/Plex) -* [TasmoAdmin](https://github.com/SensorsIot/IOTstack/wiki/TasmoAdmin) -* [RTL_433](https://github.com/SensorsIot/IOTstack/wiki/RTL_433-docker) -* [EspruinoHub (testing)](https://github.com/SensorsIot/IOTstack/wiki/EspruinoHub) -* [Next-Cloud](https://github.com/SensorsIot/IOTstack/wiki/NextCloud) -* [MariaDB](https://github.com/SensorsIot/IOTstack/wiki/MariaDB) -* [MotionEye](https://github.com/SensorsIot/IOTstack/wiki/MotionEye) -* [Blynk Server](https://github.com/SensorsIot/IOTstack/wiki/Blynk_server) -* [diyHue](https://github.com/SensorsIot/IOTstack/wiki/diyHue) -* [Python](https://github.com/SensorsIot/IOTstack/wiki/Python) -* [Custom containers](https://github.com/SensorsIot/IOTstack/wiki/Custom) - -*** - -# Native installs - -* [RTL_433](https://github.com/SensorsIot/IOTstack/wiki/Native-RTL_433) -* [RPIEasy](https://github.com/SensorsIot/IOTstack/wiki/RPIEasy_native) - -*** - -# Backups - -* [Docker backups](https://github.com/SensorsIot/IOTstack/wiki/Backups) -* Recovery (coming soon) -*** - -# Remote Access - -* [VPN and Dynamic DNS](https://github.com/SensorsIot/IOTstack/wiki/Accessing-your-Device-from-the-internet) -* [x2go](https://github.com/SensorsIot/IOTstack/wiki/x2go) - -*** - -# Miscellaneous - -* [log2ram](https://github.com/SensorsIot/IOTstack/wiki/Misc) -* [Dropbox-Uploader](https://github.com/SensorsIot/IOTstack/wiki/Misc) - -*** - diff --git a/docs/InfluxDB.md b/docs/InfluxDB.md index 4f714771..6551520c 100644 --- a/docs/InfluxDB.md +++ b/docs/InfluxDB.md @@ -1,3 +1,6 @@ +--- +title: InfluxDB +--- # InfluxDB ## References - [Docker](https://hub.docker.com/_/influxdb) diff --git a/docs/MariaDB.md b/docs/MariaDB.md index 0b2408ac..700e1546 100644 --- a/docs/MariaDB.md +++ b/docs/MariaDB.md @@ -1,3 +1,7 @@ +--- +title: MariaDB +--- +# MariaDB ## Source * [Docker hub](https://hub.docker.com/r/linuxserver/mariadb/) * [Webpage](https://mariadb.org/) diff --git a/docs/Mosquitto.md b/docs/Mosquitto.md index 05a197e2..206302e6 100644 --- a/docs/Mosquitto.md +++ b/docs/Mosquitto.md @@ -1,3 +1,6 @@ +--- +title: Mosquitto +--- # Mosquitto ## References - [Docker](https://hub.docker.com/_/eclipse-mosquitto) diff --git a/docs/MotionEye.md b/docs/MotionEye.md index 920cada6..6dca6e00 100644 --- a/docs/MotionEye.md +++ b/docs/MotionEye.md @@ -1,3 +1,6 @@ +--- +title: MotionQye +--- # MotionQye ## References diff --git a/docs/Native installs/.pages b/docs/Native installs/.pages new file mode 100644 index 00000000..f124b234 --- /dev/null +++ b/docs/Native installs/.pages @@ -0,0 +1 @@ +title: Native installs \ No newline at end of file diff --git a/docs/Native-RTL_433.md b/docs/Native installs/Native-RTL_433.md similarity index 100% rename from docs/Native-RTL_433.md rename to docs/Native installs/Native-RTL_433.md diff --git a/docs/RPIEasy_native.md b/docs/Native installs/RPIEasy_native.md similarity index 100% rename from docs/RPIEasy_native.md rename to docs/Native installs/RPIEasy_native.md diff --git a/docs/NextCloud.md b/docs/NextCloud.md index ae473839..d4372f3c 100644 --- a/docs/NextCloud.md +++ b/docs/NextCloud.md @@ -1,3 +1,6 @@ +--- +title: Next Cloud +--- # Next Cloud ## DO NOT EXPOSE PORT 80 TO THE WEB diff --git a/docs/Node-RED.md b/docs/Node-RED.md index ee4cb179..b54ca9e0 100644 --- a/docs/Node-RED.md +++ b/docs/Node-RED.md @@ -1,3 +1,6 @@ +--- +title: Node-RED +--- # Node-RED ## References - [Docker](https://hub.docker.com/r/nodered/node-red) diff --git a/docs/Pi-hole.md b/docs/Pi-hole.md index 7842f79b..c5216bcb 100644 --- a/docs/Pi-hole.md +++ b/docs/Pi-hole.md @@ -1,3 +1,6 @@ +--- +title: Pi-hole +--- # Pi-hole Pi-hole is a fantastic utility to reduce ads diff --git a/docs/Plex.md b/docs/Plex.md index 7b196995..8c68b55b 100644 --- a/docs/Plex.md +++ b/docs/Plex.md @@ -1,3 +1,6 @@ +--- +title: Plex +--- # Plex ## References * [Homepage](https://www.plex.tv/) diff --git a/docs/Portainer-agent.md b/docs/Portainer-agent.md index 0fbaf182..d41237b1 100644 --- a/docs/Portainer-agent.md +++ b/docs/Portainer-agent.md @@ -1,3 +1,6 @@ +--- +title: Portainer agent +--- # Portainer agent ## References - [Docker](https://hub.docker.com/r/portainer/agent) diff --git a/docs/Portainer.md b/docs/Portainer.md index 14afb0f1..a0a77008 100644 --- a/docs/Portainer.md +++ b/docs/Portainer.md @@ -1,3 +1,6 @@ +--- +title: Portainer +--- # Portainer ## References - [Docker](https://hub.docker.com/r/portainer/portainer/) diff --git a/docs/PostgreSQL.md b/docs/PostgreSQL.md index 8452f03b..29c87ca0 100644 --- a/docs/PostgreSQL.md +++ b/docs/PostgreSQL.md @@ -1,3 +1,6 @@ +--- +title: PostgreSQL +--- # PostgreSQL ## References - [Docker](https://hub.docker.com/_/postgres) diff --git a/docs/Python.md b/docs/Python.md index 5948dcb8..6a8dcbe9 100644 --- a/docs/Python.md +++ b/docs/Python.md @@ -1,3 +1,6 @@ +--- +title: Python +--- # Python * [Docker hub](https://hub.docker.com/_/python) diff --git a/docs/RTL_433-docker.md b/docs/RTL_433-docker.md index 2df2016b..b65e48c1 100644 --- a/docs/RTL_433-docker.md +++ b/docs/RTL_433-docker.md @@ -1,3 +1,6 @@ +--- +title: RTL_433 +--- # RTL_433 Docker Requirements, you will need to have a SDR dongle for you to be able to use RTL. I've tested this with a RTL2838 diff --git a/docs/Accessing-your-Device-from-the-internet.md b/docs/Remote Access/Accessing-your-Device-from-the-internet.md similarity index 100% rename from docs/Accessing-your-Device-from-the-internet.md rename to docs/Remote Access/Accessing-your-Device-from-the-internet.md diff --git a/docs/x2go.md b/docs/Remote Access/x2go.md similarity index 97% rename from docs/x2go.md rename to docs/Remote Access/x2go.md index 6983ac05..ed7af812 100644 --- a/docs/x2go.md +++ b/docs/Remote Access/x2go.md @@ -1,3 +1,6 @@ +--- +title: x2go +--- # x2go x2go is an "alternative" to using VNC for a remote connection. It uses X11 forwarding over ssh to provide a desktop environment diff --git a/docs/TasmoAdmin.md b/docs/TasmoAdmin.md index 2d2c3c1e..ac3e25cc 100644 --- a/docs/TasmoAdmin.md +++ b/docs/TasmoAdmin.md @@ -1,3 +1,6 @@ +--- +title: TasmoAdmin +--- # TasmoAdmin ## References * [Homepage](https://github.com/arendst/Tasmota/wiki/TasmoAdmin) diff --git a/docs/Zigbee2MQTT.md b/docs/Zigbee2MQTT.md index df958533..dd0ea4d8 100644 --- a/docs/Zigbee2MQTT.md +++ b/docs/Zigbee2MQTT.md @@ -1,3 +1,6 @@ +--- +title: Zigbe2MQTT +--- # Zigbe2MQTT * [Web Guide](https://www.zigbee2mqtt.io/information/docker.html) diff --git a/docs/deconz.md b/docs/deconz.md index b7c7335a..41ce9368 100644 --- a/docs/deconz.md +++ b/docs/deconz.md @@ -1,3 +1,6 @@ +--- +title: deCONZ +--- # deCONZ ## References - [Docker](https://hub.docker.com/r/marthoc/deconz) diff --git a/docs/diyHue.md b/docs/diyHue.md index 6fe62078..98e58a02 100644 --- a/docs/diyHue.md +++ b/docs/diyHue.md @@ -1,3 +1,6 @@ +--- +title: DIY hue +--- # DIY hue * [website](https://diyhue.org/getting-started/) diff --git a/docs/openHAB.md b/docs/openHAB.md index b289e48b..4660fcb2 100644 --- a/docs/openHAB.md +++ b/docs/openHAB.md @@ -1,3 +1,6 @@ +--- +title: Openhab +--- # Openhab ## References - [Docker](https://hub.docker.com/r/openhab/openhab/) diff --git a/mkdocs.yml b/mkdocs.yml index ef1e5725..1b18f1f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,3 +2,9 @@ site_name: IOTstack site_description: 'Docker stack for getting started on IOT on the Raspberry PI' theme: name: material + features: + - tabs + plugins: + - search + - awsome-pages + - git-authors From e899aca6d9888590ba52ddafa3393340d447bade Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:18:22 +0200 Subject: [PATCH 02/15] removed meta from pages --- docs/Containers/Adminer.md | 4 ---- docs/Containers/Blynk_server.md | 3 --- docs/Containers/EspruinoHub.md | 3 --- docs/Containers/Grafana.md | 3 --- docs/Containers/Home-Assistant.md | 3 --- docs/Containers/InfluxDB.md | 3 --- docs/Containers/MariaDB.md | 3 --- docs/Containers/Mosquitto.md | 3 --- docs/Containers/MotionEye.md | 3 --- docs/Containers/NextCloud.md | 3 --- docs/Containers/Node-RED.md | 3 --- docs/Containers/Pi-hole.md | 3 --- docs/Containers/Plex.md | 3 --- docs/Containers/Portainer-agent.md | 3 --- docs/Containers/Portainer.md | 3 --- docs/Containers/PostgreSQL.md | 3 --- docs/Containers/Python.md | 3 --- docs/Containers/RTL_433-docker.md | 3 --- docs/Containers/TasmoAdmin.md | 3 --- docs/Containers/Zigbee2MQTT.md | 3 --- docs/Containers/deconz.md | 3 --- docs/Containers/diyHue.md | 3 --- docs/Containers/openHAB.md | 3 --- docs/Containers/x2go.md | 24 ------------------------ 24 files changed, 94 deletions(-) delete mode 100644 docs/Containers/x2go.md diff --git a/docs/Containers/Adminer.md b/docs/Containers/Adminer.md index 67e7e34d..2df6a824 100644 --- a/docs/Containers/Adminer.md +++ b/docs/Containers/Adminer.md @@ -1,7 +1,3 @@ ---- -title: Adminer ---- - # Adminer ## References - [Docker](https://hub.docker.com/_/adminer) diff --git a/docs/Containers/Blynk_server.md b/docs/Containers/Blynk_server.md index 78f63cd8..e255d518 100644 --- a/docs/Containers/Blynk_server.md +++ b/docs/Containers/Blynk_server.md @@ -1,6 +1,3 @@ ---- -title: Blynk server ---- # Blynk server This is a custom implementation of Blynk Server diff --git a/docs/Containers/EspruinoHub.md b/docs/Containers/EspruinoHub.md index 9590c1a1..215a0de5 100644 --- a/docs/Containers/EspruinoHub.md +++ b/docs/Containers/EspruinoHub.md @@ -1,6 +1,3 @@ ---- -title: Espruinohub ---- # Espruinohub This is a testing container diff --git a/docs/Containers/Grafana.md b/docs/Containers/Grafana.md index c1908f5f..824dd8e8 100644 --- a/docs/Containers/Grafana.md +++ b/docs/Containers/Grafana.md @@ -1,6 +1,3 @@ ---- -title: Grafana ---- # Grafana ## References diff --git a/docs/Containers/Home-Assistant.md b/docs/Containers/Home-Assistant.md index 21d8d6ee..40f4d679 100644 --- a/docs/Containers/Home-Assistant.md +++ b/docs/Containers/Home-Assistant.md @@ -1,6 +1,3 @@ ---- -title: Home assistant ---- # Home assistant ## References - [Docker](https://hub.docker.com/r/homeassistant/home-assistant/) diff --git a/docs/Containers/InfluxDB.md b/docs/Containers/InfluxDB.md index 6551520c..4f714771 100644 --- a/docs/Containers/InfluxDB.md +++ b/docs/Containers/InfluxDB.md @@ -1,6 +1,3 @@ ---- -title: InfluxDB ---- # InfluxDB ## References - [Docker](https://hub.docker.com/_/influxdb) diff --git a/docs/Containers/MariaDB.md b/docs/Containers/MariaDB.md index 700e1546..01a094f2 100644 --- a/docs/Containers/MariaDB.md +++ b/docs/Containers/MariaDB.md @@ -1,6 +1,3 @@ ---- -title: MariaDB ---- # MariaDB ## Source * [Docker hub](https://hub.docker.com/r/linuxserver/mariadb/) diff --git a/docs/Containers/Mosquitto.md b/docs/Containers/Mosquitto.md index 206302e6..05a197e2 100644 --- a/docs/Containers/Mosquitto.md +++ b/docs/Containers/Mosquitto.md @@ -1,6 +1,3 @@ ---- -title: Mosquitto ---- # Mosquitto ## References - [Docker](https://hub.docker.com/_/eclipse-mosquitto) diff --git a/docs/Containers/MotionEye.md b/docs/Containers/MotionEye.md index 6dca6e00..920cada6 100644 --- a/docs/Containers/MotionEye.md +++ b/docs/Containers/MotionEye.md @@ -1,6 +1,3 @@ ---- -title: MotionQye ---- # MotionQye ## References diff --git a/docs/Containers/NextCloud.md b/docs/Containers/NextCloud.md index d4372f3c..ae473839 100644 --- a/docs/Containers/NextCloud.md +++ b/docs/Containers/NextCloud.md @@ -1,6 +1,3 @@ ---- -title: Next Cloud ---- # Next Cloud ## DO NOT EXPOSE PORT 80 TO THE WEB diff --git a/docs/Containers/Node-RED.md b/docs/Containers/Node-RED.md index b54ca9e0..ee4cb179 100644 --- a/docs/Containers/Node-RED.md +++ b/docs/Containers/Node-RED.md @@ -1,6 +1,3 @@ ---- -title: Node-RED ---- # Node-RED ## References - [Docker](https://hub.docker.com/r/nodered/node-red) diff --git a/docs/Containers/Pi-hole.md b/docs/Containers/Pi-hole.md index c5216bcb..7842f79b 100644 --- a/docs/Containers/Pi-hole.md +++ b/docs/Containers/Pi-hole.md @@ -1,6 +1,3 @@ ---- -title: Pi-hole ---- # Pi-hole Pi-hole is a fantastic utility to reduce ads diff --git a/docs/Containers/Plex.md b/docs/Containers/Plex.md index 8c68b55b..7b196995 100644 --- a/docs/Containers/Plex.md +++ b/docs/Containers/Plex.md @@ -1,6 +1,3 @@ ---- -title: Plex ---- # Plex ## References * [Homepage](https://www.plex.tv/) diff --git a/docs/Containers/Portainer-agent.md b/docs/Containers/Portainer-agent.md index d41237b1..0fbaf182 100644 --- a/docs/Containers/Portainer-agent.md +++ b/docs/Containers/Portainer-agent.md @@ -1,6 +1,3 @@ ---- -title: Portainer agent ---- # Portainer agent ## References - [Docker](https://hub.docker.com/r/portainer/agent) diff --git a/docs/Containers/Portainer.md b/docs/Containers/Portainer.md index a0a77008..14afb0f1 100644 --- a/docs/Containers/Portainer.md +++ b/docs/Containers/Portainer.md @@ -1,6 +1,3 @@ ---- -title: Portainer ---- # Portainer ## References - [Docker](https://hub.docker.com/r/portainer/portainer/) diff --git a/docs/Containers/PostgreSQL.md b/docs/Containers/PostgreSQL.md index 29c87ca0..8452f03b 100644 --- a/docs/Containers/PostgreSQL.md +++ b/docs/Containers/PostgreSQL.md @@ -1,6 +1,3 @@ ---- -title: PostgreSQL ---- # PostgreSQL ## References - [Docker](https://hub.docker.com/_/postgres) diff --git a/docs/Containers/Python.md b/docs/Containers/Python.md index 6a8dcbe9..5948dcb8 100644 --- a/docs/Containers/Python.md +++ b/docs/Containers/Python.md @@ -1,6 +1,3 @@ ---- -title: Python ---- # Python * [Docker hub](https://hub.docker.com/_/python) diff --git a/docs/Containers/RTL_433-docker.md b/docs/Containers/RTL_433-docker.md index b65e48c1..2df2016b 100644 --- a/docs/Containers/RTL_433-docker.md +++ b/docs/Containers/RTL_433-docker.md @@ -1,6 +1,3 @@ ---- -title: RTL_433 ---- # RTL_433 Docker Requirements, you will need to have a SDR dongle for you to be able to use RTL. I've tested this with a RTL2838 diff --git a/docs/Containers/TasmoAdmin.md b/docs/Containers/TasmoAdmin.md index ac3e25cc..2d2c3c1e 100644 --- a/docs/Containers/TasmoAdmin.md +++ b/docs/Containers/TasmoAdmin.md @@ -1,6 +1,3 @@ ---- -title: TasmoAdmin ---- # TasmoAdmin ## References * [Homepage](https://github.com/arendst/Tasmota/wiki/TasmoAdmin) diff --git a/docs/Containers/Zigbee2MQTT.md b/docs/Containers/Zigbee2MQTT.md index dd0ea4d8..df958533 100644 --- a/docs/Containers/Zigbee2MQTT.md +++ b/docs/Containers/Zigbee2MQTT.md @@ -1,6 +1,3 @@ ---- -title: Zigbe2MQTT ---- # Zigbe2MQTT * [Web Guide](https://www.zigbee2mqtt.io/information/docker.html) diff --git a/docs/Containers/deconz.md b/docs/Containers/deconz.md index 41ce9368..b7c7335a 100644 --- a/docs/Containers/deconz.md +++ b/docs/Containers/deconz.md @@ -1,6 +1,3 @@ ---- -title: deCONZ ---- # deCONZ ## References - [Docker](https://hub.docker.com/r/marthoc/deconz) diff --git a/docs/Containers/diyHue.md b/docs/Containers/diyHue.md index 98e58a02..6fe62078 100644 --- a/docs/Containers/diyHue.md +++ b/docs/Containers/diyHue.md @@ -1,6 +1,3 @@ ---- -title: DIY hue ---- # DIY hue * [website](https://diyhue.org/getting-started/) diff --git a/docs/Containers/openHAB.md b/docs/Containers/openHAB.md index 4660fcb2..b289e48b 100644 --- a/docs/Containers/openHAB.md +++ b/docs/Containers/openHAB.md @@ -1,6 +1,3 @@ ---- -title: Openhab ---- # Openhab ## References - [Docker](https://hub.docker.com/r/openhab/openhab/) diff --git a/docs/Containers/x2go.md b/docs/Containers/x2go.md deleted file mode 100644 index 6983ac05..00000000 --- a/docs/Containers/x2go.md +++ /dev/null @@ -1,24 +0,0 @@ -# x2go -x2go is an "alternative" to using VNC for a remote connection. It uses X11 forwarding over ssh to provide a desktop environment - -Reason for using: -I have a Pi 4 and I didn't buy a micro hdmi cable. You can use VNC however you are limited to a 800x600 window. - -## Installation - -Install with `sudo apt install x2goserver` - -x2go cant connect to the native Raspbian Desktop so you will need to install another with `sudo tasksel` - -![image](https://user-images.githubusercontent.com/46672225/69007692-b4df0a00-0949-11ea-82d5-09a6833df186.png) - -I chose Xfce because it is light weight. - -Install the x2go client from their [website](https://wiki.x2go.org/doku.php/download:start) - -Now I have a full-screen client - -![image](https://user-images.githubusercontent.com/46672225/69007780-0045e800-094b-11ea-9626-4947595a016e.png) - -## YouTube tutorial -[Laurence systems](https://www.youtube.com/watch?v=oSuy1TS8FGs) \ No newline at end of file From 87606b9ee6beb459e509ed30682d89e64b181a49 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:25:13 +0200 Subject: [PATCH 03/15] added some plugins --- docs/Updating-the-Project.md | 3 ++- docs/index.md | 1 + mkdocs.yml | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/Updating-the-Project.md b/docs/Updating-the-Project.md index 5d0aeff0..c94ed065 100644 --- a/docs/Updating-the-Project.md +++ b/docs/Updating-the-Project.md @@ -1,5 +1,6 @@ # Updating the project -**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** +!!! important + 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 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. diff --git a/docs/index.md b/docs/index.md index 18191352..88e1f3bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,7 @@ https://sensorsiot.github.io/IOTstack/ ## Video [![#295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc.](http://img.youtube.com/vi/a6mjt8tWUws/0.jpg)](https://www.youtube.com/watch?v=a6mjt8tWUws "#295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc.") + **Andreas Spiess | #295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc.** diff --git a/mkdocs.yml b/mkdocs.yml index 1b18f1f8..305c7d4e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,3 +8,5 @@ theme: - search - awsome-pages - git-authors + - admonition + - git-revision-date-localized From a85483045458df5b429e8e8fe7c26d11503b24f1 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:29:21 +0200 Subject: [PATCH 04/15] fixed issue in config --- mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 305c7d4e..01286b9f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,5 +8,6 @@ theme: - search - awsome-pages - git-authors - - admonition - git-revision-date-localized +markdown_extensions: + - admonition \ No newline at end of file From e8015e487bdfaf79d7bfd6afa05844f2e65a9549 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:44:03 +0200 Subject: [PATCH 05/15] test of last update plugin --- docs/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 88e1f3bd..41840e00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -63,4 +63,6 @@ Feel free to add your comments on features or images that you think should be ad ## Contributions -If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary, reporting bugs and PRs help improve the projects for everyone. \ No newline at end of file +If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary, reporting bugs and PRs help improve the projects for everyone. + +Last update: {{ git_revision_date_localized }} \ No newline at end of file From 3d8780ee0cfc54b8324d32d0d768eacd34b8d241 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 11:52:04 +0200 Subject: [PATCH 06/15] testing of new build file --- docs/index.md | 3 ++- requirements.txt | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/docs/index.md b/docs/index.md index 41840e00..c203818f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -65,4 +65,5 @@ Feel free to add your comments on features or images that you think should be ad If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary, reporting bugs and PRs help improve the projects for everyone. -Last update: {{ git_revision_date_localized }} \ No newline at end of file +Last update: {{ git_revision_date_localized }} +Authors: {{ git_page_authors }} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..a6e8be8a --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs-git-revision-date-localized-plugin +mkdocs-git-authors-plugin \ No newline at end of file From 70af8962731b392f07488fa3131b1854e0c5daad Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 12:03:34 +0200 Subject: [PATCH 07/15] try 2 of new theme --- docs/index.md | 3 --- docs/theme/main.html | 11 +++++++++++ mkdocs.yml | 1 + 3 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 docs/theme/main.html diff --git a/docs/index.md b/docs/index.md index c203818f..81e4d0f2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -64,6 +64,3 @@ Feel free to add your comments on features or images that you think should be ad ## Contributions If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary, reporting bugs and PRs help improve the projects for everyone. - -Last update: {{ git_revision_date_localized }} -Authors: {{ git_page_authors }} \ No newline at end of file diff --git a/docs/theme/main.html b/docs/theme/main.html new file mode 100644 index 00000000..b738ec38 --- /dev/null +++ b/docs/theme/main.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} + +{% block disqus %} +
+ + Last update: {{ git_revision_date_localized }} + Authors: {{ git_page_authors }} + +
+ {% include "partials/integrations/disqus.html" %} +{% endblock %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 01286b9f..5a48d33f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ site_name: IOTstack site_description: 'Docker stack for getting started on IOT on the Raspberry PI' theme: name: material + custom_dir: docs/theme/ features: - tabs plugins: From bfbf432ab3b3a29ab551c107c6165ce6a5135e22 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 12:03:34 +0200 Subject: [PATCH 08/15] try 2 of new theme --- docs/index.md | 3 --- docs/theme/main.html | 19 +++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 docs/theme/main.html diff --git a/docs/index.md b/docs/index.md index c203818f..81e4d0f2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -64,6 +64,3 @@ Feel free to add your comments on features or images that you think should be ad ## Contributions If you use some of the tools in the project please consider donating or contributing on their projects. It doesn't have to be monetary, reporting bugs and PRs help improve the projects for everyone. - -Last update: {{ git_revision_date_localized }} -Authors: {{ git_page_authors }} \ No newline at end of file diff --git a/docs/theme/main.html b/docs/theme/main.html new file mode 100644 index 00000000..f652f9b9 --- /dev/null +++ b/docs/theme/main.html @@ -0,0 +1,19 @@ +{% extends "base.html" %} + +{% block disqus %} +
+ + Last update: {{ page.meta.git_revision_date_localized }} + + + {% if git_info %} + {%- for author in git_info.get('page_authors') -%} + + {{ author.name }} + , + {%- endfor -%} + {% endif %} + +
+ {% include "partials/integrations/disqus.html" %} +{% endblock %} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 01286b9f..5a48d33f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ site_name: IOTstack site_description: 'Docker stack for getting started on IOT on the Raspberry PI' theme: name: material + custom_dir: docs/theme/ features: - tabs plugins: From 19c5ef336becb82b8908a1d450d9b520595ae32a Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 12:14:26 +0200 Subject: [PATCH 09/15] removed old plugin --- mkdocs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5a48d33f..49431fe2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,13 +2,11 @@ site_name: IOTstack site_description: 'Docker stack for getting started on IOT on the Raspberry PI' theme: name: material - custom_dir: docs/theme/ features: - tabs plugins: - search - awsome-pages - - git-authors - git-revision-date-localized markdown_extensions: - admonition \ No newline at end of file From 081931b0063cbe74aa64cb3b9654ceae21223fc6 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 15:59:47 +0200 Subject: [PATCH 10/15] test of sub folders --- docs/Containers/{ => Database}/InfluxDB.md | 0 docs/Containers/{ => Database}/MariaDB.md | 0 docs/Containers/NextCloud.md | 8 +++----- 3 files changed, 3 insertions(+), 5 deletions(-) rename docs/Containers/{ => Database}/InfluxDB.md (100%) rename docs/Containers/{ => Database}/MariaDB.md (100%) diff --git a/docs/Containers/InfluxDB.md b/docs/Containers/Database/InfluxDB.md similarity index 100% rename from docs/Containers/InfluxDB.md rename to docs/Containers/Database/InfluxDB.md diff --git a/docs/Containers/MariaDB.md b/docs/Containers/Database/MariaDB.md similarity index 100% rename from docs/Containers/MariaDB.md rename to docs/Containers/Database/MariaDB.md diff --git a/docs/Containers/NextCloud.md b/docs/Containers/NextCloud.md index ae473839..a7fbc27e 100644 --- a/docs/Containers/NextCloud.md +++ b/docs/Containers/NextCloud.md @@ -1,9 +1,7 @@ # Next Cloud -## DO NOT EXPOSE PORT 80 TO THE WEB - -It is a very bad idea to expose unencrypted traffic to the web. You will need to use a reverse-proxy to ensure your password is not stolen and your account hacked. - -I'm still working on getting a good encrypted reverse proxy working. However in the interim you can use a VPN tunnel like OpenVPN or Zerotier to securely connect to your private cloud +!!! attention "DO NOT EXPOSE PORT 80 TO THE WEB" + It is a very bad idea to expose unencrypted traffic to the web. You will need to use a reverse-proxy to ensure your password is not stolen and your account hacked. + I'm still working on getting a good encrypted reverse proxy working. However in the interim you can use a VPN tunnel like OpenVPN or Zerotier to securely connect to your private cloud ## Backups From d82001965cbafffa780f7f098f8b8647220ea997 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 16:11:33 +0200 Subject: [PATCH 11/15] moved to subfolders --- docs/Containers/{ => Database}/PostgreSQL.md | 0 docs/Containers/{ => Home automation}/Home-Assistant.md | 0 docs/Containers/{ => Home automation}/diyHue.md | 0 docs/Containers/{ => Home automation}/openHAB.md | 0 docs/Containers/{ => Management}/Adminer.md | 0 docs/Containers/{ => Management}/Portainer-agent.md | 0 docs/Containers/{ => Management}/Portainer.md | 0 docs/Containers/{ => Management}/TasmoAdmin.md | 0 docs/Containers/NextCloud.md | 3 ++- 9 files changed, 2 insertions(+), 1 deletion(-) rename docs/Containers/{ => Database}/PostgreSQL.md (100%) rename docs/Containers/{ => Home automation}/Home-Assistant.md (100%) rename docs/Containers/{ => Home automation}/diyHue.md (100%) rename docs/Containers/{ => Home automation}/openHAB.md (100%) rename docs/Containers/{ => Management}/Adminer.md (100%) rename docs/Containers/{ => Management}/Portainer-agent.md (100%) rename docs/Containers/{ => Management}/Portainer.md (100%) rename docs/Containers/{ => Management}/TasmoAdmin.md (100%) diff --git a/docs/Containers/PostgreSQL.md b/docs/Containers/Database/PostgreSQL.md similarity index 100% rename from docs/Containers/PostgreSQL.md rename to docs/Containers/Database/PostgreSQL.md diff --git a/docs/Containers/Home-Assistant.md b/docs/Containers/Home automation/Home-Assistant.md similarity index 100% rename from docs/Containers/Home-Assistant.md rename to docs/Containers/Home automation/Home-Assistant.md diff --git a/docs/Containers/diyHue.md b/docs/Containers/Home automation/diyHue.md similarity index 100% rename from docs/Containers/diyHue.md rename to docs/Containers/Home automation/diyHue.md diff --git a/docs/Containers/openHAB.md b/docs/Containers/Home automation/openHAB.md similarity index 100% rename from docs/Containers/openHAB.md rename to docs/Containers/Home automation/openHAB.md diff --git a/docs/Containers/Adminer.md b/docs/Containers/Management/Adminer.md similarity index 100% rename from docs/Containers/Adminer.md rename to docs/Containers/Management/Adminer.md diff --git a/docs/Containers/Portainer-agent.md b/docs/Containers/Management/Portainer-agent.md similarity index 100% rename from docs/Containers/Portainer-agent.md rename to docs/Containers/Management/Portainer-agent.md diff --git a/docs/Containers/Portainer.md b/docs/Containers/Management/Portainer.md similarity index 100% rename from docs/Containers/Portainer.md rename to docs/Containers/Management/Portainer.md diff --git a/docs/Containers/TasmoAdmin.md b/docs/Containers/Management/TasmoAdmin.md similarity index 100% rename from docs/Containers/TasmoAdmin.md rename to docs/Containers/Management/TasmoAdmin.md diff --git a/docs/Containers/NextCloud.md b/docs/Containers/NextCloud.md index a7fbc27e..3776e0c2 100644 --- a/docs/Containers/NextCloud.md +++ b/docs/Containers/NextCloud.md @@ -58,4 +58,5 @@ It would be a good idea to mount an external drive to store the data in rather t The external drive will have to be an ext4 formatted drive because smb, fat32 and NTFS can't handle linux file permissions. If the permissions aren't set to "www-data" then the container wont be able to write to the disk. -Just a warning: If your database gets corrupted then your nextcloud is pretty much stuffed \ No newline at end of file +!!! warning + If your database gets corrupted then your nextcloud is pretty much stuffed \ No newline at end of file From f85d890175080fe94e11d13463d2f098add6e8ff Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sun, 12 Jul 2020 16:16:37 +0200 Subject: [PATCH 12/15] moved more containers --- docs/Containers/{ => Communication}/Mosquitto.md | 0 docs/Containers/{ => Communication}/Zigbee2MQTT.md | 0 docs/Containers/{ => Communication}/deconz.md | 0 docs/Containers/{ => Home automation}/Blynk_server.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename docs/Containers/{ => Communication}/Mosquitto.md (100%) rename docs/Containers/{ => Communication}/Zigbee2MQTT.md (100%) rename docs/Containers/{ => Communication}/deconz.md (100%) rename docs/Containers/{ => Home automation}/Blynk_server.md (100%) diff --git a/docs/Containers/Mosquitto.md b/docs/Containers/Communication/Mosquitto.md similarity index 100% rename from docs/Containers/Mosquitto.md rename to docs/Containers/Communication/Mosquitto.md diff --git a/docs/Containers/Zigbee2MQTT.md b/docs/Containers/Communication/Zigbee2MQTT.md similarity index 100% rename from docs/Containers/Zigbee2MQTT.md rename to docs/Containers/Communication/Zigbee2MQTT.md diff --git a/docs/Containers/deconz.md b/docs/Containers/Communication/deconz.md similarity index 100% rename from docs/Containers/deconz.md rename to docs/Containers/Communication/deconz.md diff --git a/docs/Containers/Blynk_server.md b/docs/Containers/Home automation/Blynk_server.md similarity index 100% rename from docs/Containers/Blynk_server.md rename to docs/Containers/Home automation/Blynk_server.md From 84a307e580f17f1f3c87f9bf5f984ef434a8e449 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sat, 1 Aug 2020 12:42:12 +0200 Subject: [PATCH 13/15] Merged Add docker container documentation #88 --- docs/Docker/Understanding-Containers.md | 114 +++++++++++++++++++++++- 1 file changed, 112 insertions(+), 2 deletions(-) diff --git a/docs/Docker/Understanding-Containers.md b/docs/Docker/Understanding-Containers.md index 4b7ebee6..1d0aaa05 100644 --- a/docs/Docker/Understanding-Containers.md +++ b/docs/Docker/Understanding-Containers.md @@ -1,2 +1,112 @@ -# Understanding containers -Content coming soon. \ No newline at end of file +# Let’s begin by understanding, What is Docker? + +In simple terms, Docker is a software platform that simplifies the process of building, running, +managing and distributing applications. It does this by virtualizing the operating system of the +computer on which it is installed and running. + +# The Problem +Let’s say you have three different Python-based applications that you plan to host on a single server +(which could either be a physical or a virtual machine). + +Each of these applications makes use of a different version of Python, as well as the associated +libraries and dependencies, differ from one application to another. + +Since we cannot have different versions of Python installed on the same machine, this prevents us from +hosting all three applications on the same computer. + +# The Solution +Let’s look at how we could solve this problem without making use of Docker. In such a scenario, we +could solve this problem either by having three physical machines, or a single physical machine, which +is powerful enough to host and run three virtual machines on it. + +Both the options would allow us to install different versions of Python on each of these machines, +along with their associated dependencies. + +The machine on which Docker is installed and running is usually referred to as a Docker Host or Host in +simple terms. So, whenever you plan to deploy an application on the host, it would create a logical +entity on it to host that application. In Docker terminology, we call this logical entity a Container or +Docker Container to be more precise. + +Whereas the kernel of the host’s operating system is shared across all the containers that are running +on it. + +This allows each container to be isolated from the other present on the same host. Thus it supports +multiple containers with different application requirements and dependencies to run on the same host, +as long as they have the same operating system requirements. + +# Docker Terminology + +Docker Images and Docker Containers are the two essential things that you will come across daily while +working with Docker. + +In simple terms, a Docker Image is a template that contains the application, and all the dependencies +required to run that application on Docker. + +On the other hand, as stated earlier, a Docker Container is a logical entity. In more precise terms, +it is a running instance of the Docker Image. + +# What is Docker-Compose? + +Docker Compose provides a way to orchestrate multiple containers that work together. Docker compose +is a simple yet powerful tool that is used to run multiple containers as a single service. +For example, suppose you have an application which requires Mqtt as a communication service between IOT devices +and OpenHAB instance as a Smarthome application service. In this case by docker-compose, you can create one +single file (docker-compose.yml) which will create both the containers as a single service without starting +each separately. It wires up the networks (literally), mounts all volumes and exposes the ports. + +The IOTstack with the templates and menu is a generator for that docker-compose service descriptor. + +# How Docker Compose Works? + +use yaml files to configure application services (docker-compose.yaml) +can start all the services with a single command ( docker-compose up ) +can stop all the service with a single command ( docker-compose down ) + +# How are the containers connected +The containers are automagically connected when we run the stack with docker-compose up. +The containers using same logical network (by default) where the instances can access each other with the instance +logical name. Means if there is an instance called *mosquitto* and an *openhab*, when openHAB instance need +to access mqtt on that case the domain name of mosquitto will be resolved as the runnuning instance of mosquitto. + +# How the container are connected to host machine + +## Volumes + +The containers are enclosed processes which state are lost with the restart of container. To be able to +persist states volumes (images or directories) can be used to share data with the host. +Which means if you need to persist some database, configuration or any state you have to bind volumes where the +running service inside the container will write files to that binded volume. +In order to understand what a Docker volume is, we first need to be clear about how the filesystem normally works +in Docker. Docker images are stored as series of read-only layers. When we start a container, Docker takes +the read-only image and adds a read-write layer on top. If the running container modifies an existing file, +the file is copied out of the underlying read-only layer and into the top-most read-write layer where the +changes are applied. The version in the read-write layer hides the underlying file, but does not +destroy it -- it still exists in the underlying layer. When a Docker container is deleted, +relaunching the image will start a fresh container without any of the changes made in the previously +running container -- those changes are lost, thats the reason that configs, databases are not persisted, + +Volumes are the preferred mechanism for persisting data generated by and used by Docker containers. +While bind mounts are dependent on the directory structure of the host machine, volumes are completely +managed by Docker. In IOTstack project uses the volumes directory in general to bind these container volumes. + +## Ports +When containers running a we would like to delegate some services to the outside world, for example +OpenHAB web frontend have to be accessible for users. There are several ways to achive that. One is +mounting the port to the most machine, this called port binding. On that case service will have a dedicated +port which can be accessed, one drawback is one host port can be used one serice only. Another way is reverse proxy. +The term reverse proxy (or Load Balancer in some terminology) is normally applied to a service that sits in front +of one or more servers (in our case containers), accepting requests from clients for resources located on the +server(s). From the client point of view, the reverse proxy appears to be the web server and so is +totally transparent to the remote user. Which means several service can share same port the server +will route the request by the URL (virtual domain or context path). For example, there is *grafana* and *openHAB* +instances, where the *opeanhab.domain.tld* request will be routed to openHAB instance 8181 port while +*grafana.domain.tld* to grafana instance 3000 port. On that case the proxy have to be mapped for host port 80 and/or +444 on host machine, the proxy server will access the containers via the docker virtual network. + + +Source materials used: + +* https://takacsmark.com/docker-compose-tutorial-beginners-by-example-basics/ +* https://www.freecodecamp.org/news/docker-simplified-96639a35ff36/ +* https://www.cloudflare.com/learning/cdn/glossary/reverse-proxy/ +* https://blog.container-solutions.com/understanding-volumes-docker From d4202e987d944ac1fcdace689c5332af6c9a2073 Mon Sep 17 00:00:00 2001 From: Willem Dekker Date: Sat, 1 Aug 2020 12:42:45 +0200 Subject: [PATCH 14/15] small tweak to Nextcloud docs --- docs/Containers/NextCloud.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Containers/NextCloud.md b/docs/Containers/NextCloud.md index 3776e0c2..07205a56 100644 --- a/docs/Containers/NextCloud.md +++ b/docs/Containers/NextCloud.md @@ -58,5 +58,4 @@ It would be a good idea to mount an external drive to store the data in rather t The external drive will have to be an ext4 formatted drive because smb, fat32 and NTFS can't handle linux file permissions. If the permissions aren't set to "www-data" then the container wont be able to write to the disk. -!!! warning - If your database gets corrupted then your nextcloud is pretty much stuffed \ No newline at end of file +!!! warning "If your database gets corrupted then your nextcloud is pretty much stuffed" \ No newline at end of file From ca9b5845fac8e8a936f31c8593a7fd51da4d441d Mon Sep 17 00:00:00 2001 From: Willemde20 Date: Sat, 8 May 2021 13:29:16 +0200 Subject: [PATCH 15/15] update to build for mkdocks --- .github/workflows/main.yml | 14 +++++++------- mkdocs.yml | 20 ++++++++++++++++++-- requirements.txt | 1 - 3 files changed, 25 insertions(+), 10 deletions(-) delete mode 100644 requirements.txt diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d8887048..3c27211b 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,10 +9,10 @@ jobs: name: Deploy docs runs-on: ubuntu-latest steps: - - name: Checkout master - uses: actions/checkout@v1 - - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }} + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material + - run: pip install mkdocs-git-revision-date-localized-plugin + - run: mkdocs gh-deploy --force diff --git a/mkdocs.yml b/mkdocs.yml index 49431fe2..226f51fa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,28 @@ site_name: IOTstack site_description: 'Docker stack for getting started on IOT on the Raspberry PI' + + +# Repository +repo_url: https://github.com/SensorsIot/IOTstack +repo_name: SensorsIot/IOTstack +edit_uri: "https://github.com/SensorsIot/IOTstack/edit/master/" + theme: name: material + palette: + - scheme: default + toggle: + icon: material/weather-sunny + name: Switch to dark mode + - scheme: slate + toggle: + icon: material/weather-night + name: Switch to light mode features: - tabs plugins: - search - - awsome-pages - git-revision-date-localized markdown_extensions: - - admonition \ No newline at end of file + - admonition + - pymdownx.superfences \ No newline at end of file diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index ddfa1770..00000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -mkdocs-git-revision-date-localized-plugin \ No newline at end of file