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

Commit fcf8803

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 68f0400 commit fcf8803

File tree

1 file changed

+101
-35
lines changed

1 file changed

+101
-35
lines changed

‎README.md

Lines changed: 101 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the https://github.com/linuxserver/docker-domoticz/blob/master/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-domoticz/blob/master/.github/CONTRIBUTING.md -->
43
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
54

65
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
@@ -65,7 +64,7 @@ The user manual is available at [www.domoticz.com](https://www.domoticz.com)
6564

6665
## Usage
6766

68-
Here are some example snippets to help you get started creating a container.
67+
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
6968

7069
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
7170

@@ -110,7 +109,6 @@ docker run -d \
110109
--device path to device:path to device \
111110
--restart unless-stopped \
112111
lscr.io/linuxserver/domoticz:latest
113-
114112
```
115113

116114
### Passing Through USB Devices
@@ -125,9 +123,10 @@ usb 1-1.2: FTDI USB Serial Device converter now attached to ttyUSB0
125123
```
126124
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'
127125

126+
128127
## Parameters
129128

130-
Container 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.
129+
Containers 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.
131130

132131
| Parameter | Function |
133132
| :----: | --- |
@@ -149,10 +148,10 @@ You can set any environment variable from a file by using a special prepend `FIL
149148
As an example:
150149

151150
```bash
152-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
151+
-e FILE__MYVAR=/run/secrets/mysecretvariable
153152
```
154153

155-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
154+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
156155

157156
## Umask for running applications
158157

@@ -161,15 +160,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
161160

162161
## User / Group Identifiers
163162

164-
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`.
163+
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`.
165164

166165
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
167166

168-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
167+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
169168

170169
```bash
171-
$ id username
172-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
170+
id your_user
171+
```
172+
173+
Example output:
174+
175+
```text
176+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
173177
```
174178

175179
## Docker Mods
@@ -180,12 +184,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
180184

181185
## Support Info
182186

183-
* Shell access whilst the container is running: `docker exec -it domoticz /bin/bash`
184-
* To monitor the logs of the container in realtime: `docker logs -f domoticz`
185-
* container version number
186-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz`
187-
* image version number
188-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest`
187+
* Shell access whilst the container is running:
188+
189+
```bash
190+
docker exec -it domoticz /bin/bash
191+
```
192+
193+
* To monitor the logs of the container in realtime:
194+
195+
```bash
196+
docker logs -f domoticz
197+
```
198+
199+
* Container version number:
200+
201+
```bash
202+
docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz
203+
```
204+
205+
* Image version number:
206+
207+
```bash
208+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest
209+
```
189210

190211
## Updating Info
191212

@@ -195,38 +216,83 @@ Below are the instructions for updating containers:
195216

196217
### Via Docker Compose
197218

198-
* Update all images: `docker-compose pull`
199-
* or update a single image: `docker-compose pull domoticz`
200-
* Let compose update all containers as necessary: `docker-compose up -d`
201-
* or update a single container: `docker-compose up -d domoticz`
202-
* You can also remove the old dangling images: `docker image prune`
219+
* Update images:
220+
* All images:
221+
222+
```bash
223+
docker-compose pull
224+
```
225+
226+
* Single image:
227+
228+
```bash
229+
docker-compose pull domoticz
230+
```
231+
232+
* Update containers:
233+
* All containers:
234+
235+
```bash
236+
docker-compose up -d
237+
```
238+
239+
* Single container:
240+
241+
```bash
242+
docker-compose up -d domoticz
243+
```
244+
245+
* You can also remove the old dangling images:
246+
247+
```bash
248+
docker image prune
249+
```
203250

204251
### Via Docker Run
205252

206-
* Update the image: `docker pull lscr.io/linuxserver/domoticz:latest`
207-
* Stop the running container: `docker stop domoticz`
208-
* Delete the container: `docker rm domoticz`
253+
* Update the image:
254+
255+
```bash
256+
docker pull lscr.io/linuxserver/domoticz:latest
257+
```
258+
259+
* Stop the running container:
260+
261+
```bash
262+
docker stop domoticz
263+
```
264+
265+
* Delete the container:
266+
267+
```bash
268+
docker rm domoticz
269+
```
270+
209271
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
210-
* You can also remove the old dangling images: `docker image prune`
272+
* You can also remove the old dangling images:
273+
274+
```bash
275+
docker image prune
276+
```
211277

212278
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
213279

214280
* Pull the latest image at its tag and replace it with the same env variables in one run:
215281

216-
```bash
217-
docker run --rm \
218-
-v /var/run/docker.sock:/var/run/docker.sock \
219-
containrrr/watchtower \
220-
--run-once domoticz
221-
```
282+
```bash
283+
docker run --rm \
284+
-v /var/run/docker.sock:/var/run/docker.sock \
285+
containrrr/watchtower \
286+
--run-once domoticz
287+
```
222288

223289
* You can also remove the old dangling images: `docker image prune`
224290

225-
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
291+
**warning**: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
226292

227293
### Image Update Notifications - Diun (Docker Image Update Notifier)
228294

229-
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
295+
**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
230296

231297
## Building locally
232298

0 commit comments

Comments
 (0)