linuxserver/ldap-auth
Ldap-auth software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012).
Simply pulling
lscr.io/linuxserver/ldap-auth:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.The architectures supported by this image are:
Architecture | Available | Tag |
|---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ✅ | arm32v7-<version tag> |
- This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config.
- Unlike the upstream project, this image encodes the cookie information with fernet, using a randomly generated key during container creation (or optionally user defined).
- 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/loginfor their internal auth.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
ldap-auth:
image: lscr.io/linuxserver/ldap-auth:latest
container_name: ldap-auth
environment:
- TZ=Europe/London
- FERNETKEY= #optional
- CERTFILE= #optional
- KEYFILE= #optional
ports:
- 8888:8888
- 9000:9000
restart: unless-stopped
docker run -d \
--name=ldap-auth \
-e TZ=Europe/London \
-e FERNETKEY= `#optional` \
-e CERTFILE= `#optional` \
-e KEYFILE= `#optional` \
-p 8888:8888 \
-p 9000:9000 \
--restart unless-stopped \
lscr.io/linuxserver/ldap-auth:latest
Docker 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.Parameter | Function |
|---|---|
8888 | the port for ldap auth daemon |
9000 | the port for ldap login page |
Env | Function |
|---|---|
TZ=Europe/London | Specify a timezone to use EG Europe/London |
FERNETKEY= | Optionally define a custom fernet key, has to be base64-encoded 32-byte (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications) |
CERTFILE= | Point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon |
KEYFILE= | Point this to the private key file, matching the certificate file referred to in CERTFILE |
You can set any environment variable from a file by using a special prepend
FILE__.As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable
PASSWORD based on the contents of the /run/secrets/mysecretpassword file.For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
We publish various 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.
- Shell access whilst the container is running:
docker exec -it ldap-auth /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f ldap-auth
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest
- 19.09.22: - Rebase to alpine 3.17.
- 19.09.22: - Rebase to alpine 3.15.
- 14.05.21: - Add linuxserver wheel index.
- 12.02.21: - Clean up cargo/rust cache.
- 10.02.21: - Rebasing to alpine 3.13.
- 08.09.20: - Set form action correctly.
- 30.07.20: - Fix bug related to unset optional
CERTFILEandKEYFILEvars. - 27.07.20: - Add support for HTTP over SSL (HTTPS).
- 21.07.20: - Add support for optional user defined fernet key.
- 02.06.20: - Rebasing to alpine 3.12, serve login page at
/ldaploginas well as/login, to prevent clashes with reverese proxied apps. - 17.05.20: - Add support for self-signed CA certs.
- 20.02.20: - Switch to python3.
- 19.12.19: - Rebasing to alpine 3.11.
- 01.07.19: - Fall back to base64 encoding when basic http auth is used.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 18.09.18: - Update pip
- 14.09.18: - Add TZ parameter, remove unnecessary PUID/PGID params
- 11.08.18: - Initial release.
Last modified 27d ago