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
Copy file name to clipboardExpand all lines: README.md
+30-18
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,12 @@
1
-
# Announcements
1
+
# IOTStack
2
+
3
+
IOTstack is a builder for docker-compose to easily make and maintain IoT stacks on the Raspberry Pi
4
+
5
+
## Announcements
2
6
3
7
The bulk of the README has moved to the Wiki. Please check it out [here](https://github.com/gcgarner/IOTstack/wiki)
4
8
9
+
* 2019-11-28 PR @stfnhmplr fixed incorrect shegang on MariaDB terminal.sh
5
10
* 2019-11-28 Added native install for RPIEasy
6
11
* 2019-11-27 Additions: NextCloud, MariaDB, MotionEye, Mozilla Webthings, blynk-server (fixed issue with selection.txt)
7
12
* 2019-11-22 BUGFIX selection.txt failed on fresh install, added pushd IOTstack to menu to ensure correct path
@@ -27,7 +32,7 @@ The bulk of the README has moved to the Wiki. Please check it out [here](https:/
27
32
28
33
***
29
34
30
-
# Coming soon
35
+
##Coming soon
31
36
32
37
* Detection of arhcitecture for seperate stack options for amd64, armhf, i386
33
38
* autocleanup of backups on cloud
@@ -38,7 +43,7 @@ The bulk of the README has moved to the Wiki. Please check it out [here](https:/
38
43
39
44
***
40
45
41
-
#IOTstack
46
+
## About
42
47
43
48
Docker stack for getting started on IoT on the Raspberry Pi.
44
49
@@ -60,6 +65,9 @@ This Docker stack consists of:
60
65
* Telegraf (wiki coming soon)
61
66
* RTL_433
62
67
* EspruinoHub (testing)
68
+
* MotionEye
69
+
* MariaDB
70
+
* Plex
63
71
64
72
In addition, there is a write-up and some scripts to get a dynamic DNS via duckdns and VPN up and running.
65
73
@@ -75,29 +83,29 @@ The container will fail if you try to run the docker and native vesions as the s
75
83
76
84
For those looking for a script that installs native applications check out [Peter Scargill's script](https://tech.scargill.net/the-script/)
77
85
78
-
# Tested platform
86
+
##Tested platform
79
87
80
88
Raspberry Pi 3B and 4B Raspbian (Buster)
81
89
82
-
## Older Pi's
90
+
###Older Pi's
83
91
84
92
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/)
85
93
86
94
## Running under a virtual machine
87
95
88
96
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.
89
97
90
-
# Feature Requests
98
+
##Feature Requests
91
99
92
100
Please direct all feature requests to [Discord](https://discord.gg/W45tD83)
93
101
94
-
# Youtube reference
102
+
##Youtube reference
95
103
96
104
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.
97
105
98
106
[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
99
107
100
-
# Download the project
108
+
##Download the project
101
109
102
110
1.On the lite image you will need to install git first
103
111
@@ -119,30 +127,30 @@ Due to some script restraints, this project needs to be stored in ~/IOTstack
119
127
cd~/IOTstack
120
128
```
121
129
122
-
# The Menu
130
+
##The Menu
123
131
124
132
I've added a menu to make things easier. It is good to familiarise yourself with the installation process.
125
133
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.
126
134
127
135
Navigate to the project folder and run `./menu.sh`
128
136
129
-
## Installing from the menu
137
+
###Installing from the menu
130
138
131
139
Select the first option and follow the prompts
132
140
133
-
## Build the docker-compose file
141
+
###Build the docker-compose file
134
142
135
143
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.
136
144
137
-
## Docker commands
145
+
###Docker commands
138
146
139
147
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.
140
148
141
-
## Miscellaneous commands
149
+
###Miscellaneous commands
142
150
143
151
Some helpful commands have been added like disabling swap.
144
152
145
-
# Running Docker commands
153
+
##Running Docker commands
146
154
147
155
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.
148
156
@@ -164,14 +172,18 @@ The `docker-compose down` command stops the containers then deletes them.
164
172
165
173
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.
166
174
167
-
# See Wiki for further info
175
+
##See Wiki for further info
168
176
169
177
[Wiki](https://github.com/gcgarner/IOTstack/wiki)
170
178
171
-
# Add to the project
179
+
##Add to the project
172
180
173
181
Feel free to add your comments on features or images that you think should be added.
174
182
175
-
# Contributions
183
+
## Contributions
184
+
185
+
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.
0 commit comments