docker-documentation/images/docker-domoticz/index.html

43 wiersze
52 KiB
HTML
Czysty Zwykły widok Historia

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Welcome to the home of the LinuxServer.io documentation!"><meta name=author content=LinuxServer.io><link href=https://docs.linuxserver.io/images/docker-domoticz/ rel=canonical><link rel=icon href="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media"><meta name=generator content="mkdocs-1.4.2, mkdocs-material-8.5.10"><title>domoticz - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.975780f9.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.2505c338.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo> <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#linuxserverdomoticz class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=LinuxServer.io class="md-header__button md-logo" aria-label=LinuxServer.io data-md-component=logo> <img src="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> LinuxServer.io </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> domoticz </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg> </label> </form> <label class="md-header__button md-icon" for=__search> <
version: &quot;2.1&quot;
services:
domoticz:
image: lscr.io/linuxserver/domoticz:latest
container_name: domoticz
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- WEBROOT=domoticz #optional
- DBASE=&lt;path to database&gt; #optional
volumes:
- &lt;path to data&gt;:/config
ports:
- 8080:8080
- 6144:6144
- 1443:1443
devices:
- path to device:path to device
restart: unless-stopped
</code></pre> <h3 id=docker-cli-click-here-for-more-info>docker cli (<a href=https://docs.docker.com/engine/reference/commandline/cli/ >click here for more info</a>)</h3> <pre><code class=language-bash>docker run -d \
--name=domoticz \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e WEBROOT=domoticz `#optional` \
-e DBASE=&lt;path to database&gt; `#optional` \
-p 8080:8080 \
-p 6144:6144 \
-p 1443:1443 \
-v &lt;path to data&gt;:/config \
--device path to device:path to device \
--restart unless-stopped \
lscr.io/linuxserver/domoticz:latest
</code></pre> <h3 id=passing-through-usb-devices>Passing Through USB Devices</h3> <p>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.</p> <pre><code>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
</code></pre> <p>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'</p> <h2 id=parameters>Parameters</h2> <p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code>&lt;external&gt;:&lt;internal&gt;</code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p> <h3 id=ports-p>Ports (<code>-p</code>)</h3> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>8080</code></td> <td>WebUI</td> </tr> <tr> <td align=center><code>6144</code></td> <td>Domoticz communication port.</td> </tr> <tr> <td align=center><code>1443</code></td> <td>Domoticz communication port.</td> </tr> </tbody> </table> <h3 id=environment-variables-e>Environment Variables (<code>-e</code>)</h3> <table> <thead> <tr> <th align=center>Env</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>PUID=1000</code></td> <td>for UserID - see below for explanation</td> </tr> <tr> <td align=center><code>PGID=1000</code></td> <td>for GroupID - see below for explanation</td> </tr> <tr> <td align=center><code>TZ=Europe/London</code></td> <td>Specify a timezone to use EG Europe/London.</td> </tr> <tr> <td align=center><code>WEBROOT=domoticz</code></td> <td>Sets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying.</td> </tr> <tr> <td align=center><code>DBASE=&lt;path to database&gt;</code></td> <td>Sets path to database. Do not set unless you know what this does.</td> </tr> </tbody> </table> <h3 id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3> <table> <thead> <tr> <th align=center>Volume</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>/config</code></td> <td>Where Domoticz stores config files and data.</td> </tr> </tbody> </table> <h3 id=device-mappings-device>Device Mappings (<code>--device</code>)</h3> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>path to device</code></td> <td>For passing through USB devices.</td> </tr> </tbody> </table> <h4 id=miscellaneous-options>Miscellaneous Options</h4> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td></td> <td></td> </tr> </tbody> </table> <h2 id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2> <p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p> <p>As an example:</p> <pre><code class=language-bash>-e FILE__PASSWORD=/run/secrets/mysecretpassword
</code></pre> <p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p> <h2 id=umask-for-running-applications>Umask for running applications</h2> <p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <a href=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p> <h2 id=user-group-identifiers>User / Group Identifiers</h2> <p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p> <p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p> <p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p> <pre><code class=language-bash> $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
</code></pre> <h2 id=docker-mods>Docker Mods</h2> <p><a href="https://mods.linuxserver.io/?mod=domoticz" title="view available mods for this container."><img alt="Docker Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=domoticz&query=%24.mods%5B%27domoticz%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a> <a href="https://mods.linuxserver.io/?mod=universal" title="view available universal mods."><img alt="Docker Universal Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p> <p>We publish various <a href=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p> <h2 id=support-info>Support Info</h2> <ul> <li>Shell access whilst the container is running:</li> <li><code>docker exec -it domoticz /bin/bash</code></li> <li>To monitor the logs of the container in realtime:</li> <li><code>docker logs -f domoticz</code></li> <li>Container version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz</code></li> <li>Image version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest</code></li> </ul> <h2 id=versions>Versions</h2> <ul> <li><strong>15.10.22:</strong> - Remove deprecated legacy stable branches.</li> <li><strong>05.02.22:</strong> - Set default webroot to /. Add env. variable for setting custom databas path.</li> <li><strong>26.12.20:</strong> - Rebase to Ubuntu Focal, see <a href=https://docs.linuxserver.io/faq#my-host-is-incompatible-with-images-based-on-ubuntu-focal>here</a> for troubleshooting armhf.</li> <li><strong>24.11.19:</strong> - Change to using domoticz builtin Lua and MQTT.</li> <li><strong>03.11.19:</strong> - Set capabilities for domoticz binary and move cmake from edge repo.</li> <li><strong>28.06.19:</strong> - Rebasing to alpine 3.10. Add iputils for ping. Fix typo in readme. Fix permissions for custom icons.</li> <li><strong>12.05.19:</strong> - Add boost dependencies and turn off static boost build. Bump to Alpine 3.9.</li> <li><strong>30.03.19:</strong> - Add env variable to set webroot.</li> <li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li> <li><strong>19.02.19:</strong> - Fix branch for version logic.</li> <li><strong>11.02.19:</strong> - Add pipeline logic and multi arch.</li> <li><strong>02.07.18:</strong> - Add openssh package.</li> <li><strong>01.07.18:</strong> - Fix backup/restore in webgui.</li> <li><strong>03.04.18:</strong> - Add dependencies for BroadlinkRM2 plugin.</li> <li><strong>20.01.18:</strong> - Move telldus core to repo to prevent build fail when source site goes down.</li> <li><strong>18.01.18:</strong> - Remove logging to syslog in the run command to prevent double logging.</li> <li><strong>04.01.18:</strong> - Deprecate cpu_core routine lack of scaling.</li> <li><strong>08.12.17:</strong> - Rebase to alpine 3.7.</li> <li><strong>26.11.17:</strong> - Use cpu core counting routine to speed up build time.</li> <li><strong>28.05.17:</strong> - Rebase to alpine 3.6.</li> <li><strong>26.02.17:</strong> - Add curl and replace openssl with libressl.</li> <li><strong>11.02.17:</strong> - Update README.</li> <li><strong>03.01.17:</strong> - Initial Release.</li> </ul> </article> </div> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../docker-dokuwiki/ class="md-footer__link md-footer__link--prev" aria-label="Previous: dokuwiki" rel=prev> <div class="md-footer__button md-icon"> <sv