Docker - Revision history

Walter vl at 22:41, 26 March 2026

2026-03-26T22:41:47Z

← Older revision		Revision as of 22:41, 26 March 2026
Line 73:		Line 73:

	<code>docker compose pull && docker compose up --force-recreate --build -d && docker image prune -f</code>		<code>docker compose pull && docker compose up --force-recreate --build -d && docker image prune -f</code>

			To be safe copy first the folder where the docker-compose.yml is as it probably also contains the docker mounted volume data (with the domoticz.db database file, scripts etc).

			<code>cp -r your-dz-folder your-dz-backup-folder</code>

	== Domoticz Docker settings and tips ==		== Domoticz Docker settings and tips ==

Walter vl: /* Python Plugins */

2025-12-18T08:19:50Z

Python Plugins

← Older revision		Revision as of 08:19, 18 December 2025
Line 138:		Line 138:

	=== Python Plugins ===		=== Python Plugins ===
	When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder (inside the container). From the host this could be for example ./home/<user>/domoticz-docker/config/plugins, depending on your docker-compose volume settings. You need to place your python in this folder on the host.		When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder (inside the container). From the host this could be for example ./home/<user>/domoticz-docker/config/plugins, depending on your docker-compose volume settings. You need to place your python plugin in this folder on the host.

	The stable container runs Python 3.11.2. (current beta too)		The stable container runs Python 3.11.2. (current beta too)

Walter vl: /* Python Plugins */

2025-12-18T08:19:15Z

Python Plugins

← Older revision		Revision as of 08:19, 18 December 2025
Line 138:		Line 138:

	=== Python Plugins ===		=== Python Plugins ===
	When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder (inside the container). From the host this could be for example ./home/<user>/domoticz-docker/config/plugins, depending on your docker-compose volume settings. You need to place your python		When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder (inside the container). From the host this could be for example ./home/<user>/domoticz-docker/config/plugins, depending on your docker-compose volume settings. You need to place your python in this folder on the host.

	The stable container runs Python 3.11.2. (current beta too)		The stable container runs Python 3.11.2. (current beta too)

Walter vl: /* Python Plugins */

2025-12-18T08:17:43Z

Python Plugins

← Older revision		Revision as of 08:17, 18 December 2025
Line 138:		Line 138:

	=== Python Plugins ===		=== Python Plugins ===
	When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder You need to place your python ~~plugins in this folder.~~		When launching the docker container for the first time, a plugin folder is created in the mounted ''/opt/domoticz/userdata'' folder (inside the container). From the host this could be for example ./home/<user>/domoticz-docker/config/plugins, depending on your docker-compose volume settings. You need to place your python

	The stable container runs Python 3.11.2. (current beta too)		The stable container runs Python 3.11.2. (current beta too)

Walter vl: /* custom startup script for the container */

2025-12-12T15:09:00Z

custom startup script for the container

← Older revision		Revision as of 15:09, 12 December 2025
Line 113:		Line 113:

	*install incremental apt packages (don't forget to apt update before you apt install)		*install incremental apt packages (don't forget to apt update before you apt install)
	*install incremental python ~~functions~~ (pip3 install)		*install incremental python modules for plugins (pip3 install or pip3 install -r requirements.txt)
	*and so on		*and so on

Walter vl: /* Python Plugins */

2025-12-11T20:59:04Z

Python Plugins

← Older revision		Revision as of 20:59, 11 December 2025
Line 147:		Line 147:

	<code>docker exec -it domoticz bash</code>		<code>docker exec -it domoticz bash</code>

			Then go to the plugin folder and install the modules

			<code>cd /opt/domoticz/userdata/plugins/<yourpluginfolder></code>

			<code>sudo pip3 install -r requirements.txt</code>

	You can use the custom startup script (<code>customstart.sh as</code>mentioned above) to be sure the required python modules are reinstalled when you update the docker image.		You can use the custom startup script (<code>customstart.sh as</code>mentioned above) to be sure the required python modules are reinstalled when you update the docker image.

Walter vl: /* Python Plugins */

2025-12-11T20:52:29Z

Python Plugins

← Older revision		Revision as of 20:52, 11 December 2025
Line 116:		Line 116:
	*and so on		*and so on

	The container calls a script named customstart.sh in userdata, if that script exists. Please note that the script gets called on EVERY start of the container, not just at creation time. If you want the script to run only once, you need to build that in your script (e.g. test for a file you create in the script).		The container calls a script named <code>customstart.sh</code> in userdata, if that script exists. Please note that the script gets called on EVERY start of the container, not just at creation time. If you want the script to run only once, you need to build that in your script (e.g. test for a file you create in the script).

	Example script		Example script
Line 142:		Line 142:
	The stable container runs Python 3.11.2. (current beta too)		The stable container runs Python 3.11.2. (current beta too)

	When plugins need extra python modules you need to install those in the Docker container! Python is also setup with a venv so no need to do something special on installing the required python modules. You can use the custom startup script (mentioned above) to be sure the required python modules are reinstalled when you update the docker image.		When plugins need extra python modules you need to install those in the Docker container! Python is also setup with a venv so no need to do something special on installing the required python modules.

			Use the following command to get into the docker container:

			<code>docker exec -it domoticz bash</code>

			You can use the custom startup script (<code>customstart.sh as</code>mentioned above) to be sure the required python modules are reinstalled when you update the docker image.

	=== Docker and dzVents ===		=== Docker and dzVents ===

