Explain how to use AD userPrincipalName for logins

diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index f628ac9..cdab54f 100644 (file)
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -129,9 +129,12 @@ production: &base
     password: '_the_password_of_the_bind_user'
     # If allow_username_or_email_login is enabled, GitLab will ignore everything
     # after the first '@' in the LDAP username submitted by the user on login.
+    #
     # Example:
     # - the user enters 'jane.doe@example.com' and 'p@ssw0rd' as LDAP credentials;
     # - GitLab queries the LDAP server with 'jane.doe' and 'p@ssw0rd'.
+    #
+    # Disable this setting if you are using "uid: 'userPrincipalName'" on ActiveDirectory.
     allow_username_or_email_login: true
 
   ## OmniAuth settings