kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
329dd014b9
commit
1baf4a5d61
|
|
@ -1,6 +1,14 @@
|
||||||
# linuxserver/domoticz
|
# [linuxserver/domoticz](https://github.com/linuxserver/docker-domoticz)
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-domoticz) [](https://github.com/linuxserver/docker-domoticz/releases) [](https://github.com/linuxserver/docker-domoticz/packages) [](https://gitlab.com/Linuxserver.io/docker-domoticz/container_registry) [](https://quay.io/repository/linuxserver.io/domoticz) [](https://microbadger.com/images/linuxserver/domoticz) [](https://hub.docker.com/r/linuxserver/domoticz) [](https://hub.docker.com/r/linuxserver/domoticz) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/index.html)
|
[](https://github.com/linuxserver/docker-domoticz)
|
||||||
|
[](https://github.com/linuxserver/docker-domoticz/releases)
|
||||||
|
[](https://github.com/linuxserver/docker-domoticz/packages)
|
||||||
|
[](https://gitlab.com/Linuxserver.io/docker-domoticz/container_registry)
|
||||||
|
[](https://microbadger.com/images/linuxserver/domoticz "Get your own version badge on microbadger.com")
|
||||||
|
[](https://hub.docker.com/r/linuxserver/domoticz)
|
||||||
|
[](https://hub.docker.com/r/linuxserver/domoticz)
|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/)
|
||||||
|
[](https://ci-tests.linuxserver.io/linuxserver/domoticz/latest/index.html)
|
||||||
|
|
||||||
[Domoticz](https://www.domoticz.com) 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.
|
[Domoticz](https://www.domoticz.com) 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.
|
||||||
|
|
||||||
|
|
@ -8,12 +16,12 @@
|
||||||
|
|
||||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||||
|
|
||||||
Simply pulling `linuxserver/domoticz` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
Simply pulling `ghcr.io/linuxserver/domoticz` 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:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Tag |
|
| Architecture | Tag |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| x86-64 | amd64-latest |
|
| x86-64 | amd64-latest |
|
||||||
| arm64 | arm64v8-latest |
|
| arm64 | arm64v8-latest |
|
||||||
| armhf | arm32v7-latest |
|
| armhf | arm32v7-latest |
|
||||||
|
|
@ -23,8 +31,8 @@ The architectures supported by this image are:
|
||||||
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
||||||
|
|
||||||
| Tag | Description |
|
| Tag | Description |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| latest | Current latest head from development at [https://github.com/domoticz/domoticz](https://github.com/domoticz/domoticz). |
|
| latest | Current latest head from development at https://github.com/domoticz/domoticz. |
|
||||||
| stable | Latest stable version. |
|
| stable | Latest stable version. |
|
||||||
| stable-4.9700 | Old stable version. Will not be updated anymore! |
|
| stable-4.9700 | Old stable version. Will not be updated anymore! |
|
||||||
| stable-3.815 | Old stable version. Will not be updated anymore! |
|
| stable-3.815 | Old stable version. Will not be updated anymore! |
|
||||||
|
|
@ -34,38 +42,7 @@ This image provides various versions that are available via tags. `latest` tag u
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container from this image.
|
Here are some example snippets to help you get started creating a container from this image.
|
||||||
|
|
||||||
### docker
|
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
|
||||||
|
|
||||||
```text
|
|
||||||
docker create \
|
|
||||||
--name=domoticz \
|
|
||||||
-e PUID=1000 \
|
|
||||||
-e PGID=1000 \
|
|
||||||
-e TZ=Europe/London \
|
|
||||||
-e WEBROOT=domoticz `#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 \
|
|
||||||
linuxserver/domoticz
|
|
||||||
```
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
```text
|
|
||||||
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'
|
|
||||||
|
|
||||||
### docker-compose
|
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
||||||
|
|
@ -74,7 +51,7 @@ Compatible with docker-compose v2 schemas.
|
||||||
version: "2.1"
|
version: "2.1"
|
||||||
services:
|
services:
|
||||||
domoticz:
|
domoticz:
|
||||||
image: linuxserver/domoticz
|
image: ghcr.io/linuxserver/domoticz
|
||||||
container_name: domoticz
|
container_name: domoticz
|
||||||
environment:
|
environment:
|
||||||
- PUID=1000
|
- PUID=1000
|
||||||
|
|
@ -92,61 +69,113 @@ services:
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### docker cli
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -d \
|
||||||
|
--name=domoticz \
|
||||||
|
-e PUID=1000 \
|
||||||
|
-e PGID=1000 \
|
||||||
|
-e TZ=Europe/London \
|
||||||
|
-e WEBROOT=domoticz `#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 \
|
||||||
|
ghcr.io/linuxserver/domoticz
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
## 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.
|
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`\)
|
### Ports (`-p`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `8080` | WebUI |
|
| `8080` | WebUI |
|
||||||
| `6144` | Domoticz communication port. |
|
| `6144` | Domoticz communication port. |
|
||||||
| `1443` | Domoticz communication port. |
|
| `1443` | Domoticz communication port. |
|
||||||
|
|
||||||
### Environment Variables \(`-e`\)
|
|
||||||
|
### Environment Variables (`-e`)
|
||||||
|
|
||||||
| Env | Function |
|
| Env | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `PUID=1000` | for UserID - see below for explanation |
|
| `PUID=1000` | for UserID - see below for explanation |
|
||||||
| `PGID=1000` | for GroupID - see below for explanation |
|
| `PGID=1000` | for GroupID - see below for explanation |
|
||||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||||
| `WEBROOT=domoticz` | Sets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying. |
|
| `WEBROOT=domoticz` | Sets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying. |
|
||||||
|
|
||||||
### Volume Mappings \(`-v`\)
|
### Volume Mappings (`-v`)
|
||||||
|
|
||||||
| Volume | Function |
|
| Volume | Function |
|
||||||
| :---: | :--- |
|
| :----: | --- |
|
||||||
| `/config` | Where Domoticz stores config files and data. |
|
| `/config` | Where Domoticz stores config files and data. |
|
||||||
|
|
||||||
#### Device Mappings \(`--device`\)
|
#### Device Mappings (`--device`)
|
||||||
|
|
||||||
| Parameter | Function |
|
| Parameter | Function |
|
||||||
| :---: | :--- |
|
| :-----: | --- |
|
||||||
| `<path to device>` | For passing through USB devices. |
|
| `<path to device>` | For passing through USB devices. |
|
||||||
|
|
||||||
|
|
||||||
|
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||||
|
|
||||||
|
|
||||||
## User / Group Identifiers
|
## 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`.
|
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.
|
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:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```text
|
```
|
||||||
$ id username
|
$ id username
|
||||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Application Setup
|
## 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](https://www.domoticz.com)
|
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](https://www.domoticz.com)
|
||||||
|
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
[](https://mods.linuxserver.io/?mod=domoticz "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=domoticz)
|
We publish various [Docker Mods](https://github.com/linuxserver/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.
|
||||||
|
|
||||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -157,7 +186,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* Container version number
|
* Container version number
|
||||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
|
||||||
* Image version number
|
* Image version number
|
||||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/domoticz`
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/domoticz`
|
||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
|
|
@ -174,11 +203,10 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* **03.04.18:** - Add dependencies for BroadlinkRM2 plugin.
|
* **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.
|
* **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.
|
* **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.
|
* **04.01.18:** - Deprecate cpu_core routine lack of scaling.
|
||||||
* **08.12.17:** - Rebase to alpine 3.7.
|
* **08.12.17:** - Rebase to alpine 3.7.
|
||||||
* **26.11.17:** - Use cpu core counting routine to speed up build time.
|
* **26.11.17:** - Use cpu core counting routine to speed up build time.
|
||||||
* **28.05.17:** - Rebase to alpine 3.6.
|
* **28.05.17:** - Rebase to alpine 3.6.
|
||||||
* **26.02.17:** - Add curl and replace openssl with libressl.
|
* **26.02.17:** - Add curl and replace openssl with libressl.
|
||||||
* **11.02.17:** - Update README.
|
* **11.02.17:** - Update README.
|
||||||
* **03.01.17:** - Initial Release.
|
* **03.01.17:** - Initial Release.
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue