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

Commit 5ef11a6

Browse files
authored
Merge pull request #2 from tobbenb/readme
Update README to new standard and getting ready for release
2 parents e421ebc + b3062c7 commit 5ef11a6

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

READMETEMPLATE.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,27 @@ docker create \
2525
--net=bridge \
2626
-v <path to data>:/config \
2727
-e PGID=<gid> -e PUID=<uid> \
28+
-e TZ=<timezone> \
2829
-p 8080:8080 \
2930
-p 1443:1443 \
3031
-p 6144:6144 \
31-
--device=/dev/ttyUSB0 \
32+
--device=<path to device> \
3233
linuxserver/domoticz
3334
```
3435

3536

36-
**Parameters**
37+
## Parameters
38+
39+
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
40+
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
41+
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
42+
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
3743

3844
* `-p 1234` - the port(s)
39-
* `-v /config` - explain what lives here
45+
* `-v /config` - location for the config files
4046
* `-e PGID` for GroupID - see below for explanation
4147
* `-e PUID` for UserID - see below for explanation
42-
* `--device=/dev/ttyUSB0` - for passing through USB devices
48+
* `--device` - for passing through USB devices
4349
* `-e TZ` - for timezone information *eg Europe/London, etc*
4450

4551
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it domoticz /bin/bash`.
@@ -79,6 +85,15 @@ The user manual is available at [www.domoticz.com](https://www.domoticz.com)
7985
* Shell access whilst the container is running: `docker exec -it domoticz /bin/bash`
8086
* To monitor the logs of the container in realtime: `docker logs -f domoticz`
8187

88+
* container version number
89+
90+
`docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
91+
92+
* image version number
93+
94+
`docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
95+
8296
## Versions
8397

84-
+ **10.10.2016:** Initial release.
98+
+ **26.11.2016:** Update README to new standard and getting ready for release.
99+
+ **10.10.2016:** Initial dev release.

0 commit comments

Comments
 (0)