From 1fd80700949dd7f7f0dfbb01e9f582526ab8e7b5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Shykh=20Smyr=7C=D8=B4=D9=8A=D8=AE=20=D8=B3=D9=85=D9=8A?=
 =?UTF-8?q?=D8=B1?= <C0d3rZ3r0@users.noreply.github.com>
Date: Wed, 26 Jun 2024 18:49:49 +0530
Subject: [PATCH] Added note for escaping LDAP password in template.env (#84)

If the LDAP password contains special characters that need escaping, they must be doubly escaped inside .env.

Added a reminder against the password field for that.
---
 template.env | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/template.env b/template.env
index 7ddd190..8cdeb23 100644
--- a/template.env
+++ b/template.env
@@ -113,7 +113,7 @@ SYNCSERVERS_1_KEY=
 # LDAP_SERVER="ldap://your_domain_controller"
 # LDAP_STARTTLS=true
 # LDAP_READER_USER="CN=service_account_name,OU=Users,DC=domain,DC=net"
-# LDAP_READER_PASSWORD="password"
+# LDAP_READER_PASSWORD="password" # Doubly escape necessary special characters inside the password. E.g. literal "pass\word" should be escaped as "pass\\\\word"
 # LDAP_DN="OU=Users,DC=domain,DC=net"
 # LDAP_SEARCH_FILTER=""
 # LDAP_SEARCH_ATTRIBUTE="uid"