Merge remote-tracking branch 'upstream/master'

Author: 877dev

.bash_aliases

@@ -0,0 +1,7 @@
+alias iotstack_up="docker-compose -f ~/IOTstack/docker-compose.yml up -d"
+alias iotstack_down="docker-compose -f ~/IOTstack/docker-compose.yml down"
+alias iotstack_start="docker-compose -f ~/IOTstack/docker-compose.yml start"
+alias iotstack_stop="docker-compose -f ~/IOTstack/docker-compose.yml stop"
+alias iotstack_update="docker-compose -f ~/IOTstack/docker-compose.yml pull"
+alias iotstack_build="docker-compose -f ~/IOTstack/docker-compose.yml build"
+

.native/rtl_433.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+sudo touch /etc/modprobe.d/blacklist-rtl.conf
+[ $(grep -c rtl28xxu /etc/modprobe.d/blacklist-rtl.conf) -eq 0 ] && sudo echo "blacklist dvb_usb_rtl28xxu" >>/etc/modprobe.d/blacklist-rtl.conf
+
+sudo touch /etc/modprobe.d/blacklist-rtl8xxxu.conf
+[ $(grep -c rtl8xxxu /etc/modprobe.d/blacklist-rtl8xxxu.conf) -eq 0 ] && sudo echo "blacklist rtl8xxxu" >>/etc/modprobe.d/blacklist-rtl8xxxu.conf
+
+sudo apt-get update
+sudo apt-get install -y libtool \
+	libusb-1.0.0-dev \
+	librtlsdr-dev \
+	rtl-sdr \
+	doxygen \
+	cmake \
+	automake
+
+git clone https://github.com/merbanan/rtl_433.git ~/rtl_433
+cd ~/rtl_433/
+mkdir build
+cd build
+cmake ../
+make
+sudo make install
+
+echo "you should reboot for changes to take effect"

.templates/grafana/grafana.env

@@ -1,2 +1,9 @@
+#TZ=Africa/Johannesburg
 GF_PATHS_DATA=/var/lib/grafana
-GF_PATHS_LOGS=/var/log/grafana
+GF_PATHS_LOGS=/var/log/grafana
+# [SERVER]
+#GF_SERVER_ROOT_URL=http://localhost:3000/grafana
+#GF_SERVER_SERVE_FROM_SUB_PATH=true
+# [SECURITY]
+#GF_SECURITY_ADMIN_USER=admin
+#GF_SECURITY_ADMIN_PASSWORD=admin

.templates/pihole/pihole.env

@@ -1,3 +1,16 @@
 #TZ=America/Chicago
 WEBPASSWORD=pihole
-
+#DNS1=8.8.8.8
+#DNS2=8.8.4.4
+#DNSSEC=false
+#DNS_BOGUS_PRIV=True
+#CONDITIONAL_FORWARDING=False
+#CONDITIONAL_FORWARDING_IP=your_router_ip_here (only if CONDITIONAL_FORWARDING=ture)
+#CONDITIONAL_FORWARDING_DOMAIN=optional
+#CONDITIONAL_FORWARDING_REVERSE=optional
+#ServerIP=your_Pi's_IP_here  << recommended
+#ServerIPv6= your_Pi's_ipv6_here << Required if using ipv6
+#VIRTUAL_HOST=$ServerIP
+#IPv6=True
+INTERFACE=eth0
+#DNSMASQ_LISTENING=local

.templates/rtl_433/Dockerfile

