docker-documentation/images/docker-domoticz.md

title
domoticz

linuxserver/domoticz

Domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/domoticz:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	✅	arm32v7-<version tag>

Application Setup

To configure Domoticz, go to the IP of your docker host on the port you configured (default 8080), and add your hardware in Setup > Hardware. The user manual is available at www.domoticz.com

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  domoticz:
    image: lscr.io/linuxserver/domoticz:latest
    container_name: domoticz
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - WEBROOT=domoticz #optional
      - "DBASE=<path to database>" #optional
    volumes:
      - /path/to/data:/config
    ports:
      - 8080:8080
      - 6144:6144
      - 1443:1443
    devices:
      - path to device:path to device
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=domoticz \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e WEBROOT=domoticz `#optional` \
  -e DBASE="<path to database>" `#optional` \
  -p 8080:8080 \
  -p 6144:6144 \
  -p 1443:1443 \
  -v /path/to/data:/config \
  --device path to device:path to device \
  --restart unless-stopped \
  lscr.io/linuxserver/domoticz:latest

Passing Through USB Devices

To get full use of Domoticz, you probably have a USB device you want to pass through. To figure out which device to pass through, you have to connect the device and look in dmesg for the device node created. Issue the command 'dmesg | tail' after you connected your device and you should see something like below.

usb 1-1.2: new full-speed USB device number 7 using ehci-pci
ftdi_sio 1-1.2:1.0: FTDI USB Serial Device converter detected
usb 1-1.2: Detected FT232RL
usb 1-1.2: FTDI USB Serial Device converter now attached to ttyUSB0

As you can see above, the device node created is ttyUSB0. It does not say where, but it's almost always in /dev/. The correct tag for passing through this USB device is '--device /dev/ttyUSB0:/dev/ttyUSB0'

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter	Function
8080	WebUI
6144	Domoticz communication port.
1443	Domoticz communication port.

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Etc/UTC	specify a timezone to use, see this list.
WEBROOT=domoticz	Sets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying.
DBASE=<path to database>	Sets path to database. Do not set unless you know what this does.

Volume Mappings (-v)

Volume	Function
/config	Where Domoticz stores config files and data.

Device Mappings (--device)

Parameter	Function
path to device	For passing through USB devices.

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:
  • docker exec -it domoticz /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f domoticz
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest

Versions

• 20.02.23: - Migrate to s6v3.
• 15.10.22: - Remove deprecated legacy stable branches.
• 05.02.22: - Set default webroot to /. Add env. variable for setting custom databas path.
• 26.12.20: - Rebase to Ubuntu Focal, see here for troubleshooting armhf.
• 24.11.19: - Change to using domoticz builtin Lua and MQTT.
• 03.11.19: - Set capabilities for domoticz binary and move cmake from edge repo.
• 28.06.19: - Rebasing to alpine 3.10. Add iputils for ping. Fix typo in readme. Fix permissions for custom icons.
• 12.05.19: - Add boost dependencies and turn off static boost build. Bump to Alpine 3.9.
• 30.03.19: - Add env variable to set webroot.
• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
• 19.02.19: - Fix branch for version logic.
• 11.02.19: - Add pipeline logic and multi arch.
• 02.07.18: - Add openssh package.
• 01.07.18: - Fix backup/restore in webgui.
• 03.04.18: - Add dependencies for BroadlinkRM2 plugin.
• 20.01.18: - Move telldus core to repo to prevent build fail when source site goes down.
• 18.01.18: - Remove logging to syslog in the run command to prevent double logging.
• 04.01.18: - Deprecate cpu_core routine lack of scaling.
• 08.12.17: - Rebase to alpine 3.7.
• 26.11.17: - Use cpu core counting routine to speed up build time.
• 28.05.17: - Rebase to alpine 3.6.
• 26.02.17: - Add curl and replace openssl with libressl.
• 11.02.17: - Update README.
• 03.01.17: - Initial Release.