Skip to content

Commit

Permalink
Merge pull request #737 from Paraphraser/20231014-documentation-master
Browse files Browse the repository at this point in the history
2023-10-14 documentation - master branch
  • Loading branch information
Slyke authored Dec 16, 2023
2 parents 2cc7488 + eeb436f commit 73a5abe
Show file tree
Hide file tree
Showing 19 changed files with 209 additions and 310 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,56 @@ IOTstack is a builder for docker-compose to easily make and maintain IoT stacks

## introduction to IOTstack - videos

These are from 2019 and 2020. Though IOTstack has changed quite a bit, they are
still a great overview
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.

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

[![#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)
* 2023-10-01 Upgrade your Raspberry Pi to a Homelab (instead of a Raspberry Pi 5)

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

[![#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)
* 2022-11-20 #443 I found an Excellent Raspberry Pi Replacement for Home Assistant / IOTstack (incl. Proxmox)

[![#443](http://img.youtube.com/vi/rXc_zGRYhLo/0.jpg)](https://www.youtube.com/watch?v=rXc_zGRYhLo)

* 2020-11-22 #362 Wireguard and NextCloud on a Raspberry Pi = Marvellous (Docker, IOTstack)

[![#362](http://img.youtube.com/vi/7Pe-Cv0tnLs/0.jpg)](https://www.youtube.com/watch?v=7Pe-Cv0tnLs)

* 2020-09-13 #352 Raspberry Pi4 Home Automation Server (incl. Docker, OpenHAB, HASSIO, NextCloud)

[![#352](http://img.youtube.com/vi/KJRMjUzlHI8/0.jpg)](https://www.youtube.com/watch?v=KJRMjUzlHI8)

* 2019-10-27 #295 Raspberry Pi Server based on Docker, with VPN, Dropbox backup, Influx, Grafana, etc: IOTstack

[![#295](http://img.youtube.com/vi/a6mjt8tWUws/0.jpg)](https://www.youtube.com/watch?v=a6mjt8tWUws)

OneMarcFifty:

* 2021-02-02 Raspberry Pi 4 Home Automation Server with IOTstack

[![20210202](http://img.youtube.com/vi/5a2qhKMetGU/0.jpg)](https://www.youtube.com/watch?v=5a2qhKMetGU)

### getting started

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

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

### significant change to networking

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:
### reporting issues

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

### contributions
### submitting pull requests

Please use the [issues](https://github.com/SensorsIot/IOTstack/issues) tab to report issues.
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.

### Need help? Have a feature suggestion? Discovered a bug?
### community

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.

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.
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.
Loading

0 comments on commit 73a5abe

Please sign in to comment.