Merge pull request #3 from Willem-Dekker/mkdocks

Mkdocks

Author: Willem-Dekker

docs/Accessing-your-Device-from-the-internet.md

@@ -1,8 +1,9 @@
+# accessing your device from the internet
 The challenge most of us face with remotely accessing your home network is that you don't have a static IP. From time to time the IP that your ISP assigns to you changes and it's difficult to keep up. Fortunately, there is a solution, a DynamicDNS. The section below shows you how to set up an easy to remember address that follows your public IP no matter when it changes.
 
 Secondly, how do you get into your home network? Your router has a firewall that is designed to keep the rest of the internet out of your network to protect you. Here we install a VPN and configure the firewall to only allow very secure VPN traffic in. 
 
-# DuckDNS
+## DuckDNS
 If you want to have a dynamic DNS point to your Public IP I added a helper script.
 Register with duckdns.org and create a subdomain name. Then edit the `nano ~/IOTstack/duck/duck.sh` file and add your
 
@@ -20,7 +21,7 @@ paste the following in the editor `*/5 * * * * sudo ~/IOTstack/duck/duck.sh >/de
 
 Your Public IP should be updated every five minutes
 
-# PiVPN
+## PiVPN
 pimylifeup.com has an excellent tutorial on how to install [PiVPN](https://pimylifeup.com/raspberry-pi-vpn-server/)
 
 In point 17 and 18 they mention using noip for their dynamic DNS. Here you can use the DuckDNS address if you created one.
@@ -31,7 +32,7 @@ Once you activate your VPN (from your phone/laptop/work computer) you will effec
 
 I personally use the VPN any time I'm on public wifi, all your traffic is secure.
 
-# Zerotier
+## Zerotier
 https://www.zerotier.com/
 
 Zerotier is an alternative to PiVPN that doesn't require port forwarding on your router. It does however require registering for their free tier service [here](https://my.zerotier.com/login). 

docs/Adminer.md

@@ -1,8 +1,9 @@
-# References
+# Adminer
+## References
 - [Docker](https://hub.docker.com/_/adminer)
 - [Website](https://www.adminer.org/)
 
-# About
+## About
 
 This is a nice tool for managing databases. Web interface has moved to port 9080. There was an issue where openHAB and Adminer were using the same ports. If you have an port conflict edit the docker-compose.yml and under the adminer service change the line to read:
 ```

docs/Backups.md

@@ -1,9 +1,10 @@
+# Backups
 Because containers can easily be rebuilt from docker hub we only have to back up the data in the "volumes" directory.
 
-# Cloud Backups
-## Dropbox-Uploader
+## Cloud Backups
+### Dropbox-Uploader
 This a great utility to easily upload data from your Pi to the cloud. https://magpi.raspberrypi.org/articles/dropbox-raspberry-pi. It can be installed from the Menu under Backups.