@@ -0,0 +1,18 @@
+FROM debian:buster-slim
+
+ENV MQTT_ADDRESS mosquitto
+ENV MQTT_PORT 1883
+ENV MQTT_USER ""
+ENV MQTT_PASSWORD ""
+ENV MQTT_TOPIC RTL_433
+
+RUN apt-get update && apt-get install -y  git libtool libusb-1.0.0-dev librtlsdr-dev rtl-sdr cmake automake && \
+	git clone https://github.com/merbanan/rtl_433.git /tmp/rtl_433 && \
+	cd /tmp/rtl_433/ && \
+	mkdir build && \
+	cd build && \
+	cmake ../ && \
+	make && \
+	make install
+
+CMD ["sh", "-c", "rtl_433 -F mqtt://${MQTT_ADDRESS}:${MQTT_PORT},events=${MQTT_TOPIC},user=${MQTT_USER},pass=${MQTT_PASSWORD}"]

.templates/rtl_433/rtl_433.env

@@ -0,0 +1,6 @@
+TZ=Africa/Johannesburg
+MQTT_ADDRESS=mosquitto
+MQTT_PORT=1883
+#MQTT_USER=""
+#MQTT_PASSWORD=""
+MQTT_TOPIC=RTL_433

.templates/rtl_433/service.yml

@@ -0,0 +1,8 @@
+  rtl_433:
+    container_name: rtl_433
+    build: ./services/rtl_433/.
+    env_file:
+      - ./services/rtl_433/rtl_433.env
+    devices:
+      - /dev/bus/usb
+    restart: unless-stopped

README.md

