​​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​​

​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 ghcr.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:

Usage

Here are some example snippets to help you get started creating a container from this image.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  ldap-auth:
    image: ghcr.io/linuxserver/ldap-auth
    container_name: ldap-auth
    environment:
      - TZ=Europe/London
      - FERNETKEY= #optional
      - CERTFILE= #optional
      - KEYFILE= #optional
    ports:
      - 8888:8888
      - 9000:9000
    restart: unless-stopped

docker cli

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 \
  ghcr.io/linuxserver/ldap-auth

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)

Environment Variables (-e)

Volume Mappings (-v)

Environment variables from files (Docker secrets)

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.

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.

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.

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" }}' ghcr.io/linuxserver/ldap-auth

Versions

• 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.