The LinuxServer.io team brings you another container release featuring:
Find us at:
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.
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 | ❌ |
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
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
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 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
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'
Containers 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.
Parameter | Function |
---|---|
-p 8080 |
WebUI |
-p 6144 |
Domoticz communication port. |
-p 1443 |
Domoticz communication port. |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-e WEBROOT=domoticz |
Sets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying. |
-e DBASE=<path to database> |
Sets path to database. Do not set unless you know what this does. |
-v /config |
Where Domoticz stores config files and data. |
--device path to device |
For passing through USB devices. |
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR
based on the contents of the /run/secrets/mysecretvariable
file.
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.
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 your_user
as below:
id your_user
Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
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.
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
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Update images:
All images:
docker-compose pull
Single image:
docker-compose pull domoticz
Update containers:
All containers:
docker-compose up -d
Single container:
docker-compose up -d domoticz
You can also remove the old dangling images:
docker image prune
Update the image:
docker pull lscr.io/linuxserver/domoticz:latest
Stop the running container:
docker stop domoticz
Delete the container:
docker rm domoticz
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config
folder and settings will be preserved)
You can also remove the old dangling images:
docker image prune
Pull the latest image at its tag and replace it with the same env variables in one run:
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once domoticz
You can also remove the old dangling images: docker image prune
warning: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
tip: We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-domoticz.git
cd docker-domoticz
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/domoticz:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64
.