From 390f0b76b51d966b2ac429c28d07fbec5497a4c0 Mon Sep 17 00:00:00 2001
From: Jacob Vosmaer <contact@jacobvosmaer.nl>
Date: Fri, 17 Jan 2014 11:34:06 +0100
Subject: [PATCH] Explain allow_username_or_email_login LDAP setting

---
 config/gitlab.yml.example | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 71d46d4a19..845862fe7a 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -127,6 +127,11 @@ production: &base
     method: 'ssl' # "ssl" or "plain"
     bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
     password: '_the_password_of_the_bind_user'
+    # If allow_username_or_email_login is enabled, GitLab will ignore everything
+    # after the first '@' in LDAP the 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'.
     allow_username_or_email_login: true
 
   ## OmniAuth settings
-- 
2.30.9