Skip to content

Commit 4df60d8

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 1b7b000 commit 4df60d8

File tree

1 file changed

+91
-31
lines changed

1 file changed

+91
-31
lines changed

‎README.md

Lines changed: 91 additions & 31 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-ldap-auth/blob/master/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-ldap-auth/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!")
@@ -67,7 +66,7 @@ The architectures supported by this image are:
6766

6867
## Usage
6968

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

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

@@ -100,12 +99,11 @@ docker run -d \
10099
-p 9000:9000 \
101100
--restart unless-stopped \
102101
lscr.io/linuxserver/ldap-auth:latest
103-
104102
```
105103

106104
## Parameters
107105

108-
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.
106+
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.
109107

110108
| Parameter | Function |
111109
| :----: | --- |
@@ -122,10 +120,10 @@ You can set any environment variable from a file by using a special prepend `FIL
122120
As an example:
123121

124122
```bash
125-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
123+
-e FILE__MYVAR=/run/secrets/mysecretvariable
126124
```
127125

128-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
126+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
129127

130128
## Umask for running applications
131129

@@ -140,12 +138,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
140138

141139
## Support Info
142140

143-
* Shell access whilst the container is running: `docker exec -it ldap-auth /bin/bash`
144-
* To monitor the logs of the container in realtime: `docker logs -f ldap-auth`
145-
* container version number
146-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth`
147-
* image version number
148-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest`
141+
* Shell access whilst the container is running:
142+
143+
```bash
144+
docker exec -it ldap-auth /bin/bash
145+
```
146+
147+
* To monitor the logs of the container in realtime:
148+
149+
```bash
150+
docker logs -f ldap-auth
151+
```
152+
153+
* Container version number:
154+
155+
```bash
156+
docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth
157+
```
158+
159+
* Image version number:
160+
161+
```bash
162+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest
163+
```
149164

150165
## Updating Info
151166

@@ -155,38 +170,83 @@ Below are the instructions for updating containers:
155170

156171
### Via Docker Compose
157172

158-
* Update all images: `docker-compose pull`
159-
* or update a single image: `docker-compose pull ldap-auth`
160-
* Let compose update all containers as necessary: `docker-compose up -d`
161-
* or update a single container: `docker-compose up -d ldap-auth`
162-
* You can also remove the old dangling images: `docker image prune`
173+
* Update images:
174+
* All images:
175+
176+
```bash
177+
docker-compose pull
178+
```
179+
180+
* Single image:
181+
182+
```bash
183+
docker-compose pull ldap-auth
184+
```
185+
186+
* Update containers:
187+
* All containers:
188+
189+
```bash
190+
docker-compose up -d
191+
```
192+
193+
* Single container:
194+
195+
```bash
196+
docker-compose up -d ldap-auth
197+
```
198+
199+
* You can also remove the old dangling images:
200+
201+
```bash
202+
docker image prune
203+
```
163204

164205
### Via Docker Run
165206

166-
* Update the image: `docker pull lscr.io/linuxserver/ldap-auth:latest`
167-
* Stop the running container: `docker stop ldap-auth`
168-
* Delete the container: `docker rm ldap-auth`
207+
* Update the image:
208+
209+
```bash
210+
docker pull lscr.io/linuxserver/ldap-auth:latest
211+
```
212+
213+
* Stop the running container:
214+
215+
```bash
216+
docker stop ldap-auth
217+
```
218+
219+
* Delete the container:
220+
221+
```bash
222+
docker rm ldap-auth
223+
```
224+
169225
* 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)
170-
* You can also remove the old dangling images: `docker image prune`
226+
* You can also remove the old dangling images:
227+
228+
```bash
229+
docker image prune
230+
```
171231

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

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

176-
```bash
177-
docker run --rm \
178-
-v /var/run/docker.sock:/var/run/docker.sock \
179-
containrrr/watchtower \
180-
--run-once ldap-auth
181-
```
236+
```bash
237+
docker run --rm \
238+
-v /var/run/docker.sock:/var/run/docker.sock \
239+
containrrr/watchtower \
240+
--run-once ldap-auth
241+
```
182242

183243
* You can also remove the old dangling images: `docker image prune`
184244

185-
**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).
245+
**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).
186246

187247
### Image Update Notifications - Diun (Docker Image Update Notifier)
188248

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

191251
## Building locally
192252

0 commit comments

Comments
 (0)