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.

Read-Only Operation

Non-Root Operation

Usage

docker-compose (recommended, click here for more info)

---
services:
  ldap-auth:
    image: lscr.io/linuxserver/ldap-auth:latest
    container_name: ldap-auth
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - FERNETKEY= #optional
      - CERTFILE= #optional
      - KEYFILE= #optional
    ports:
      - 8888:8888
      - 9000:9000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=ldap-auth \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e FERNETKEY= `#optional` \
  -e CERTFILE= `#optional` \
  -e KEYFILE= `#optional` \
  -p 8888:8888 \
  -p 9000:9000 \
  --restart unless-stopped \
  lscr.io/linuxserver/ldap-auth:latest

Parameters

Environment variables from files (Docker secrets)

-e FILE__MYVAR=/run/secrets/mysecretvariable

Umask for running applications

User / Group Identifiers

id your_user

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Support Info

• Shell access whilst the container is running:

```bash
docker exec -it ldap-auth /bin/bash
```

• To monitor the logs of the container in realtime:

```bash
docker logs -f ldap-auth
```

• Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth
```

• Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest
```

Updating Info

Via Docker Compose

• Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull ldap-auth
    ```

• Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d ldap-auth
    ```

• You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

• Update the image:

```bash
docker pull lscr.io/linuxserver/ldap-auth:latest
```

• Stop the running container:

```bash
docker stop ldap-auth
```

• Delete the container:

```bash
docker rm ldap-auth
```

• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

git clone https://github.com/linuxserver/docker-ldap-auth.git
cd docker-ldap-auth
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/ldap-auth:latest .

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset