From 84bcb01d52d509b8ca9c1fd2c6dc09444f3f9ef8 Mon Sep 17 00:00:00 2001
From: Maxime Dor <max@kamax.io>
Date: Fri, 4 Aug 2017 16:08:09 +0200
Subject: [PATCH] Be clearer about ldap.attribute config item

---
 application.example.yaml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/application.example.yaml b/application.example.yaml
index 82965fb..36908d4 100644
--- a/application.example.yaml
+++ b/application.example.yaml
@@ -114,8 +114,10 @@ ldap:
 
   # The attribute containing the binding itself. This value will be used differently depending on the type.
   #
+  # /!\ This should match the synapse LDAP Authenticator 'uid' configuration /!\
+  #
   # Typical values:
-  # - For type 'uid': userPrincipalName
+  # - For type 'uid': 'userPrincipalName' or 'uid' or 'saMAccountName'
   # - For type 'mxid', regardless of the directory type, we recommend using 'pager' as it is a standard attribute and
   #   is typically not used.
   attribute: 'userPrincipalName'