readme-vars.yml

---

# project information
project_name: ldap-auth
project_url: "https://github.com/nginxinc/nginx-ldap-auth"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ldap-auth-logo.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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)."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}

# container parameters
common_param_env_vars_enabled: false
param_container_name: "{{ project_name }}"
param_usage_include_vols: false
param_volumes: ""
param_usage_include_ports: true
param_ports:
  - { external_port: "8888", internal_port: "8888", port_desc: "the port for ldap auth daemon" }
  - { external_port: "9000", internal_port: "9000", port_desc: "the port for ldap login page" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London" }

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "FERNETKEY", env_value: "", desc: "Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications)" }
  - { env_var: "CERTFILE", env_value: "", desc: "Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon" }
  - { env_var: "KEYFILE", env_value: "", desc: "Optionally point this to the private key file, matching the certificate file referred to in CERTFILE" }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  - 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](https://github.com/nginxinc/nginx-ldap-auth/blob/master/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.

# changelog
changelogs:
  - { date: "20.06.23:", desc: "Sync upstream changes, including the ability to disable referrals with `X-Ldap-DisableReferrals`." }
  - { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
  - { date: "30.12.22:", desc: "Rebase to alpine 3.17." }
  - { date: "19.09.22:", desc: "Rebase to alpine 3.15." }
  - { date: "14.05.21:", desc: "Add linuxserver wheel index." }
  - { date: "12.02.21:", desc: "Clean up cargo/rust cache." }
  - { date: "10.02.21:", desc: "Rebasing to alpine 3.13." }
  - { date: "08.09.20:", desc: "Set form action correctly." }
  - { date: "30.07.20:", desc: "Fix bug related to unset optional `CERTFILE` and `KEYFILE` vars." }
  - { date: "27.07.20:", desc: "Add support for HTTP over SSL (HTTPS)." }
  - { date: "21.07.20:", desc: "Add support for optional user defined fernet key." }
  - { date: "02.06.20:", desc: "Rebasing to alpine 3.12, serve login page at `/ldaplogin` as well as `/login`, to prevent clashes with reverese proxied apps." }
  - { date: "17.05.20:", desc: "Add support for self-signed CA certs." }
  - { date: "20.02.20:", desc: "Switch to python3." }
  - { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
  - { date: "01.07.19:", desc: "Fall back to base64 encoding when basic http auth is used." }
  - { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "22.02.19:", desc: "Rebasing to alpine 3.9." }
  - { date: "18.09.18:", desc: "Update pip" }
  - { date: "14.09.18:", desc: "Add TZ parameter, remove unnecessary PUID/PGID params" }
  - { date: "11.08.18:", desc: "Initial release." }