You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Docker stack for getting started on IoT on the Raspberry Pi.
29
40
30
41
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
45
58
46
59
In addition, there is a write-up and some scripts to get a dynamic DNS via duckdns and VPN up and running.
47
60
@@ -58,60 +71,78 @@ The container will fail if you try to run the docker and native vesions as the s
58
71
For those looking for a script that installs native applications check out [Peter Scargill's script](https://tech.scargill.net/the-script/)
59
72
60
73
# Tested platform
74
+
61
75
Raspberry Pi 3B and 4B Raspbian (Buster)
62
76
63
77
## Older Pi's
78
+
64
79
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/)
65
80
66
81
## Running under a virtual machine
82
+
67
83
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.
68
84
69
85
# Feature Requests
86
+
70
87
Please direct all feature requests to [Discord](https://discord.gg/W45tD83)
71
88
72
89
# Youtube reference
90
+
73
91
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.
74
92
75
93
[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
76
94
77
95
# Download the project
78
96
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
Due to some script restraints, this project needs to be stored in ~/IOTstack
88
110
89
-
3. To enter the directory run:
90
-
```
111
+
3.To enter the directory run:
112
+
113
+
```bash
91
114
cd~/IOTstack
92
115
```
116
+
93
117
# The Menu
118
+
94
119
I've added a menu to make things easier. It is good to familiarise yourself with the installation process.
95
120
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.
96
121
97
122
Navigate to the project folder and run `./menu.sh`
98
123
99
124
## Installing from the menu
125
+
100
126
Select the first option and follow the prompts
101
127
102
128
## Build the docker-compose file
129
+
103
130
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.
104
131
105
132
## Docker commands
133
+
106
134
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.
107
135
108
136
## Miscellaneous commands
137
+
109
138
Some helpful commands have been added like disabling swap.
110
139
111
140
# Running Docker commands
141
+
112
142
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.
113
143
114
144
## Starting and Stopping containers
145
+
115
146
to start the stack navigate to the project folder containing the docker-compose.yml file
116
147
117
148
To start the stack run:
@@ -125,14 +156,17 @@ The first time you run 'start' the stack docker will download all the images for
125
156
The 'docker-compose down' command stops the containers then deletes them. To stop the container but not delete it, run 'docker-compose stop'.
126
157
127
158
## Persistent data
159
+
128
160
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.
129
161
130
162
# See Wiki for further info
131
-
[Wiki](https://github.com/gcgarner/IOTstack/wiki)
132
163
164
+
[Wiki](https://github.com/gcgarner/IOTstack/wiki)
133
165
134
166
# Add to the project
167
+
135
168
Feel free to add your comments on features or images that you think should be added.
0 commit comments