Portainer Templates logo

Portainer Templates

Ldap-auth Ldap-auth

Container

AdministrationSecurity

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

Image details

Pulls: 8.8M
Architecture: amd64, arm64
Image size: 37 MB
Latest: 3.4.7
User: linuxserver
Created: Aug 17, 2018
Updated: 6 days ago
Status: active

Source details

Repo: nginxinc/nginx-ldap-auth
Stars: 706
Forks: 195
Language: Python
License: BSD-2-Clause
Latest: release-0.0.5 · 6 years ago
Updated: 3 years ago

Configuration

Type
Container
Platform
linux
Image
linuxserver/ldap-auth:latest
Ports
8888:8888/tcp9000:9000/tcp
Volumes
/config : /srv/lsio/ldap-auth/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTCFERNETKEY=CERTFILE=KEYFILE=
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/ldap-auth/config

Standalone Install

Select an install method, to see config/commands for deploying Ldap-auth

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Ldap-auth, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see nginxinc/nginx-ldap-auth for app-specific guidance.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • 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:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/ldap-auth

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
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).
ldap-auth

Supported Architectures

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: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:
ArchitectureAvailableTag
x86-64✅amd64-\
arm64✅arm64v8-\

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

This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

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

Containers 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.
ParameterFunction
-p 8888:8888the port for ldap auth daemon
-p 9000:9000the port for ldap login page
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-e FERNETKEY=Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications)
-e CERTFILE=Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon
-e KEYFILE=Optionally point this to the private key file, matching the certificate file referred to in CERTFILE
--read-only=trueRun container with a read-only filesystem. Please read the docs.
--user=1000:1000Run container with a non-root user. Please read the docs.

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:
id your_user

Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal 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:
```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

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), 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 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)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:
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 .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 17.07.26: - Rebase to Alpine 3.24.
  • 25.12.24: - Add legacy-cgi. Fix fernet key storage.
  • 22.12.24: - Rebase to Alpine 3.21. Add support for read-only and non-root.
  • 30.06.24: - Rebase to Alpine 3.20.
  • 23.12.23: - Rebase to Alpine 3.19.
  • 20.06.23: - Sync upstream changes, including the ability to disable referrals with X-Ldap-DisableReferrals.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 30.12.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 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.

Serve Ldap-auth on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ldap-auth.example.com to http://Ldap-auth:9000

Add this to your Caddyfile

ldap-auth.example.com {
	reverse_proxy http://Ldap-auth:9000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Ldap-auth
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8888 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8888
  • Stop the other service, or pick a different host port. In 8888:8888 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8888. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Ldap-auth can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8888

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/ldap-auth/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/ldap-auth:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Ldap-auth --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

FERNETKEY, CERTFILE, KEYFILE have no default value, and Ldap-auth may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Ldap-auth runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Ldap-auth needs bundled into one download. This template pulls linuxserver/ldap-auth:latest, which Docker fetches once (about 37 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Ldap-auth's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 3.4.7. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8888:8888 means it's reachable on port 8888 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:9000 in a browser. It opens:

  • 8888:8888
  • 9000:9000, likely the web interface

Volumes

A volume is where Ldap-auth keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/ldap-auth/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Ldap-auth takes 6 of them, and 3 need a value before it'll start properly:

  • PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
  • PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
  • TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
  • FERNETKEY, needs a value. Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications) [OPTIONAL]
  • CERTFILE, needs a value. Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon [OPTIONAL]
  • KEYFILE, needs a value. Optionally point this to the private key file, matching the certificate file referred to in CERTFILE [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Ldap-auth after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Ldap-auth sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Ldap-auth. That's what you'll spot in the containers list and use in commands like docker logs Ldap-auth.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Ldap-auth is open source, released under the BSD-2-Clause license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Ldap-auth up. Add the template list to Portainer once, then deploying Ldap-auth is a click rather than a wall of config.