diff --git a/debian/scripts/iobroker_startup.sh b/debian/scripts/iobroker_startup.sh index ef5e6b8..643eeb8 100644 --- a/debian/scripts/iobroker_startup.sh +++ b/debian/scripts/iobroker_startup.sh @@ -74,9 +74,6 @@ echo "----- Step 1 of 5: Preparing container echo "$(printf -- '-%.0s' {1..80})" echo ' ' -# Adding ckeck file for easy docker detection by ioBroker -# echo "${VERSION}" > /opt/scripts/.docker_config/.thisisdocker # <<< moved to dockerfile - # Installing/updating additional packages, registering maintenance script and setting uid/gid if [ "$packages" != "" ] || [ $(cat /etc/group | grep 'iobroker:' | cut -d':' -f3) != $setgid ] || [ $(cat /etc/passwd | grep 'iobroker:' | cut -d':' -f3) != $setuid ] || [ -f /opt/.firstrun ] then @@ -132,8 +129,6 @@ then echo "There is no data detected in /opt/iobroker." echo "Restoring initial ioBroker installation..." tar -xf /opt/initial_iobroker.tar -C / - # Removing UUID generated on docker image build - #bash iobroker unsetup -y # <<< moved to dockerfile echo "Done." elif [ -f /opt/iobroker/iobroker ] then @@ -158,11 +153,6 @@ then echo "Done." echo "Restoring ioBroker..." bash iobroker restore 0 > /opt/iobroker/log/restore.log 2>&1 - # fixing hostname issues when restoring on different host - open issue https://github.com/ioBroker/ioBroker.js-controller/issues/1450 - #if [ $(jq -r .system.hostname ./iobroker-data/iobroker.json) != $(hostname) ] - #then - # bash iobroker host $(jq -r .system.hostname ./iobroker-data/iobroker.json) - #fi echo "Done." echo ' ' echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" diff --git a/src/README_docker_hub_buanet.md b/src/README_docker_hub_buanet.md index a0be349..353733d 100644 --- a/src/README_docker_hub_buanet.md +++ b/src/README_docker_hub_buanet.md @@ -1,4 +1,4 @@ - + [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/buanet/iobroker/latest?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Pulls](https://img.shields.io/docker/pulls/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) @@ -19,6 +19,7 @@ * Where to report issues: [Github Repository Issues](https://github.com/buanet/ioBroker.docker/issues) * 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/) # Supported tags @@ -29,7 +30,9 @@ # What is ioBroker? -Text coming soon. +IoBroker is a open source IoT platform written in JavaScript that easily connects smarthome componets from different manufactures. With the help of plugins (called: "adapters") ioBroker is able to communicate with a big variety of IoT hardware and services using different protocols and APIs.
+All data is stored in a central database that all adapters can access. With this it is very easy to build up logical connections, automation scripts and beautiful visualisations.
+For further details please check out [iobroker.net](https://www.iobroker.net). # How to use this image? @@ -103,6 +106,16 @@ You could use environment variables to auto configure your ioBroker container on * `TZ` (optional, default: Europe/Berlin) Specifys the timeszone * `USBDEVICES` (optional) Sets relevant permissions on mounted devices like "/dev/ttyACM0". For more than one device separate with ";". +## Notes about Docker networks + +The examples above are dealing with the Docker default bridge network. In general there are [some reasons](https://docs.docker.com/network/bridge/#differences-between-user-defined-bridges-and-the-default-bridge) why it might be the better choice to use a user-defined bridge network. + +Using a Docker bridge network works fine for taking a first look and with most of the ioBroker adapters (if you dont forget to redirect the ports your adapers use).
+But some ioBroker adapters are using techniques like [Multicast](https://en.wikipedia.org/wiki/Multicast) or [Broadcast](https://en.wikipedia.org/wiki/Broadcasting_(networking)) for automatic detection of IoT devices
+In this case it may be useful to switch to [host](https://docs.docker.com/network/host/) or [MACVLAN](https://docs.docker.com/network/macvlan/) network. + +For more information about networking with Docker please refer to the [official Docker docs](https://docs.docker.com/network/). + # Support the Project If you like what you see please leave us stars and likes on our repos and join our growing community. diff --git a/src/README_docker_hub_iobroker.md b/src/README_docker_hub_iobroker.md index 2b0dd71..26768ef 100644 --- a/src/README_docker_hub_iobroker.md +++ b/src/README_docker_hub_iobroker.md @@ -1,4 +1,4 @@ - + [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/buanet/iobroker/latest?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) [![Docker Pulls](https://img.shields.io/docker/pulls/buanet/iobroker?style=flat)](https://hub.docker.com/repository/docker/buanet/iobroker) @@ -18,6 +18,7 @@ * Where to report issues: [Github Repository Issues](https://github.com/buanet/ioBroker.docker/issues) * 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/) # Supported tags @@ -28,7 +29,9 @@ # What is ioBroker? -Text coming soon. +IoBroker is a open source IoT platform written in JavaScript that easily connects smarthome componets from different manufactures. With the help of plugins (called: "adapters") ioBroker is able to communicate with a big variety of IoT hardware and services using different protocols and APIs.
+All data is stored in a central database that all adapters can access. With this it is very easy to build up logical connections, automation scripts and beautiful visualisations.
+For further details please check out [iobroker.net](https://www.iobroker.net). # How to use this image? @@ -102,6 +105,16 @@ You could use environment variables to auto configure your ioBroker container on * `TZ` (optional, default: Europe/Berlin) Specifys the timeszone * `USBDEVICES` (optional) Sets relevant permissions on mounted devices like "/dev/ttyACM0". For more than one device separate with ";". +## Notes about Docker networks + +The examples above are dealing with the Docker default bridge network. In general there are [some reasons](https://docs.docker.com/network/bridge/#differences-between-user-defined-bridges-and-the-default-bridge) why it might be the better choice to use a user-defined bridge network. + +Using a Docker bridge network works fine for taking a first look and with most of the ioBroker adapters (if you dont forget to redirect the ports your adapers use).
+But some ioBroker adapters are using techniques like [Multicast](https://en.wikipedia.org/wiki/Multicast) or [Broadcast](https://en.wikipedia.org/wiki/Broadcasting_(networking)) for automatic detection of IoT devices
+In this case it may be useful to switch to [host](https://docs.docker.com/network/host/) or [MACVLAN](https://docs.docker.com/network/macvlan/) network. + +For more information about networking with Docker please refer to the [official Docker docs](https://docs.docker.com/network/). + # Support the Project If you like what you see please leave us stars and likes on our repos and join our growing community.