Skip to content

Commit 45451c3

Browse files
committed
updated README and tidy md
1 parent 124e3cc commit 45451c3

File tree

1 file changed

+60
-26
lines changed

1 file changed

+60
-26
lines changed

README.md

Lines changed: 60 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,60 @@
1-
# Announcements
1+
# Announcements
2+
23
The bulk of the README has moved to the Wiki. Please check it out [here](https://github.com/gcgarner/IOTstack/wiki)
4+
5+
* Added RTL_433 native and docker installs
6+
* Added update project through the menu
7+
* Added bash aliases for easier docker stop and start commands
38
* The project up procedure has been rewritten #73 (now git pull), please check your duck.sh file because the old method reset it
49
* BUGFIX: incorrect permissions in docker_backup: PR @Paraphraser
510
* BUGFIX: Timezone not correct on Node-RED and Pihole
611
* docker_backup.sh now stores last 5 backups with timestamps : PR @877dev
712
* Added Pi-Hole
813
* Added zigbee2mqtt (needs wiki) BUG:does not start due to missing device
914
* Added rclone for Google Drive Backups
10-
* Fixed Hass.io (now has a seperate menu installation)
15+
* Fixed Hass.io (now has a seperate menu installation)
1116
* Added Telegraf (needs wiki)
1217
* Plex added
13-
* Tasmoadmin (needs wiki)
18+
* Tasmoadmin (needs wiki)
1419
* Fixed Tasmoadmin not starting after reboot
1520

1621
***
22+
1723
## Highlighted topics
24+
1825
* [Bluetooth and Node-RED](https://github.com/gcgarner/IOTstack/wiki/Node-RED#using-bluetooth)
1926
* [Saving files to disk inside containers](https://github.com/gcgarner/IOTstack/wiki/Node-RED#sharing-files-between-node-red-and-the-host)
2027
* [Updating the Project](https://github.com/gcgarner/IOTstack/wiki/Updating-the-Project)
2128

2229
***
30+
2331
# Coming soon
24-
- [EspurinoHub](https://hub.docker.com/r/humbertosales/espruinohub-docker-rpi)
32+
33+
* [EspurinoHub](https://hub.docker.com/r/humbertosales/espruinohub-docker-rpi)
34+
2535
***
2636

2737
# IOTstack
38+
2839
Docker stack for getting started on IoT on the Raspberry Pi.
2940

3041
This Docker stack consists of:
31-
* Node-RED
32-
* Grafana
33-
* InfluxDB
34-
* Postgres
35-
* Mosquitto mqtt
36-
* Portainer
37-
* Adminer
38-
* openHAB
39-
* Home Assistant (HASSIO)
40-
* zigbee2mqtt
41-
* Pi-Hole
42-
* TasmoAdmin (parial wiki)
43-
* Plex media server
44-
* Telegraf (wiki coming soon)
42+
43+
* Node-RED
44+
* Grafana
45+
* InfluxDB
46+
* Postgres
47+
* Mosquitto mqtt
48+
* Portainer
49+
* Adminer
50+
* openHAB
51+
* Home Assistant (HASSIO)
52+
* zigbee2mqtt
53+
* Pi-Hole
54+
* TasmoAdmin (parial wiki)
55+
* Plex media server
56+
* Telegraf (wiki coming soon)
57+
* RTL_433
4558

4659
In addition, there is a write-up and some scripts to get a dynamic DNS via duckdns and VPN up and running.
4760

@@ -58,60 +71,78 @@ The container will fail if you try to run the docker and native vesions as the s
5871
For those looking for a script that installs native applications check out [Peter Scargill's script](https://tech.scargill.net/the-script/)
5972

6073
# Tested platform
74+
6175
Raspberry Pi 3B and 4B Raspbian (Buster)
6276

6377
## Older Pi's
78+
6479
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/)
6580

6681
## Running under a virtual machine
82+
6783
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.
6884

6985
# Feature Requests
86+
7087
Please direct all feature requests to [Discord](https://discord.gg/W45tD83)
7188

7289
# Youtube reference
90+
7391
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.
7492

7593
[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
7694

7795
# Download the project
7896

79-
1. On the lite image you will need to install git first
80-
```
97+
1.On the lite image you will need to install git first
98+
99+
```bash
81100
sudo apt-get install git
82101
```
83-
2. Download the repository with:
84-
```
102+
103+
2.Download the repository with:
104+
105+
```bash
85106
git clone https://github.com/gcgarner/IOTstack.git ~/IOTstack
86107
```
108+
87109
Due to some script restraints, this project needs to be stored in ~/IOTstack
88110

89-
3. To enter the directory run:
90-
```
111+
3.To enter the directory run:
112+
113+
```bash
91114
cd ~/IOTstack
92115
```
116+
93117
# The Menu
118+
94119
I've added a menu to make things easier. It is good to familiarise yourself with the installation process.
95120
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.
96121

97122
Navigate to the project folder and run `./menu.sh`
98123

99124
## Installing from the menu
125+
100126
Select the first option and follow the prompts
101127

102128
## Build the docker-compose file
129+
103130
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.
104131

105132
## Docker commands
133+
106134
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.
107135

108136
## Miscellaneous commands
137+
109138
Some helpful commands have been added like disabling swap.
110139

111140
# Running Docker commands
141+
112142
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.
113143

114144
## Starting and Stopping containers
145+
115146
to start the stack navigate to the project folder containing the docker-compose.yml file
116147

117148
To start the stack run:
@@ -125,14 +156,17 @@ The first time you run 'start' the stack docker will download all the images for
125156
The 'docker-compose down' command stops the containers then deletes them. To stop the container but not delete it, run 'docker-compose stop'.
126157

127158
## Persistent data
159+
128160
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.
129161

130162
# See Wiki for further info
131-
[Wiki](https://github.com/gcgarner/IOTstack/wiki)
132163

164+
[Wiki](https://github.com/gcgarner/IOTstack/wiki)
133165

134166
# Add to the project
167+
135168
Feel free to add your comments on features or images that you think should be added.
136169

137170
# Contributions
138-
@mrmx, @oscrx, @brianimmel, @Slyke, @AugustasV, @Paulf007, @affankingkhan, @877dev, @Paraphraser
171+
172+
@mrmx, @oscrx, @brianimmel, @Slyke, @AugustasV, @Paulf007, @affankingkhan, @877dev, @Paraphraser

0 commit comments

Comments
 (0)