Skip to content

Commit 2a2fe76

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 3a8819a commit 2a2fe76

File tree

1 file changed

+100
-35
lines changed

1 file changed

+100
-35
lines changed

‎README.md

Lines changed: 100 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-syslog-ng/blob/main/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-syslog-ng/blob/main/.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!")
@@ -68,7 +67,7 @@ More info at [syslog-ng](https://www.syslog-ng.com/technical-documents/list/sysl
6867

6968
## Usage
7069

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

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

@@ -108,12 +107,11 @@ docker run -d \
108107
-v /path/to/log:/var/log `#optional` \
109108
--restart unless-stopped \
110109
lscr.io/linuxserver/syslog-ng:latest
111-
112110
```
113111

114112
## Parameters
115113

116-
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.
114+
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.
117115

118116
| Parameter | Function |
119117
| :----: | --- |
@@ -133,10 +131,10 @@ You can set any environment variable from a file by using a special prepend `FIL
133131
As an example:
134132

135133
```bash
136-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
134+
-e FILE__MYVAR=/run/secrets/mysecretvariable
137135
```
138136

139-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
137+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
140138

141139
## Umask for running applications
142140

@@ -145,15 +143,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
145143

146144
## User / Group Identifiers
147145

148-
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`.
146+
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`.
149147

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

152-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
150+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
153151

154152
```bash
155-
$ id username
156-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
153+
id your_user
154+
```
155+
156+
Example output:
157+
158+
```text
159+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
157160
```
158161

159162
## Docker Mods
@@ -164,12 +167,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
164167

165168
## Support Info
166169

167-
* Shell access whilst the container is running: `docker exec -it syslog-ng /bin/bash`
168-
* To monitor the logs of the container in realtime: `docker logs -f syslog-ng`
169-
* container version number
170-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' syslog-ng`
171-
* image version number
172-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syslog-ng:latest`
170+
* Shell access whilst the container is running:
171+
172+
```bash
173+
docker exec -it syslog-ng /bin/bash
174+
```
175+
176+
* To monitor the logs of the container in realtime:
177+
178+
```bash
179+
docker logs -f syslog-ng
180+
```
181+
182+
* Container version number:
183+
184+
```bash
185+
docker inspect -f '{{ index .Config.Labels "build_version" }}' syslog-ng
186+
```
187+
188+
* Image version number:
189+
190+
```bash
191+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syslog-ng:latest
192+
```
173193

174194
## Updating Info
175195

@@ -179,38 +199,83 @@ Below are the instructions for updating containers:
179199

180200
### Via Docker Compose
181201

182-
* Update all images: `docker-compose pull`
183-
* or update a single image: `docker-compose pull syslog-ng`
184-
* Let compose update all containers as necessary: `docker-compose up -d`
185-
* or update a single container: `docker-compose up -d syslog-ng`
186-
* You can also remove the old dangling images: `docker image prune`
202+
* Update images:
203+
* All images:
204+
205+
```bash
206+
docker-compose pull
207+
```
208+
209+
* Single image:
210+
211+
```bash
212+
docker-compose pull syslog-ng
213+
```
214+
215+
* Update containers:
216+
* All containers:
217+
218+
```bash
219+
docker-compose up -d
220+
```
221+
222+
* Single container:
223+
224+
```bash
225+
docker-compose up -d syslog-ng
226+
```
227+
228+
* You can also remove the old dangling images:
229+
230+
```bash
231+
docker image prune
232+
```
187233

188234
### Via Docker Run
189235

190-
* Update the image: `docker pull lscr.io/linuxserver/syslog-ng:latest`
191-
* Stop the running container: `docker stop syslog-ng`
192-
* Delete the container: `docker rm syslog-ng`
236+
* Update the image:
237+
238+
```bash
239+
docker pull lscr.io/linuxserver/syslog-ng:latest
240+
```
241+
242+
* Stop the running container:
243+
244+
```bash
245+
docker stop syslog-ng
246+
```
247+
248+
* Delete the container:
249+
250+
```bash
251+
docker rm syslog-ng
252+
```
253+
193254
* 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)
194-
* You can also remove the old dangling images: `docker image prune`
255+
* You can also remove the old dangling images:
256+
257+
```bash
258+
docker image prune
259+
```
195260

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

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

200-
```bash
201-
docker run --rm \
202-
-v /var/run/docker.sock:/var/run/docker.sock \
203-
containrrr/watchtower \
204-
--run-once syslog-ng
205-
```
265+
```bash
266+
docker run --rm \
267+
-v /var/run/docker.sock:/var/run/docker.sock \
268+
containrrr/watchtower \
269+
--run-once syslog-ng
270+
```
206271

207272
* You can also remove the old dangling images: `docker image prune`
208273

209-
**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).
274+
**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).
210275

211276
### Image Update Notifications - Diun (Docker Image Update Notifier)
212277

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

215280
## Building locally
216281

0 commit comments

Comments
 (0)