diff --git a/images/docker-domoticz.md b/images/docker-domoticz.md index 637dac24b..d2704f44c 100644 --- a/images/docker-domoticz.md +++ b/images/docker-domoticz.md @@ -1,6 +1,12 @@ -# linuxserver/domoticz +# [linuxserver/domoticz](https://github.com/linuxserver/docker-domoticz) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-domoticz.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-domoticz/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/domoticz) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/domoticz) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/domoticz) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/domoticz) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-domoticz.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-domoticz/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/domoticz "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/domoticz "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/domoticz) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/domoticz.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/domoticz) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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. @@ -13,7 +19,7 @@ Simply pulling `linuxserver/domoticz` should retrieve the correct image for your The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | @@ -23,8 +29,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. | 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-4.9700 | Old stable version. Will not be updated anymore! | | stable-3.815 | Old stable version. Will not be updated anymore! | @@ -36,7 +42,7 @@ Here are some example snippets to help you get started creating a container from ### docker -```text +``` docker create \ --name=domoticz \ -e PUID=1000 \ @@ -54,17 +60,17 @@ docker create \ ### 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. +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. @@ -94,53 +100,57 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :---: | :--- | +| :----: | --- | | `8080` | WebUI | | `6144` | Domoticz communication port. | | `1443` | Domoticz communication port. | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `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. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Where Domoticz stores config files and data. | -#### Device Mappings \(`--device`\) - +#### Device Mappings (`--device`) | Parameter | Function | -| :---: | :--- | +| :-----: | --- | | `` | For passing through USB devices. | + ## 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. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## 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) + + ## Support Info @@ -166,11 +176,10 @@ To configure Domoticz, go to the IP of your docker host on the port you configur * **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. +* **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. -