Skip to content

Commit dcea290

Browse files
Bot Updating Documentation
1 parent 1358f86 commit dcea290

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/images/docker-ldap-auth.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ The architectures supported by this image are:
4141
- Unlike the upstream project, this image encodes the cookie information with fernet, using a randomly generated key during container creation (or optionally user defined).
4242
- Also unlike the upstream project, this image serves the login page at `/ldaplogin` (as well as `/login`) to prevent clashes with reverse proxied apps that may also use `/login` for their internal auth.
4343

44+
## Read-Only Operation
45+
46+
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
47+
48+
## Non-Root Operation
49+
50+
This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).
51+
4452
## Usage
4553

4654
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
@@ -118,6 +126,8 @@ Containers are configured using parameters passed at runtime (such as those abov
118126

119127
| Parameter | Function |
120128
| :-----: | --- |
129+
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
130+
| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |
121131

122132
## Environment variables from files (Docker secrets)
123133

@@ -300,23 +310,19 @@ To help with development, we generate this dependency graph.
300310
init-migrations -> init-adduser
301311
init-os-end -> init-config
302312
init-config -> init-config-end
313+
init-crontab-config -> init-config-end
303314
init-ldap-config -> init-config-end
304-
init-os-end -> init-crontab-config
315+
init-config -> init-crontab-config
305316
init-mods-end -> init-custom-files
306317
base -> init-envfile
307318
init-config -> init-ldap-config
308319
base -> init-migrations
309-
base -> init-mods
310320
init-config-end -> init-mods
311-
init-mods -> init-mods-end
312321
init-mods-package-install -> init-mods-end
313322
init-mods -> init-mods-package-install
314-
base -> init-os-end
315323
init-adduser -> init-os-end
316324
init-envfile -> init-os-end
317-
init-migrations -> init-os-end
318325
init-custom-files -> init-services
319-
init-mods-end -> init-services
320326
init-services -> svc-cron
321327
svc-cron -> legacy-services
322328
init-services -> svc-ldap-app
@@ -325,13 +331,14 @@ To help with development, we generate this dependency graph.
325331
svc-ldap-daemon -> legacy-services
326332
}
327333
Base Images: {
328-
"baseimage-alpine:3.20"
334+
"baseimage-alpine:3.21"
329335
}
330336
"ldap-auth:latest" <- Base Images
331337
```
332338

333339
## Versions
334340

341+
* **22.12.24:** - Rebase to Alpine 3.21. Add support for read-only and non-root.
335342
* **30.06.24:** - Rebase to Alpine 3.20.
336343
* **23.12.23:** - Rebase to Alpine 3.19.
337344
* **20.06.23:** - Sync upstream changes, including the ability to disable referrals with `X-Ldap-DisableReferrals`.

0 commit comments

Comments
 (0)