mirror of
https://github.com/buanet/ioBroker.docker.git
synced 2025-12-17 10:29:00 +02:00
docs
This commit is contained in:
buanet
41
README.md
41
README.md
@@ -2,39 +2,42 @@
|
||||
|
||||
<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/actions/workflows/build-debian-image-main.yml)
|
||||
[](https://github.com/buanet/ioBroker.docker/releases)
|
||||
[](https://github.com/buanet/ioBroker.docker/issues)<br>
|
||||
[](https://github.com/buanet/ioBroker.docker)
|
||||
[](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)
|
||||
## Quick links
|
||||
|
||||
If you dont know what Docker is, please check out [docker.com](https://docker.com)
|
||||
Don't know what's ioBroker? :arrow_right: [iobroker.net](https://www.iobroker.net)<br>
|
||||
Don't know what's Docker? :arrow_right: [docker.com](https://docker.com)<br>
|
||||
Looking for documentation? :arrow_right: [docs.buanet.de](https://docs.buanet.de/iobroker-docker-image/docs/)
|
||||
|
||||
## Getting started
|
||||
## FAQ (frequently asked questions)
|
||||
|
||||
### Basic Information
|
||||
### How to run the image?
|
||||
|
||||
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).
|
||||
You con find some basic information about the image amd how to run 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
|
||||
### Is there a more detailed documentation?
|
||||
|
||||
You will find a detailed documentation of the image at the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/).
|
||||
You con find a detailed documentation of the image on the new [docs page](https://docs.buanet.de/iobroker-docker-image/docs/).
|
||||
|
||||
### Get the image
|
||||
### Where can I pull 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
|
||||
### Where can I get help?
|
||||
|
||||
If you have any questions or need help please contact the ioBroker community:
|
||||
* [ioBroker Forum]()
|
||||
@@ -42,18 +45,14 @@ If you have any questions or need help please contact the ioBroker community:
|
||||
* [Facebook Group]()
|
||||
* [Telegram Group]()
|
||||
|
||||
### Report an issue or request a feature
|
||||
### How to 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).
|
||||
If you think you found an issue let us know by opening an [GitHub issue](https://github.com/buanet/ioBroker.docker/issues). Make sure you have googled it before.
|
||||
Please do not use the issues for support questions. Not every error message is worth a new report. Use [discussions](https://github.com/buanet/ioBroker.docker/discussions) if you are not sure.
|
||||
|
||||
## Important notice
|
||||
### Is there something else I have to know?
|
||||
|
||||
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!
|
||||
Always have an actual valid backup of your ioBroker. You can easily create a backup by using the `iobroker backup` command or the preinstalled backitup adapter.
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
# Important Note
|
||||
|
||||
New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at the brand new [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/).
|
||||
New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/).
|
||||
|
||||
# Quick reference
|
||||
|
||||
@@ -22,7 +22,7 @@ New major image versions (e.g. v4, v5, v6) always come with a new major version
|
||||
* Supported architectures: amd64, arm32v7, arm64v8
|
||||
* Changelog: [Github Repository Changelog](https://github.com/buanet/ioBroker.docker/blob/main/CHANGELOG.md)
|
||||
* Source code: [Github Repository](https://github.com/buanet/ioBroker.docker)
|
||||
* All other questions should be answered here: [Official ioBroker Docker Image Docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/)
|
||||
* All other questions should be answered here: [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/)
|
||||
|
||||
# Supported tags
|
||||
|
||||
|
||||
@@ -3,13 +3,15 @@
|
||||
[](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/docker.watchdog/actions/workflows/docker_build_main_image.yml)
|
||||
[)](https://github.com/buanet/ioBroker.docker/actions/workflows/build-debian-image-main.yml)
|
||||
[](https://github.com/buanet/ioBroker.docker/releases)
|
||||
[](https://github.com/buanet/ioBroker.docker/issues)<br>
|
||||
[](https://github.com/buanet/ioBroker.docker)
|
||||
[](https://github.com/buanet/ioBroker.docker/blob/master/LICENSE.md)
|
||||
|
||||
**Note:** New major versions (e.g. v4, v5, v6) of the image always come with a new major verson of node (preinstalled). To avoid issues when upgrading into a new major version the best practice recommendation is to migrate using backup and restore procedure. For more details please see "Best Practices" section on official [readme.md](https://github.com/buanet/ioBroker.docker#best-practices).
|
||||
# Important Note
|
||||
|
||||
New major image versions (e.g. v4, v5, v6) always come with a new major version of node! This might lead to problems when you update your ioBroker container by simply recreating it from the new major version image! To avoid having trouble with recompiling adapters, it is recommended to upgrade your container manually with backup and restore procedure. For more details please see "Best Practices" section at our new [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/).
|
||||
|
||||
# Quick reference
|
||||
|
||||
@@ -19,11 +21,17 @@
|
||||
* Supported architectures: amd64, arm32v7, arm64v8
|
||||
* Changelog: [Github Repository Changelog](https://github.com/buanet/ioBroker.docker/blob/main/CHANGELOG.md)
|
||||
* Source code: [Github Repository](https://github.com/buanet/ioBroker.docker)
|
||||
* All other questions should be answered here: [Github Repository Readme](https://github.com/buanet/ioBroker.docker#readme) or [iobroker.net](https://www.iobroker.net/)
|
||||
* All other questions should be answered here: [ioBroker Docker image docs](https://docs.buanet.de/iobroker-docker-image/docs/) or [iobroker.net](https://www.iobroker.net/)
|
||||
|
||||
# Supported tags
|
||||
|
||||
* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile)
|
||||
It is highly recommended not to use the `latest` tag for production, especially when using any kind of automated update procedure like watchtower. Please use the `latest-vX` tag instead.
|
||||
|
||||
### Node 14 versions
|
||||
* [`v6.0.0`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`v6.0.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest-v6`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile), [`latest`](https://github.com/buanet/ioBroker.docker/blob/v6.0.0/debian/node14/Dockerfile)
|
||||
|
||||
### Node 12 versions
|
||||
* [`v5.2.0`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm32v7`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`v5.2.0-arm64v8`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile), [`latest-v5`](https://github.com/buanet/ioBroker.docker/blob/v5.2.0/debian/node12/Dockerfile)
|
||||
* [`v5.1.0`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/amd64/Dockerfile), [`v5.1.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/armv7hf/Dockerfile), [`v5.1.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.1.0/aarch64/Dockerfile)
|
||||
* [`v5.0.0`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-amd64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/amd64/Dockerfile), [`v5.0.0-armv7hf`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/armv7hf/Dockerfile), [`v5.0.0-aarch64`](https://github.com/buanet/ioBroker.docker/blob/v5.0.0/aarch64/Dockerfile)
|
||||
|
||||
@@ -40,7 +48,7 @@ For further details please check out [iobroker.net](https://www.iobroker.net).
|
||||
For taking a first look at iobroker on docker it would be enough to simply run the following basic docker run command:
|
||||
|
||||
```
|
||||
docker run -p 8081:8081 --name iobroker -h iobroker iobroker/iobroker
|
||||
docker run -p 8081:8081 --name iobroker -h iobroker buanet/iobroker
|
||||
```
|
||||
|
||||
## Running with docker-compose
|
||||
@@ -53,7 +61,7 @@ version: '2'
|
||||
services:
|
||||
iobroker:
|
||||
container_name: iobroker
|
||||
image: iobroker/iobroker
|
||||
image: buanet/iobroker
|
||||
hostname: iobroker
|
||||
restart: always
|
||||
ports:
|
||||
|
||||
Reference in New Issue
Block a user