Skip to content

Commit 73a5abe

Browse files
authored
Merge pull request SensorsIot#737 from Paraphraser/20231014-documentation-master
2023-10-14 documentation - master branch
2 parents 2cc7488 + eeb436f commit 73a5abe

19 files changed

+209
-310
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,56 @@ IOTstack is a builder for docker-compose to easily make and maintain IoT stacks
44

55
## introduction to IOTstack - videos
66

7-
These are from 2019 and 2020. Though IOTstack has changed quite a bit, they are
8-
still a great overview
7+
IOTstack changes a fair bit so YouTube videos only reflect a moment in time and tend to date quickly. These videos contain excellent overviews but you should rely more on the written documentation than anything you see in the videos.
98

10-
Andreas Spiess Video #295: Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc: IOTstack
9+
Andreas Spiess:
1110

12-
[![#295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc: IOTstack](http://img.youtube.com/vi/a6mjt8tWUws/0.jpg)](https://www.youtube.com/watch?v=a6mjt8tWUws)
11+
* 2023-10-01 Upgrade your Raspberry Pi to a Homelab (instead of a Raspberry Pi 5)
1312

14-
Andreas Spiess Video #352: Raspberry Pi4 Home Automation Server (incl. Docker, OpenHAB, HASSIO, NextCloud)
13+
[![20231001](http://img.youtube.com/vi/xVq_5f0aFlw/0.jpg)](https://www.youtube.com/watch?v=xVq_5f0aFlw)
1514

16-
[![#352 Raspberry Pi4 Home Automation Server (incl. Docker, OpenHAB, HASSIO, NextCloud)](http://img.youtube.com/vi/KJRMjUzlHI8/0.jpg)](https://www.youtube.com/watch?v=KJRMjUzlHI8)
15+
* 2022-11-20 #443 I found an Excellent Raspberry Pi Replacement for Home Assistant / IOTstack (incl. Proxmox)
16+
17+
[![#443](http://img.youtube.com/vi/rXc_zGRYhLo/0.jpg)](https://www.youtube.com/watch?v=rXc_zGRYhLo)
18+
19+
* 2020-11-22 #362 Wireguard and NextCloud on a Raspberry Pi = Marvellous (Docker, IOTstack)
20+
21+
[![#362](http://img.youtube.com/vi/7Pe-Cv0tnLs/0.jpg)](https://www.youtube.com/watch?v=7Pe-Cv0tnLs)
22+
23+
* 2020-09-13 #352 Raspberry Pi4 Home Automation Server (incl. Docker, OpenHAB, HASSIO, NextCloud)
24+
25+
[![#352](http://img.youtube.com/vi/KJRMjUzlHI8/0.jpg)](https://www.youtube.com/watch?v=KJRMjUzlHI8)
26+
27+
* 2019-10-27 #295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc: IOTstack
28+
29+
[![#295](http://img.youtube.com/vi/a6mjt8tWUws/0.jpg)](https://www.youtube.com/watch?v=a6mjt8tWUws)
30+
31+
OneMarcFifty:
32+
33+
* 2021-02-02 Raspberry Pi 4 Home Automation Server with IOTstack
34+
35+
[![20210202](http://img.youtube.com/vi/5a2qhKMetGU/0.jpg)](https://www.youtube.com/watch?v=5a2qhKMetGU)
1736

1837
### getting started
1938

2039
See [Getting Started](https://sensorsiot.github.io/IOTstack/Getting-Started) in the [IOTstack Wiki](https://sensorsiot.github.io/IOTstack/). It includes:
2140

22-
* A link to Andreas Spiess videos #295 and #352.
2341
* How to download the project (including constraints you need to observe).
2442
* How to migrate from the older gcgarner/IOTstack repository.
2543
* Running the menu to install Docker and set up your containers.
2644
* Useful Docker commands (start \& stop the stack, manage containers).
2745
* Stack maintenance.
2846

29-
### significant change to networking
30-
31-
After 2022-01-18 the menu has changed to use Docker networks differently. Users from before this need to do [migration](https://sensorsiot.github.io/IOTstack/Updates/migration-network-change/) in order to add new services. In essence, just re-select all your services using the menu. If not done, docker-compose will give you an error like:
47+
### reporting issues
3248

33-
```
34-
ERROR: Service "influxdb" uses an undefined network "iotstack_nw"
35-
```
49+
Please use the [issues](https://github.com/SensorsIot/IOTstack/issues) tab to report issues or make suggestions for new features or containers.
3650

37-
### contributions
51+
### submitting pull requests
3852

39-
Please use the [issues](https://github.com/SensorsIot/IOTstack/issues) tab to report issues.
53+
Pull Requests are always welcome. Your contribution helps improve the project for everyone. Please see [creating Pull Requests](https://gist.github.com/Paraphraser/818bf54faf5d3b3ed08d16281f32297d) for a guide on the process.
4054

41-
### Need help? Have a feature suggestion? Discovered a bug?
55+
### community
4256

4357
We have a Discord server setup for discussions: [IOTstack Discord channel](https://discord.gg/ZpKHnks) if you want to comment on features, suggest new container types, or ask the IOTstack community for help.
4458

45-
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 [creating Pull Requests](https://gist.github.com/Paraphraser/818bf54faf5d3b3ed08d16281f32297d) helps improve the projects for everyone.
59+
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.

0 commit comments

Comments
 (0)