@@ -1,47 +1,61 @@
-# Announcements 
+# Announcements
+
 The bulk of the README has moved to the Wiki. Please check it out [here](https://github.com/gcgarner/IOTstack/wiki)
+
+* BUGFIX: I incorrecly changed mosquittos volume mapping and it caused the container to restart. Reverted to the old volume mapping
+* Added RTL_433 native and docker installs
+* Added update project through the menu
+* Added bash aliases for easier docker stop and start commands
 * The project up procedure has been rewritten #73 (now git pull), please check your duck.sh file because the old method reset it
 * BUGFIX: incorrect permissions in docker_backup: PR @Paraphraser
 * BUGFIX: Timezone not correct on Node-RED and Pihole
 * docker_backup.sh now stores last 5 backups with timestamps : PR @877dev
 * Added Pi-Hole
 * Added zigbee2mqtt (needs wiki) BUG:does not start due to missing device
 * Added rclone for Google Drive Backups
-* Fixed Hass.io (now has a seperate menu installation) 
+* Fixed Hass.io (now has a seperate menu installation)
 * Added Telegraf (needs wiki)
 * Plex added
-* Tasmoadmin (needs wiki) 
+* Tasmoadmin (needs wiki)
 * Fixed Tasmoadmin not starting after reboot
 
 ***
+
 ## Highlighted topics
+
 * [Bluetooth and Node-RED](https://github.com/gcgarner/IOTstack/wiki/Node-RED#using-bluetooth)
 * [Saving files to disk inside containers](https://github.com/gcgarner/IOTstack/wiki/Node-RED#sharing-files-between-node-red-and-the-host)
 * [Updating the Project](https://github.com/gcgarner/IOTstack/wiki/Updating-the-Project)
 
  ***
+
 # Coming soon
-- [EspurinoHub](https://hub.docker.com/r/humbertosales/espruinohub-docker-rpi)
+
+* [EspurinoHub](https://hub.docker.com/r/humbertosales/espruinohub-docker-rpi)
+
 ***
 
 # IOTstack
+
 Docker stack for getting started on IoT on the Raspberry Pi.
 
 This Docker stack consists of:
-  * Node-RED
-  * Grafana
-  * InfluxDB
-  * Postgres
-  * Mosquitto mqtt
-  * Portainer
-  * Adminer
-  * openHAB
-  * Home Assistant (HASSIO)
-  * zigbee2mqtt
-  * Pi-Hole
-  * TasmoAdmin (parial wiki)
-  * Plex media server
-  * Telegraf (wiki coming soon)
+
+* Node-RED
+* Grafana
+* InfluxDB
+* Postgres
+* Mosquitto mqtt
+* Portainer
+* Adminer
+* openHAB
+* Home Assistant (HASSIO)
+* zigbee2mqtt
+* Pi-Hole
+* TasmoAdmin (parial wiki)
+* Plex media server
+* Telegraf (wiki coming soon)
+* RTL_433
 
 In addition, there is a write-up and some scripts to get a dynamic DNS via duckdns and VPN up and running.
 
@@ -58,60 +72,78 @@ The container will fail if you try to run the docker and native vesions as the s
 For those looking for a script that installs native applications check out [Peter Scargill's script](https://tech.scargill.net/the-script/)
 
 # Tested platform
+
 Raspberry Pi 3B and 4B Raspbian (Buster)
 
 ## Older Pi's
+
 Docker will not run on a PiZero or A model 1 because of the CPU. It has not been tested on a Model 2. You can still use Peter Scargill's [script](https://tech.scargill.net/the-script/)
 
 ## Running under a virtual machine
+
 For those wanting to test out the script in a Virtual Machine before installing on their Pi there are some limitations. The script is designed to work with Debian based distributions. Not all the container have x86_64 images. For example Portainer does not and will give an error when you try and start the stack. Please see the pinned issue [#29](https://github.com/gcgarner/IOTstack/issues/29), there is more info there.
 
 # Feature Requests
+
 Please direct all feature requests to [Discord](https://discord.gg/W45tD83)
 
 # Youtube reference
+
 This repo was originally inspired by Andreas Spiess's video on using some of these tools. Some containers have been added to extend its functionality.
 
 [YouTube video](https://www.youtube.com/watch?v=JdV4x925au0): This is an alternative approach to the setup. Be sure to watch the video for the instructions. Just note that the network addresses are different, see note below
 
 # Download the project
 
-1. On the lite image you will need to install git first 
-```
+1.On the lite image you will need to install git first 
+
+```bash
 sudo apt-get install git
 ```
-2. Download the repository with:
-```
+
+2.Download the repository with:
+
+```bash
 git clone https://github.com/gcgarner/IOTstack.git ~/IOTstack
 ```
+
 Due to some script restraints, this project needs to be stored in ~/IOTstack
 
-3. To enter the directory run:
-```
+3.To enter the directory run:
+
+```bash
 cd ~/IOTstack
 ```
+
 # The Menu
+
 I've added a menu to make things easier. It is good to familiarise yourself with the installation process.
 The menu can be used to install docker and build the docker-compose.yml file necessary for starting the stack. It also runs a few common commands. I do recommend you start to learn the docker and docker-compose commands if you plan on 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
+
 Select the first option and follow the prompts
 
 ## 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
+
 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
+
 Some helpful commands have been added like disabling swap.
 
 # 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
+
 to start the stack navigate to the project folder containing the docker-compose.yml file
 
 To start the stack run:
@@ -125,14 +157,17 @@ The first time you run 'start' the stack docker will download all the images for
 The 'docker-compose down' command stops the containers then deletes them. To stop the container but not delete it, run 'docker-compose stop'.
 
 ## 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. Modification to the container are reflected in the volume.
 
 # See Wiki for further info
-[Wiki](https://github.com/gcgarner/IOTstack/wiki)
 
+[Wiki](https://github.com/gcgarner/IOTstack/wiki)
 
 # Add to the project
+
 Feel free to add your comments on features or images that you think should be added.
 
 # Contributions
-@mrmx, @oscrx, @brianimmel, @Slyke, @AugustasV, @Paulf007, @affankingkhan, @877dev, @Paraphraser 
+
+@mrmx, @oscrx, @brianimmel, @Slyke, @AugustasV, @Paulf007, @affankingkhan, @877dev, @Paraphraser

menu.sh

@@ -7,7 +7,7 @@ timezones() {
 	TZ=$(cat /etc/timezone)
 
 	#test for TZ=
-	[ $(grep "TZ=" $env_file) ] && sed -i "/TZ=/c\TZ=$TZ" $env_file
+	[ $(grep -c "TZ=" $env_file) -ne 0 ] && sed -i "/TZ=/c\TZ=$TZ" $env_file
 
 }
 
@@ -85,9 +85,11 @@ mainmenu_selection=$(whiptail --title "Main Menu" --menu --notags \
 	"install" "Install Docker" \
 	"build" "Build Stack" \
 	"hassio" "Install Hass.io (Requires Docker)" \
+	"native" "Native Installs" \
 	"commands" "Docker commands" \
 	"backup" "Backup options" \
 	"misc" "Miscellaneous commands" \
+	"update" "Update IOTstack" \
 	3>&1 1>&2 2>&3)
 
 case $mainmenu_selection in
@@ -131,6 +133,7 @@ case $mainmenu_selection in
 		"pihole" "Pi-Hole" "OFF" \
 		"plex" "Plex media server" "OFF" \
 		"tasmoadmin" "TasmoAdmin" "OFF" \
+		"rtl_433" "RTL_433 to mqtt" "OFF" \
 		3>&1 1>&2 2>&3)
 
 	mapfile -t containers <<<"$container_selection"
@@ -157,16 +160,19 @@ case $mainmenu_selection in
 	#MAINMENU Docker commands -----------------------------------------------------------
 "commands")
 
-	docker_selection=$(whiptail --title "Docker commands" --menu --notags \
-		"Shortcut to common docker commands" 20 78 12 -- \
-		"start" "Start stack" \
-		"restart" "Restart stack" \
-		"stop" "Stop stack" \
-		"stop_all" "Stop any running container regardless of stack" \
-		"pull" "Update all containers" \
-		"prune_volumes" "Delete all stopped containers and docker volumes" \
-		"prune_images" "Delete all images not associated with container" \
-		3>&1 1>&2 2>&3)
+	docker_selection=$(
+		whiptail --title "Docker commands" --menu --notags \
+			"Shortcut to common docker commands" 20 78 12 -- \
+			"aliases" "Add iotstack_up and iotstack_down aliases" \
+			"start" "Start stack" \
+			"restart" "Restart stack" \
+			"stop" "Stop stack" \
+			"stop_all" "Stop any running container regardless of stack" \
+			"pull" "Update all containers" \
+			"prune_volumes" "Delete all stopped containers and docker volumes" \
+			"prune_images" "Delete all images not associated with container" \
+			3>&1 1>&2 2>&3
+	)
 
 	case $docker_selection in
 	"start") ./scripts/start.sh ;;
@@ -176,6 +182,16 @@ case $mainmenu_selection in
 	"pull") ./scripts/update.sh ;;
 	"prune_volumes") ./scripts/prune-volumes.sh ;;
 	"prune_images") ./scripts/prune-images.sh ;;
+	"aliases")
+		touch ~/.bash_aliases
+		if [ $(grep -c 'IOTstack' ~/.bash_aliases) -eq 0 ]; then
+			echo ". ~/IOTstack/.bash_aliases" >>~/.bash_aliases
+			echo "added aliases"
+		else
+			echo "aliases already added"
+		fi
+		source ~/.bashrc
+		;;
 	esac
 	;;
 	#Backup menu ---------------------------------------------------------------------
@@ -266,6 +282,25 @@ case $mainmenu_selection in
 		exit
 	fi
 	;;
+"update")
+	echo "Pulling latest project file from Github.com ---------------------------------------------"
+	git pull origin master
+	echo "git status ------------------------------------------------------------------------------"
+	git status
+	;;
+"native")
+
+	native_selections=$(whiptail --title "Native installs" --menu --notags \
+		"Install local applications" 20 78 12 -- \
+		"rtl_433" "RTL_433" \
+		3>&1 1>&2 2>&3)
+
+	case $native_selections in
+	"rtl_433")
+		bash ./.native/rtl_433.sh
+		;;
+	esac
+	;;
 *) ;;
 
 esac