regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Discord - realtime support / chat with the community and the team.
IRC - on freenode at #linuxserver.io. Our primary support channel is Discord.
Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Podcast - on hiatus. Coming back soon (late 2018).

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 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	arm32v6-latest

Usage

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

docker

docker create \
  --name=ldap-auth \
  -e TZ=Europe/London \
  -p 8888:8888 \
  -p 9000:9000 \
  --restart unless-stopped \
  linuxserver/ldap-auth

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  ldap-auth:
    image: linuxserver/ldap-auth
    container_name: ldap-auth
    environment:
      - TZ=Europe/London
    ports:
      - 8888:8888
      - 9000:9000
    restart: unless-stopped

Parameters

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.

Parameter	Function
`-p 8888`	the port for ldap auth daemon
`-p 9000`	the port for ldap login page
`-e TZ=Europe/London`	Specify a timezone to use EG Europe/London

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.

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

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Run/Create

Update the image: docker pull linuxserver/ldap-auth
Stop the running container: docker stop ldap-auth
Delete the container: docker rm ldap-auth
Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
Start the new container: docker start ldap-auth
You can also remove the old dangling images: docker image prune

Via Taisun auto-updater (especially useful if you don't remember the original parameters)

Pull the latest image at its tag and replace it with the same env variables in one shot:

docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock taisun/updater \
--oneshot ldap-auth

You can also remove the old dangling images: docker image prune

Via Docker Compose

Update all images: docker-compose pull
- or update a single image: docker-compose pull ldap-auth
Let compose update all containers as necessary: docker-compose up -d
- or update a single container: docker-compose up -d ldap-auth
You can also remove the old dangling images: docker image prune

Versions

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.

README.md Unescape Escape