Search…
Images
Powered By GitBook
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).

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/ldap-auth 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

    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.
    Here's a sample config: nginx-ldap-auth.conf.
    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 /login for their internal auth.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
ldap-auth:
5
image: lscr.io/linuxserver/ldap-auth
6
container_name: ldap-auth
7
environment:
8
- TZ=Europe/London
9
- FERNETKEY= #optional
10
- CERTFILE= #optional
11
- KEYFILE= #optional
12
ports:
13
- 8888:8888
14
- 9000:9000
15
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=ldap-auth \
3
-e TZ=Europe/London \
4
-e FERNETKEY= `#optional` \
5
-e CERTFILE= `#optional` \
6
-e KEYFILE= `#optional` \
7
-p 8888:8888 \
8
-p 9000:9000 \
9
--restart unless-stopped \
10
lscr.io/linuxserver/ldap-auth
Copied!

Parameters

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.

Ports (-p)

Parameter
Function
8888
the port for ldap auth daemon
9000
the port for ldap login page

Environment Variables (-e)

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

Volume Mappings (-v)

Volume
Function

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

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.

Docker Mods

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.

Support Info

    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

Versions

    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 CERTFILE and KEYFILE vars.
    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 /ldaplogin as 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 25d ago