Skip to content
This repository was archived by the owner on Jan 1, 2024. It is now read-only.

Commit 7f6d254

Browse files
committed
Add proper README
1 parent 0920001 commit 7f6d254

File tree

2 files changed

+97
-112
lines changed

2 files changed

+97
-112
lines changed

README.md

Lines changed: 97 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,104 @@
55

66
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
77

8-
## This is a Container in active development by the [LinuxServer.io][linuxserverurl] team and is not recommended for use by the general public.
9-
10-
If you want to comment\contribute on this container , are looking for support on any of our other work , or are curious about us in general, check out the following.
11-
8+
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
129
* [forum.linuxserver.io][forumurl]
1310
* [IRC][ircurl] on freenode at `#linuxserver.io`
1411
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
1512

13+
# linuxserver/domoticz
14+
15+
[Domoticz][domoticzurl] 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
16+
17+
[![domoticz](https://github.com/domoticz/domoticz/raw/master/www/images/logo.png)][domoticzurl]
18+
[domoticzurl]: https://www.domoticz.com
19+
20+
## Usage
21+
22+
```
23+
docker create \
24+
--name=domoticz \
25+
--net=bridge \
26+
-v <path to data>:/config \
27+
-e PGID=<gid> -e PUID=<uid> \
28+
-e TZ=<timezone> \
29+
-p 8080:8080 \
30+
-p 1443:1443 \
31+
-p 6144:6144 \
32+
--device=<path to device> \
33+
linuxserver/domoticz:stable-3.5877
34+
```
35+
36+
You can choose between using tags, latest (default, and no tag required), or a specific stable version of domoticz.
37+
38+
Add one of the tags, if required, to the linuxserver/domoticz line of the run/create command in the following format, linuxserver/domoticz:stable-3.5877
39+
40+
#### Tags
41+
42+
+ **stable-3.5877** : latest stable version.
43+
44+
## Parameters
45+
46+
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
47+
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
48+
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
49+
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
50+
51+
* `-p 1443` - the port(s)
52+
* `-p 6144` - the port(s)
53+
* `-p 8080` - the port(s)
54+
* `-v /config` - location for the config files
55+
* `-e PGID` for GroupID - see below for explanation
56+
* `-e PUID` for UserID - see below for explanation
57+
* `--device` - for passing through USB devices
58+
* `-e TZ` - for timezone information *eg Europe/London, etc*
59+
60+
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it domoticz /bin/bash`.
61+
62+
### Passing Through USB Devices
63+
64+
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.
65+
66+
```
67+
usb 1-1.2: new full-speed USB device number 7 using ehci-pci
68+
ftdi_sio 1-1.2:1.0: FTDI USB Serial Device converter detected
69+
usb 1-1.2: Detected FT232RL
70+
usb 1-1.2: FTDI USB Serial Device converter now attached to ttyUSB0
71+
```
72+
73+
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'
74+
75+
### User / Group Identifiers
76+
77+
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
78+
79+
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
80+
81+
```
82+
$ id <dockeruser>
83+
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
84+
```
85+
86+
## Setting up the application
87+
88+
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.
89+
The user manual is available at [www.domoticz.com][domoticzurl]
90+
91+
## Info
92+
93+
* Shell access whilst the container is running: `docker exec -it domoticz /bin/bash`
94+
* To monitor the logs of the container in realtime: `docker logs -f domoticz`
95+
96+
* container version number
97+
98+
`docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
99+
100+
* image version number
101+
102+
`docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
103+
104+
## Versions
105+
106+
+ **26.02.2017:** Add curl and replace openssl with libressl. Add proper README.
107+
+ **26.11.2016:** Update README to new standard and getting ready for release.
108+
+ **10.10.2016:** Initial dev release.

READMETEMPLATE.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

0 commit comments

Comments
 (0)