[PR #1331] [MERGED] docs: lldap password in docker install corrected #1263

New issue

Closed

opened 2026-02-27 09:11:32 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 09:11:32 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/lldap/lldap/pull/1331
Author: @NassimBounouas
Created: 10/18/2025
Status: ✅ Merged
Merged: 10/18/2025
Merged by: @nitnelave

Base: main ← Head: fix/1128-docker-install-password-documentation

📝 Commits (1)

459cb92 docs: lldap password in docker install corrected

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 docs/install.md (+1 -1)

📄 Description

Summary

This PR fixes misleading Docker Compose example for LLDAP_LDAP_USER_PASS as reported by @garylavayou within #1128

Description

In the documentation’s Docker Compose example, the environment variable:

- LLDAP_LDAP_USER_PASS=adminPas$word

is misleading.

Docker Compose treats $word as a variable reference, which is undefined and thus replaced by an empty string.
As a result, the actual password becomes adminPas, while users will likely attempt to log in with adminPas$word, causing authentication failures.

What this PR does

This PR updates the example to clarify how to escape $ in Compose environment variables:

- LLDAP_LDAP_USER_PASS=CHANGE_ME # If the password contains '$', escape it (e.g. Pas$$word sets Pas$word)

This avoids confusion and improves the onboarding experience for new users setting up LLDAP via Docker Compose.

Why this matters

New users following the documentation exactly will encounter login errors when trying to use adminPas$word.
By explicitly showing how to escape $, the documentation becomes clearer and reduces setup friction.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/lldap/lldap/pull/1331 **Author:** [@NassimBounouas](https://github.com/NassimBounouas) **Created:** 10/18/2025 **Status:** ✅ Merged **Merged:** 10/18/2025 **Merged by:** [@nitnelave](https://github.com/nitnelave) **Base:** `main` ← **Head:** `fix/1128-docker-install-password-documentation` --- ### 📝 Commits (1) - [`459cb92`](https://github.com/lldap/lldap/commit/459cb92dc49f661120610904339ad19ba82b1759) docs: lldap password in docker install corrected ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/install.md` (+1 -1) </details> ### 📄 Description ## Summary This PR fixes misleading Docker Compose example for `LLDAP_LDAP_USER_PASS` as reported by @garylavayou within #1128 ## Description In the documentation’s Docker Compose example, the environment variable: ```yaml - LLDAP_LDAP_USER_PASS=adminPas$word ``` is misleading. Docker Compose treats `$word` as a variable reference, which is **undefined** and thus replaced by an empty string. As a result, the actual password becomes `adminPas`, while users will likely attempt to log in with `adminPas$word`, causing authentication failures. #### What this PR does This PR updates the example to clarify how to escape `$` in Compose environment variables: ```yaml - LLDAP_LDAP_USER_PASS=CHANGE_ME # If the password contains '$', escape it (e.g. Pas$$word sets Pas$word) ``` This avoids confusion and improves the onboarding experience for new users setting up LLDAP via Docker Compose. #### Why this matters New users following the documentation exactly will encounter login errors when trying to use `adminPas$word`. By explicitly showing how to escape `$`, the documentation becomes clearer and reduces setup friction. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>