Walter vl: /* Docker and dzVents */

2025-12-09T22:19:21Z

Docker and dzVents

← Older revision		Revision as of 22:19, 9 December 2025
Line 154:		Line 154:
	Dzvents templates:		Dzvents templates:

	When creating a new dzvents script the templates are empty. To repair that add the following line in the customstart.sh file or run the command after a new image deploy in the docker container:		When creating a new dzvents script the templates are empty. To repair that add the following line in the <code>customstart.sh</code> file or run the command after a new image deploy in the docker container:

	<code>cp -r /opt/domoticz/scripts/templates /opt/domoticz/userdata/scripts</code>		<code>cp -r /opt/domoticz/scripts/templates /opt/domoticz/userdata/scripts</code>

Walter vl: /* Docker and dzVents */ dzvents templates

2025-12-09T22:18:48Z

Docker and dzVents: dzvents templates

← Older revision		Revision as of 22:18, 9 December 2025
Line 110:		Line 110:

	=== custom startup script for the container ===		=== custom startup script for the container ===
	The container supports running a custom bash script (customstart.sh in userdata) before the Domoticz process starts. This way, you can customize anything in the container that you need:		The container supports running a custom bash script (<code>customstart.sh</code> in userdata) before the Domoticz process starts. This way, you can customize anything in the container that you need:

	*install incremental apt packages (don't forget to apt update before you apt install)		*install incremental apt packages (don't forget to apt update before you apt install)
Line 132:		Line 132:
	echo 'creating FIRSTRUN file so script can check on next run'		echo 'creating FIRSTRUN file so script can check on next run'
	touch /opt/domoticz/FIRSTRUN		touch /opt/domoticz/FIRSTRUN
	echo 'copying event script templates to external mapped storage ~~/volume1/domoticz/scripts/templates~~		echo 'copying event script templates to external mapped storage
	cp -r /opt/domoticz/scripts/templates /opt/domoticz/userdata/scripts		cp -r /opt/domoticz/scripts/templates /opt/domoticz/userdata/scripts
	cd /opt/domoticz \|\| return		cd /opt/domoticz \|\| return
Line 151:		Line 151:

	Latest beta 2023.1 should have these folders create at startup.		Latest beta 2023.1 should have these folders create at startup.

			Dzvents templates:

			When creating a new dzvents script the templates are empty. To repair that add the following line in the customstart.sh file or run the command after a new image deploy in the docker container:

			<code>cp -r /opt/domoticz/scripts/templates /opt/domoticz/userdata/scripts</code>

	=== Custom templates ===		=== Custom templates ===

Walter vl: /* docker image tags */

2025-11-05T23:42:24Z

docker image tags

← Older revision		Revision as of 23:42, 5 November 2025
Line 55:		Line 55:
	It is possible to use stable (preferred!) and beta images: https://hub.docker.com/r/domoticz/domoticz/tags		It is possible to use stable (preferred!) and beta images: https://hub.docker.com/r/domoticz/domoticz/tags

	'''docker pull ~~domoticz/domoticz:beta''' ''(will pull latest beta version)~~''		with ''docker pull'' or in the image section of the docker-compose.yml:

	'''~~docker pull~~ domoticz/domoticz:~~stable~~''' ''(will pull latest ~~stable~~ version)''		'''domoticz/domoticz:beta''' ''(will pull latest beta version)''

	'''~~docker pull~~ domoticz/domoticz:~~2022.1~~''' ''(will pull latest stable version ~~2022.1~~)''		'''domoticz/domoticz:stable''' ''(will pull latest stable version)''

	'''~~docker~~ pull domoticz/domoticz:2022-beta.12345''' ''(will pull beta with build number 12345)''		'''domoticz/domoticz:2022.1''' ''(will pull latest stable version 2022.1)''

			'''domoticz/domoticz:2022-beta.12345''' ''(will pull beta with build number 12345)''

	tag '''latest''' or no tag will pull the latest uploaded image, so could be a beta or stable image.		tag '''latest''' or no tag will pull the latest uploaded image, so could be a beta or stable image.
Line 166:		Line 168:

	The redirect IP's like <code>localhost</code> and <code>127.0.0.1</code> are directing to the IP's in the container and so not connecting to the IP of the host. The Domoticz Hardware gateways would then not find the expected services running on the server.		The redirect IP's like <code>localhost</code> and <code>127.0.0.1</code> are directing to the IP's in the container and so not connecting to the IP of the host. The Domoticz Hardware gateways would then not find the expected services running on the server.

			=== Dockge ===
			If you have more docker containers next to Domotcz you can use the application Dockge, a fancy, easy-to-use and reactive self-hosted docker compose.yaml stack-oriented manager. See for more information https://github.com/louislam/dockge

	== Debugging ==		== Debugging ==