mirror of
https://github.com/buanet/ioBroker.docker.git
synced 2026-01-10 18:02:17 +02:00
107 lines
5.6 KiB
Markdown
107 lines
5.6 KiB
Markdown
# Official Docker Image for ioBroker
|
|
|
|
<img src="https://github.com/buanet/ioBroker.docker/raw/main/src/img/iobroker_logo.png" width="600" title="ioBroker Logo">
|
|
|
|
[](https://github.com/buanet/ioBroker.docker)
|
|
[](https://github.com/buanet/ioBroker.docker/releases)
|
|
[](https://github.com/buanet/ioBroker.docker/issues)<br>
|
|
[](https://hub.docker.com/repository/docker/buanet/iobroker)
|
|
[](https://hub.docker.com/repository/docker/buanet/iobroker)
|
|
[](https://hub.docker.com/repository/docker/buanet/iobroker)<br>
|
|
[](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md)
|
|
[](https://paypal.me/buanet)
|
|
|
|
The code provided in this repo is used to automatically generate the official Docker Image for ioBroker.
|
|
|
|
If you don't know what ioBroker is, please check out [iobroker.net](https://www.iobroker.net)
|
|
|
|
If you dont know what Docker is, please check out [docker.com](https://docker.com)
|
|
|
|
## Getting started
|
|
|
|
### Basic Information
|
|
|
|
You will find some basic information about the image amd how to use it on the [Docker Hub page](https://hub.docker.com/r/buanet/iobroker) or [here](https://github.com/buanet/ioBroker.docker/blob/main/src/README_docker_hub_buanet.md).
|
|
|
|
### Detailed documentation
|
|
|
|
You will find a detailed documentation of the image at the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/).
|
|
|
|
### Get the image
|
|
|
|
You can pull the Docker image from:
|
|
* [Docker Hub (buanet)](https://hub.docker.com/r/buanet/iobroker)
|
|
* [Docker Hub (iobroker)](https://hub.docker.com/r/iobroker/iobroker)
|
|
* [GitHub Container Repo](https://github.com/buanet/ioBroker.docker/pkgs/container/iobroker)
|
|
|
|
### Get help
|
|
|
|
If you have any questions or need help please contact the ioBroker community:
|
|
* [ioBroker Forum]()
|
|
* [Discord Channel]()
|
|
* [Facebook Group]()
|
|
* [Telegram Group]()
|
|
|
|
### Report an issue or request a feature
|
|
|
|
If you found an issue or missing some feature please let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues).
|
|
|
|
## Important notice
|
|
|
|
In general a new major version (e.g. v2, v4, v5) of the image comes with a new, preinstalled major node version!
|
|
If you are updating an existing installation to a new major version (e.g. from v4 to v5) you have to perform some additional steps inside ioBroker! For more details please see official ioBroker documentation: [EN](https://www.iobroker.net/#en/documentation/install/updatenode.md) | [DE](https://www.iobroker.net/#de/documentation/install/updatenode.md).<br>
|
|
|
|
You might avoid these procedure if you use my "Best practice" hint for "upgrading your ioBroker container".
|
|
|
|
In any case make a backup first!
|
|
|
|
## Miscellaneous
|
|
|
|
### Beta testing
|
|
|
|
If you want to get the newest features and changes feel free to use/ test the beta version of the Docker image. You can find the readme.md file for beta versions [here](https://github.com/buanet/ioBroker.docker/blob/beta/README.md). Please make sure to read the changelog before testing beta versions.
|
|
|
|
### Subscribe to updates
|
|
|
|
If you want the newest updates about the image and my tutorials at https://smarthome.buanet.de you can simply subscribe to my new "news and updates" channel (only in German) on Telegram.
|
|
You will find the channel here: https://t.me/buanet_tutorials
|
|
|
|
### Support the project
|
|
|
|
The easiest way to support this project is to leave me some likes/ stars on Github and Docker hub!<br>
|
|
If you want to give something back, feel free to take a look into the [open issues](https://github.com/buanet/ioBroker.docker/issues) or the [ioBroker forum thread](http://forum.iobroker.net/viewtopic.php?f=17&t=5089) and helping me answering questions, fixing bugs or adding new features!<br>
|
|
And if you want to buy me a beer instead, you can do this here: <a href="https://www.paypal.me/buanet" target="_blank"><img src="https://buanet.de/wp-content/uploads/2017/08/pp128.png" height="20" width="20"></a><br>
|
|
Thank you!
|
|
|
|
## Changelog
|
|
|
|
Moved to [CHANGELOG.md](CHANGELOG.md).
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2017-2021 André Germann
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
## Credits
|
|
|
|
Inspired by https://github.com/MehrCurry/docker-iobroker
|