lsiodev/ldap-auth

linuxserver/ldap-auth

镜像概述和主要用途

https://github.com/nginxinc/nginx-ldap-auth是用于对请求Nginx代理服务器保护资源的用户进行认证的软件。它包含一个与认证服务器通信的守护进程（ldap-auth）和一个基于用户凭据生成认证cookie的Web服务器守护进程。这些守护进程采用Python编写，适用于轻量级目录访问协议（LDAP）认证服务器（OpenLDAP或Microsoft Windows Active Directory 2003和2012）。

LinuxServer.io团队提供的此容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6覆盖层的自定义基础镜像
• 每周基础OS更新，在整个LinuxServer.io生态系统中共享公共层，以最小化空间使用、停机时间和带宽
• 定期安全更新

支持的架构

我们利用Docker清单实现多平台支持。只需拉取lscr.io/linuxserver/ldap-auth:latest即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构如下：

应用设置

• 此容器本身没有任何设置，依赖传入请求的HTTP头中传递的相关信息。确保您的Web服务器已配置正确的设置。
• 示例配置：https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf。
• 与上游项目不同，此镜像使用Fernet对cookie信息进行编码，在容器创建期间生成随机密钥（或可选由用户定义）。
• 同样与上游项目不同，此镜像在/ldaplogin（以及/login）提供登录页面，以避免与可能也使用/login进行内部认证的反向代理应用冲突。

使用方法

以下是使用Docker Compose或Docker CLI创建容器的方法。

Docker Compose（推荐，https://docs.linuxserver.io/general/docker-compose）

yaml
---
version: "2.1"
services:
  ldap-auth:
    image: docker.xuanyuan.run/linuxserver/ldap-auth:latest
    container_name: ldap-auth
    environment:
      - FERNETKEY= #可选
      - CERTFILE= #可选
      - KEYFILE= #可选
    ports:
      - 8888:8888
      - 9000:9000
    restart: unless-stopped

Docker CLI（https://docs.docker.com/engine/reference/commandline/cli/）

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

参数

容器通过运行时传递的参数进行配置（如上所示）。这些参数以冒号分隔，表示<外部>:<内部>。例如，-p 8080:80将容器内的80端口暴露到主机IP的8080端口。

来自文件的环境变量（Docker secrets）

您可以使用特殊的前缀FILE__从文件设置任何环境变量。

例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

这将根据/run/secrets/mysecretvariable文件的内容设置环境变量MYVAR。

应用运行的Umask

对于所有镜像，我们提供使用可选的-e UMASK=022设置覆盖容器内启动的服务的默认umask设置的能力。请注意，umask不是chmod，它基于其值减去权限，而不是添加。请在请求支持前阅读相关内容。

Docker Mods

我们发布了各种https://github.com/linuxserver/docker-mods以启用容器内的额外功能。可通过上方动态徽章访问此镜像的可用Mods列表（如有）以及可应用于任何LinuxServer.io镜像的通用Mods。

支持信息

• 容器运行时的Shell访问：

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

• 实时监控容器日志：

  bash
  docker logs -f ldap-auth
  

• 容器版本号：

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

• 镜像版本号：

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

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部应用。除某些例外（如nextcloud、plex），我们不建议或支持在容器内更新应用。请参考上方应用设置部分，了解是否推荐对此镜像进行应用更新。

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull ldap-auth
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d ldap-auth
    

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull docker.xuanyuan.run/linuxserver/ldap-auth:latest
  

• 停止运行中的容器：

  bash
  docker stop ldap-auth
  

• 删除容器：

  bash
  docker rm ldap-auth
  

• 使用上述相同的docker run参数重新创建新容器（如果正确映射到主机文件夹，您的/config文件夹和设置将被保留）

• 您还可以删除旧的悬空镜像：

  bash
  docker image prune
  

通过Watchtower自动更新器（仅在忘记原始参数时使用）

• 拉取标签的最新镜像并使用相同的环境变量替换：

  bash
  docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    docker.xuanyuan.run/containrrr/watchtower \
    --run-once ldap-auth
  

• 您还可以删除旧的悬空镜像：docker image prune

警告：我们不认可使用Watchtower作为现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于忘记原始参数的容器，这是一个有用的一次性手动更新工具。长期来看，我们强烈建议使用https://docs.linuxserver.io/general/docker-compose。

镜像更新通知 - Diun（Docker Image Update Notifier）

提示：我们推荐https://crazymax.dev/diun/用于更新通知。不建议或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

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

可以使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体：

bash
docker run --rm --privileged docker.xuanyuan.run/multiarch/qemu-user-static:register --reset

注册后，您可以使用-f Dockerfile.aarch64指定要使用的Dockerfile。

版本历史

• 20.06.23: - 同步上游更改，包括使用X-Ldap-DisableReferrals禁用引用的功能。
• 25.05.23: - 基于Alpine 3.18重建，弃用armhf。
• 30.12.22: - 基于Alpine 3.17重建。
• 19.09.22: - 基于Alpine 3.15重建。
• 14.05.21: - 添加linuxserver wheel索引。
• 12.02.21: - 清理cargo/rust缓存。
• 10.02.21: - 基于Alpine 3.13重建。
• 08.09.20: - 正确设置表单操作。
• 30.07.20: - 修复与未设置可选CERTFILE和KEYFILE变量相关的错误。
• 27.07.20: - 添加对HTTP over SSL（HTTPS）的支持。
• 21.07.20: - 添加对可选用户定义Fernet密钥的支持。
• 02.06.20: - 基于Alpine 3.12重建，在/ldaplogin和/login提供登录页面，以避免与反向代理应用冲突。
• 17.05.20: - 添加对自签名CA证书的支持。
• 20.02.20: - 切换到python3。
• 19.12.19: - 基于Alpine 3.11重建。
• 01.07.19: - 使用基本HTTP认证时回退到base64编码。
• 28.06.19: - 基于Alpine 3.10重建。
• 23.03.19: - 切换到新的基础镜像，迁移到arm32v7标签。
• 22.02.19: - 基于Alpine 3.9重建。
• 18.09.18: - 更新pip。
• 14.09.18: - 添加TZ参数，移除不必要的PUID/PGID参数。
• 11.08.18: - 初始发布。