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

Commit 6b3b887

Browse files
Bot Updating Templated Files
1 parent f7b148b commit 6b3b887

File tree

4 files changed

+37
-32
lines changed

4 files changed

+37
-32
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
## Readme
2525

2626
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
27-
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-domoticz/edit/master/readme-vars.yml).
27+
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-domoticz/edit/stable/readme-vars.yml).
2828

2929
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
3030
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-domoticz)
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-domoticz.git
101101
cd docker-domoticz
102102
docker build \
@@ -106,15 +106,16 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117-
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-domoticz/tree/master/root), add an entry to the changelog
118+
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-domoticz/tree/stable/root), add an entry to the changelog
118119

119120
```yml
120121
changelogs:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
------------------------------
2323

24-
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-domoticz/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
24+
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-domoticz/blob/stable/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
2525

2626
------------------------------
2727

.github/workflows/greetings.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ jobs:
88
steps:
99
- uses: actions/first-interaction@v1
1010
with:
11-
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-domoticz/blob/master/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-domoticz/blob/master/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12-
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-domoticz/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
11+
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-domoticz/blob/stable/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-domoticz/blob/stable/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12+
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-domoticz/blob/stable/.github/PULL_REQUEST_TEMPLATE.md)!'
1313
repo-token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-domoticz/blob/stable/.github/CONTRIBUTING.md -->
33

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

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -39,7 +40,6 @@ Find us at:
3940
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fdomoticz%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/domoticz/latest/index.html)
4041

4142
[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.
42-
4343
[![domoticz](https://github.com/domoticz/domoticz/raw/master/www/images/logo.png)](https://www.domoticz.com)
4444

4545
## Supported Architectures
@@ -68,6 +68,12 @@ This image provides various versions that are available via tags. `latest` tag u
6868
| stable-3.815 | Old stable version. Will not be updated anymore! |
6969
| stable-3.5877 | Old stable version. Will not be updated anymore! |
7070

71+
## Application Setup
72+
73+
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.
74+
The user manual is available at [www.domoticz.com](https://www.domoticz.com)
75+
THIS BRANCH IS DEPRECATED! PLEASE CHANGE TO USING THE LATEST TAG FOR THE LATEST STABLE VERSION. NO MORE DEVELOPMENT BUILDS.
76+
7177
## Usage
7278

7379
Here are some example snippets to help you get started creating a container.
@@ -101,7 +107,7 @@ services:
101107
102108
### docker cli
103109
104-
```
110+
```bash
105111
docker run -d \
106112
--name=domoticz \
107113
-e PUID=1000 \
@@ -129,7 +135,6 @@ usb 1-1.2: FTDI USB Serial Device converter now attached to ttyUSB0
129135
```
130136
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'
131137

132-
133138
## Parameters
134139

135140
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.
@@ -152,7 +157,7 @@ You can set any environment variable from a file by using a special prepend `FIL
152157

153158
As an example:
154159

155-
```
160+
```bash
156161
-e FILE__PASSWORD=/run/secrets/mysecretpassword
157162
```
158163

@@ -171,26 +176,17 @@ Ensure any volume directories on the host are owned by the same user you specify
171176

172177
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
173178

174-
```
179+
```bash
175180
$ id username
176181
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
177182
```
178183

179-
180-
&nbsp;
181-
## Application Setup
182-
183-
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.
184-
The user manual is available at [www.domoticz.com](https://www.domoticz.com)
185-
THIS BRANCH IS DEPRECATED! PLEASE CHANGE TO USING THE LATEST TAG FOR THE LATEST STABLE VERSION. NO MORE DEVELOPMENT BUILDS.
186-
187-
188184
## Docker Mods
185+
189186
[![Docker Mods](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)](https://mods.linuxserver.io/?mod=domoticz "view available mods for this container.") [![Docker Universal Mods](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)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
190187

191188
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) 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.
192189

193-
194190
## Support Info
195191

196192
* Shell access whilst the container is running: `docker exec -it domoticz /bin/bash`
@@ -207,38 +203,45 @@ Most of our images are static, versioned, and require an image update and contai
207203
Below are the instructions for updating containers:
208204

209205
### Via Docker Compose
206+
210207
* Update all images: `docker-compose pull`
211208
* or update a single image: `docker-compose pull domoticz`
212209
* Let compose update all containers as necessary: `docker-compose up -d`
213210
* or update a single container: `docker-compose up -d domoticz`
214211
* You can also remove the old dangling images: `docker image prune`
215212

216213
### Via Docker Run
214+
217215
* Update the image: `docker pull ghcr.io/linuxserver/domoticz`
218216
* Stop the running container: `docker stop domoticz`
219217
* Delete the container: `docker rm domoticz`
220218
* 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)
221219
* You can also remove the old dangling images: `docker image prune`
222220

223221
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
222+
224223
* Pull the latest image at its tag and replace it with the same env variables in one run:
225-
```
224+
225+
```bash
226226
docker run --rm \
227227
-v /var/run/docker.sock:/var/run/docker.sock \
228228
containrrr/watchtower \
229229
--run-once domoticz
230230
```
231+
231232
* You can also remove the old dangling images: `docker image prune`
232233

233234
**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).
234235

235236
### Image Update Notifications - Diun (Docker Image Update Notifier)
237+
236238
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
237239

238240
## Building locally
239241

240242
If you want to make local modifications to these images for development purposes or just to customize the logic:
241-
```
243+
244+
```bash
242245
git clone https://github.com/linuxserver/docker-domoticz.git
243246
cd docker-domoticz
244247
docker build \
@@ -248,7 +251,8 @@ docker build \
248251
```
249252

250253
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
251-
```
254+
255+
```bash
252256
docker run --rm --privileged multiarch/qemu-user-static:register --reset
253257
```
254258

0 commit comments

Comments
 (0)