From 00ecacf8ea2674afb043db9e900ad9e769e7929b Mon Sep 17 00:00:00 2001
From: Douwe Maan <douwe@gitlab.com>
Date: Wed, 9 Sep 2015 11:54:48 +0100
Subject: [PATCH] Add to docs
---
config/gitlab.yml.example | 4 ++--
doc/integration/ldap.md | 20 ++++++++++++++++++++
2 files changed, 22 insertions(+), 2 deletions(-)
diff --git a/config/gitlab.yml.example b/config/gitlab.yml.example
index 4d061dc93fb..85461e51dd5 100644
--- a/config/gitlab.yml.example
+++ b/config/gitlab.yml.example
@@ -181,8 +181,8 @@ production: &base
user_filter: ''
# LDAP attributes that GitLab will use to create an account for the LDAP user.
- # Can be either the name of an attribute as a string (e.g. 'mail'),
- # or an array of names of attributes to try in order (e.g. ['mail', 'email']).
+ # The specified attribute can either be the attribute name as a string (e.g. 'mail'),
+ # or an array of attribute names to try in order (e.g. ['mail', 'email']).
# Note that the user's LDAP login will always be the attribute specified as `uid` above.
attributes:
# The username will be used in paths for the user's own projects
diff --git a/doc/integration/ldap.md b/doc/integration/ldap.md
index 904d5d7fee2..3bc5df21ef4 100644
--- a/doc/integration/ldap.md
+++ b/doc/integration/ldap.md
@@ -78,6 +78,26 @@ main: # 'main' is the GitLab 'provider ID' of this LDAP server
#
user_filter: ''
+ # LDAP attributes that GitLab will use to create an account for the LDAP user.
+ # The specified attribute can either be the attribute name as a string (e.g. 'mail'),
+ # or an array of attribute names to try in order (e.g. ['mail', 'email']).
+ # Note that the user's LDAP login will always be the attribute specified as `uid` above.
+ attributes:
+ # The username will be used in paths for the user's own projects
+ # (like `gitlab.example.com/username/project`) and when mentioning
+ # them in issues, merge request and comments (like `@username`).
+ # If the attribute specified for `username` contains an email address,
+ # the GitLab username will be the part of the email address before the '@'.
+ username: ['uid', 'userid', 'sAMAccountName']
+ email: ['mail', 'email', 'userPrincipalName']
+
+ # If no full name could be found at the attribute specified for `name`,
+ # the full name is determined using the attributes specified for
+ # `first_name` and `last_name`.
+ name: 'cn'
+ first_name: 'givenName'
+ last_name: 'sn'
+
# GitLab EE only: add more LDAP servers
# Choose an ID made of a-z and 0-9 . This ID will be stored in the database
# so that GitLab can remember which LDAP server a user belongs to.
--
GitLab