-## rclone (Google Drive)
+### rclone (Google Drive)
 This is a service to upload to Google Drive. The config is described [here]( https://medium.com/@artur.klauser/mounting-google-drive-on-raspberry-pi-f5002c7095c2). Install it from the menu then follow the link for these sections:
 * Getting a Google Drive Client ID
 * Setting up the Rclone Configuration
@@ -15,10 +16,10 @@ When naming the service in `rclone config` ensure to call it "gdrive"
 If you want your Google Drive to mount on every boot then follow the instructions at the bottom of the wiki page
 
 
-# Influxdb
+## Influxdb
 `~/IOTstack/scripts/backup_influxdb.sh` does a database snapshot and stores it in ~/IOTstack/backups/influxdb/db . This can be restored with the help a script (that I still need to write)
 
-# Docker backups
+## Docker backups
 The script `~/IOTstack/scripts/docker_backup.sh` performs the master backup for the stack. 
 
 This script can be placed in a cron job to backup on a schedule.
@@ -27,20 +28,20 @@ Then add `0 23 * * * ~/IOTstack/scripts/docker_backup.sh >/dev/null 2>&1` to hav
 
 This script cheats by copying the volume folder live. The correct way would be to stop the stack first then copy the volumes and restart. The cheating method shouldn't be a problem unless you have fast changing data like in influxdb. This is why the script makes a database export of influxdb and ignores its volume. 
 
-## Cloud integration
+### Cloud integration
 The docker_backup.sh script now no longer requires modification to enable cloud backups. It now tests for the presence of and enable file in the backups folder
-### Drobox-Uploader
+#### Drobox-Uploader
 The backup tests for a file called `~/IOTstack/backups/dropbox`, if it is present it will upload to dropbox. To disable dropbox upload delete the file. To enable run `sudo touch ~/IOTstack/backups/dropbox`
-### rclone
+#### rclone
 The backup tests for a file called `~/IOTstack/backups/rclone`, if it is present it will upload to google drive. To disable rclone upload delete the file. To enable run `sudo touch ~/IOTstack/backups/rclone`
 
-### Pruning online backups
+#### Pruning online backups
 @877dev has added functionality to prune both local and cloud backups. For dropbox make sure you dont have any files that contain spaces in your backup directory as the script cannot handle it at this time.
 
-## Restoring a backup
+### Restoring a backup
 The "volumes" directory contains all the persistent data necessary to recreate the container. The docker-compose.yml and the environment files are optional as they can be regenerated with the menu. Simply copy the volumes directory into the IOTstack directory, Rebuild the stack and start. 
 
-# Added your Dropbox token incorrectly or aborted the install at the token screen
+## Added your Dropbox token incorrectly or aborted the install at the token screen
 
 Make sure you are running the latest version of the project [link](https://github.com/gcgarner/IOTstack/wiki/Updating-the-Project).
 
@@ -70,7 +71,7 @@ Ensure you **are not** running as sudo as this will store your api in the /root
 
 If you ran the command with sudo the remove the old token file if it exists with either `sudo rm /root/.dropbox_uploader` or `sudo ~/Dropbox-Uploader/dropbox_uploader.sh unlink`
 
-# Auto-mount Gdrive with rclone
+## Auto-mount Gdrive with rclone
 
 To enable rclone to mount on boot you will need to make a user service. Run the following commands
 

docs/Blynk_server.md

@@ -1,3 +1,4 @@
+# Blynk server
 This is a custom implementation of Blynk Server
 
 ```yml
@@ -21,30 +22,30 @@ When setting up the application on your mobile be sure to select custom setup [h
 
 Writeup From @877dev
 
-**Getting started:**
+## Getting started
 Log into admin panel at https://youripaddress:9443/admin
 (Use your Pi's IP address, and ignore Chrome warning).
 
 Default credentials:
 user:[email protected]
 pass:admin
 
-**Change username and password:**
+## Change username and password
 Click on Users > "email address" and edit email, name and password. 
 Save changes
 Restarting the container using Portainer may be required to take effect.
 
-**Setup gmail:**
+## Setup gmail
 Optional step, useful for getting the auth token emailed to you.
 (To be added once confirmed working....)
 
-**iOS/Android app setup:**
+## iOS/Android app setup
 Login the app as per the photos [HERE](https://github.com/blynkkk/blynk-server#app-and-sketch-changes)
 Press "New Project"
 Give it a name, choose device "Raspberry Pi 3 B" so you have plenty of [virtual pins](http://help.blynk.cc/en/articles/512061-what-is-virtual-pins) available, and lastly select WiFi.
 Create project and the [auth token](https://docs.blynk.cc/#getting-started-getting-started-with-the-blynk-app-4-auth-token) will be emailed to you (if emails configured). You can also find the token in app under the phone app settings, or in the admin web interface by clicking Users>"email address" and scroll down to token.
 
-**Quick usage guide for app:**
+## Quick usage guide for app
 Press on the empty page, the widgets will appear from the right.
 Select your widget, let's say a button.
 It appears on the page, press on it to configure.
@@ -55,7 +56,7 @@ To start the project running, press top right Play button.
 You will get an offline message, because no devices are connected to your project via the token.
 Enter node red.....
 
-**Node red:**
+## Node red
 Install node-red-contrib-blynk-ws from pallette manager
 Drag a "write event" node into your flow, and connect to a debug node
 Configure the Blynk node for the first time:
@@ -64,7 +65,7 @@ Enter your [auth token](https://docs.blynk.cc/#getting-started-getting-started-w
 When you deploy the flow, notice the app shows connected message, as does the Blynk node.
 Press the button on the app, you will notice the payload is sent to the debug node.
 
-**What next?**
+## What next?
 Further information and advanced setup:
 https://github.com/blynkkk/blynk-server
 

docs/Custom.md

@@ -1,3 +1,4 @@
+# Custom container
 If you have a container that you want to stop and start with the stack you can now use the custom container option. This you can use for testing or in prep for a Pull Request.
 
 You will need to create a directory for your container call `IOTstack/services/<container>`

docs/Docker-commands.md

@@ -1,4 +1,5 @@
-# Aliases
+# Docker commands
+## Aliases
 
 I've added bash aliases for stopping and starting the stack. They can be installed in the docker commands menu. These commands no longer need to be executed from the IOTstack directory and can be executed in any directory
 

docs/EspruinoHub.md

@@ -1,3 +1,4 @@
+# Espruinohub
 This is a testing container
 
 I tried it however the container keeps restarting `docker logs espruinohub` I get "BLE Broken?" but could just be i dont have any BLE devices nearby

docs/Getting-Started.md

@@ -1,4 +1,5 @@
-# Download the project
+# Getting started
+## Download the project
 
 On the lite image you will need to install git first 
 ```
@@ -14,28 +15,28 @@ To enter the directory run:
 ```
 cd ~/IOTstack
 ```
-# The Menu
+## The Menu
 I've added a menu to make things easier. It is good however to familiarise yourself with how things are installed.
 The menu can be used to install docker and then build the docker-compose.yml file necessary for starting the stack and it runs a few common commands. I do recommend you start to learn the docker and docker-compose commands if you plan using docker in the long run. I've added several helper scripts, have a look inside.
 
 Navigate to the project folder and run `./menu.sh`
 
-## Installing from the menu
+### Installing from the menu
 Select the first option and follow the prompts
 
-## Build the docker-compose file
+### Build the docker-compose file
 docker-compose uses the `docker-compose.yml` file to configure all the services. Run through the menu to select the options you want to install.
 
-## Docker commands
+### Docker commands
 This menu executes shell scripts in the root of the project. It is not necessary to run them from the menu. Open up the shell script files to see what is inside and what they do
 
-## Miscellaneous commands
+### Miscellaneous commands
 Some helpful commands have been added like disabling swap
 
-# Running Docker commands
+## Running Docker commands
 From this point on make sure you are executing the commands from inside the project folder. Docker-compose commands need to be run from the folder where the docker-compose.yml is located. If you want to move the folder make sure you move the whole project folder.
 
-## Starting and Stopping containers
+### Starting and Stopping containers
 to start the stack navigate to the project folder containing the docker-compose.yml file
 
 To start the stack run:
@@ -49,13 +50,13 @@ To remove the stack:
 
 The first time you run 'start' the stack docker will download all the images for the web. Depending on how many containers you selected and your internet speed this can take a long while.
 
-## Persistent data
+### Persistent data
 Docker allows you to map folders inside your containers to folders on the disk. This is done with the "volume" key. There are two types of volumes. Any modification to the container reflects in the volume.
 
-### Sharing files between the Pi and containers
+#### Sharing files between the Pi and containers
 Have a look a the wiki on how to share files between Node-RED and the Pi. [Wiki](https://github.com/gcgarner/IOTstack/wiki/Node-RED#sharing-files-between-node-red-and-the-host)
 
-## Updating the images
+### Updating the images
 If a new version of a container image is available on docker hub it can be updated by a pull command.
 
 Use the `docker-compose stop` command to stop the stack
@@ -68,14 +69,14 @@ Start the new stack based on the updated images
 
 `docker-compose up -d`
 
-## Node-RED error after modifications to setup files
+### Node-RED error after modifications to setup files
 The Node-RED image differs from the rest of the images in this project. It uses the "build" key. It uses a dockerfile for the setup to inject the nodes for pre-installation. If you get an error for Node-RED run `docker-compose build` then `docker-compose up -d`
 
-## Deleting containers, volumes and images
+### Deleting containers, volumes and images
 
 `./prune-images.sh` will remove all images not associated with a container. If you run it while the stack is up it will ignore any in-use images. If you run this while you stack is down it will delete all images and you will have to redownload all images from scratch. This command can be helpful to reclaim disk space after updating your images, just make sure to run it while your stack is running as not to delete the images in use. (your data will still be safe in your volume mapping)
 
-## Deleting folder volumes
+### Deleting folder volumes
 If you want to delete the influxdb data folder run the following command `sudo rm -r volumes/influxdb/`. Only the data folder is deleted leaving the env file intact. review the docker-compose.yml file to see where the file volumes are stored.
 
 You can use git to delete all files and folders to return your folder to the freshly cloned state, AS IN YOU WILL LOSE ALL YOUR DATA.

docs/Grafana.md

@@ -1,11 +1,12 @@
-# References
+# Grafana
+## References
 - [Docker](https://hub.docker.com/r/grafana/grafana)
 - [Website](https://grafana.com/)
 
-# Security 
+## Security 
 Grafana's default credentials are username "admin" password "admin" it will ask you to choose a new password on boot. Go to `<yourIP>:3000` in your web browser.
 
-# Overwriting grafana.ini settings
+## Overwriting grafana.ini settings
 
 A list of the settings available in grafana.ini are listed [here](https://grafana.com/docs/installation/configuration/)
 

docs/Home-Assistant.md

@@ -1,19 +1,20 @@
-# References
+# Home assistant
+## References
 - [Docker](https://hub.docker.com/r/homeassistant/home-assistant/)
 - [Webpage](https://www.home-assistant.io/)
 
 Hass.io is a home automation platform running on Python 3. It is able to track and control all devices at home and offer a platform for automating control. Port binding is `8123`.
 Hass.io is exposed to your hosts' network in order to discover devices on your LAN. That means that it does not sit inside docker's network.
 
-# Menu installation
+## Menu installation
 Hass.io now has a seperate installation in the menu. The old version was incorrect and should be removed. Be sure to update you project and install the correct version.
 
 You will be asked to select you device type during the installation. Hass.io is no longer dependant on the IOTstack, it has its own service for maintaining its uptime.
 
-# Installation
+## Installation
 The installation of Hass.io takes up to 20 minutes (depending on your internet connection). Refrain from restarting your Pi until it had come online and you are able to create a user account 
 
-# Removal
+## Removal
 
 To remove Hass.io you first need to stop the service that controls it. Run the following in the terminal: