duffbeer2000/iobroker repository overview

⁠ioBroker Docker Image

This Docker image containerizes the ioBroker software from ioBroker GmbH. ioBroker is an integration platform for the Internet of Things, focused on Building Automation, Smart Metering, Ambient Assisted Living, Process Automation, Visualization and Data Logging.

ioBroker is supported on amd64, armv7hf (i.e. RaspberryPi 2/3), and aarch64 architectures.

This image is available on (and should be pulled from) Docker Hub: duffbeer2000/iobroker.

Current ioBroker version: 2.0.2

⁠Running the ioBroker Container

⁠Command Line

docker run -d \
    --name=iobroker \
    --net=host \
    --restart=always \
    --v /etc/localtime:/etc/localtime:ro \
    --v /your/iobroker/folder:/opt/iobroker \
    duffbeer2000/iobroker

⁠Command line Options

⁠Environment Variables

Use these environment variables to change the default behaviour of the container.

⁠Docker-Compose

A docker-compose.yml file is provided in the root of this image's GitHub repo. You may also copy/paste the following into your existing docker-compose.yml, modifying the options as required (omit the version and services lines as your docker-compose.yml will already contain these).

version: "2"
services:
  iobroker:
    image: duffbeer2000/iobroker
    container_name: iobroker
    network_mode: host
    restart: always
    volumes:
      - /your/iobroker/folder:/opt/iobroker
    environment:
      - LANG=de_DE.UTF-8
      - TZ=Europe/Berlin
      - IOBROKER_ADMIN_PORT=8081
      - IOBROKER_WEB_PORT=8082
      - AVAHI=0
      - BT_ENABLE=0
      - ASTERISK=0

Then, you can do docker-compose pull to pull the latest duffbeer2000/iobroker image, docker-compose up -d to start the iobroker container service, and docker-compose down to stop the iobroker service and delete the container. Note that these commands will also pull, start, and stop any other services defined in docker-compose.yml.

⁠Running on Docker for Mac / Docker for Windows

The --net=host option is not yet supported on Mac/Windows. To run this container on those platforms, explicitly specify the ports in the run command and omit --net=host:

docker run -d \
    --name=iobroker \
    -p 8081:8081 \
    -p 8082:8082 \
    --restart=always \
    -v /your/iobroker/folder:/opt/iobroker \
    -e IOBROKER_ADMIN_PORT=8081 \
    -e IOBROKER_WEB_PORT=8082 \
    marthoc/deconz

⁠Tags

⁠Features of the different versions standard(latest), full and min

latest:

• Set AVAHI to 1 for yahka support
• Set IOBROKER_ADMIN_PORT to change the port of the admin adapter
• Set IOBROKER_WEB_PORT to change the port of the web adapter
• If the iobroker folder is empty during startup it restores it to factory default
• If a file with the name "UPGRADE" is detected in the iobroker folder the startup script runs a "npm rebuild" in the ioBroker folder. Only do this if you restore a ioBroker folder which was installed with a npm version prior to v8.
• If a file with the name "pre_script.sh" is detected in the iobroker folder the startup script makes it runable and starts it
• If a file with the name "custom_packages.list" is detected in the iobroker folder it installs all packages in the file
• If a file with the name "post_script.sh" is detected in the iobroker folder the startup script makes it runable and starts it
• If a file with NPM_UPGRADE_TRIGGER="/opt/iobroker/REINSTALL"
• Corrects file and folder permissions for ioBroker
• Starts ioBroker with the user "iobroker"

full:

• The full version scans all installed adapters and installs all known dependencies (if there is something missing or not longer needed please open an issue on github)
• Set AVAHI enable avahi support. If yahka adapter is installed avahi gets enabled automatically
• Set IOBROKER_ADMIN_PORT to change the port of the admin adapter
• Set IOBROKER_WEB_PORT to change the port of the web adapter
• Set BT_ENABLE to 1if you have a bluetooth stick or something like that installed
• Set ASTERISK to: *1 = ioBroker & asterisk running on same server with ffmpeg *2 = ioBroker & asterisk running on same server with sox *3 = ioBroker & asterisk running on different server with ffmpeg *4 = ioBroker & asterisk running on different server with sox
• If the iobroker folder is empty during startup it restores it to factory default
• If a file with the name "UPGRADE" is detected in the iobroker folder the startup script runs a "npm rebuild" in the ioBroker folder. Only do this if you restore a ioBroker folder which was installed with a npm version prior to v8.
• If a file with the name "pre_script.sh" is detected in the iobroker folder the startup script makes it runable and starts it
• If a file with the name "custom_packages.list" is detected in the iobroker folder it installs all packages in the file
• If a file with the name "post_script.sh" is detected in the iobroker folder the startup script makes it runable and starts it
• If a file with NPM_UPGRADE_TRIGGER="/opt/iobroker/REINSTALL"
• Corrects file and folder permissions for ioBroker
• Starts ioBroker with the user "iobroker"

min:

• Minimal version, is running fine too but needs a little bit more work
• Set AVAHI enable avahi support. If yahka adapter is installed avahi gets enabled automatically
• Set IOBROKER_ADMIN_PORT to change the port of the admin adapter
• Set IOBROKER_WEB_PORT to change the port of the web adapter
• If the iobroker folder is empty during startup it restores it to factory default
• Starts ioBroker with the user "iobroker"

⁠Gotchas / Known Issues

At the moment I'm testing the language settings. Changing the language with an environment variable is not working at the moment.

⁠Issues / Contributing

Please raise any issues with this container at its GitHub repo: https://github.com/duffbeer2000/docker-iobroker⁠. Please check the "Gotchas / Known Issues" section above before raising an Issue on GitHub in case the issue is already known.

To contribute, please fork the GitHub repo, create a feature branch, and raise a Pull Request; for simple changes/fixes, it may be more effective to raise an Issue instead.

⁠Building Locally

Pulling duffbeer2000/iobroker from Docker Hub is the recommended way to obtain this image. However, you can build this image locally by:

git clone https://github.com/duffbeer2000/docker-iobroker.git
cd dockertravis
docker build -t "[your-user/]iobroker[:local]" ./[arch]

⁠Acknowledgments

ioBroker GmbH for making ioBroker.

@buanet for his iobroker container from which I was inspired: https://github.com/buanet/docker-iobroker⁠.