Skip to content

Commit f004a7f

Browse files
committed
Update documentation for LDAP binding in default.properties.
Extend the comments for some realm.ldap.* properties to better explain use cases and requirements.
1 parent a4ad77f commit f004a7f

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

src/main/distrib/data/defaults.properties

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1797,6 +1797,10 @@ realm.salesforce.orgId = 0
17971797
realm.ldap.server = ldap://localhost
17981798

17991799
# Login username for LDAP searches.
1800+
# This is usually a user with permissions to search LDAP users and groups.
1801+
# It must have at least have the permission to search users. If it does not
1802+
# have permission to search groups, the normal user logging in must have
1803+
# the permission in LDAP to search groups.
18001804
# If this value is unspecified, anonymous LDAP login will be used.
18011805
#
18021806
# e.g. mydomain\\username
@@ -1809,8 +1813,14 @@ realm.ldap.username = cn=Directory Manager
18091813
# SINCE 1.0.0
18101814
realm.ldap.password = password
18111815

1812-
# Bind pattern for Authentication.
1813-
# Allow to directly authenticate an user without LDAP Searches.
1816+
# Bind pattern for user authentication.
1817+
# Allow to directly authenticate an user without searching for it in LDAP.
1818+
# Use this if the LDAP server does not allow anonymous access and you don't
1819+
# want to use a specific account to run searches. When set, it will override
1820+
# the settings realm.ldap.username and realm.ldap.password.
1821+
# This requires that all relevant user entries are children to the same DN,
1822+
# and that logging users have permission to search for their groups in LDAP.
1823+
# This will disable synchronization as a specific LDAP account is needed for that.
18141824
#
18151825
# e.g. CN=${username},OU=Users,OU=UserControl,OU=MyOrganization,DC=MyDomain
18161826
#
@@ -1926,6 +1936,9 @@ realm.ldap.email = email
19261936
realm.ldap.uid = uid
19271937

19281938
# Defines whether to synchronize all LDAP users and teams into the user service
1939+
# This requires either anonymous LDAP access or that a specific account is set
1940+
# in realm.ldap.username and realm.ldap.password, that has permission to read
1941+
# users and groups in LDAP.
19291942
#
19301943
# Valid values: true, false
19311944
# If left blank, false is assumed

0 commit comments

Comments
 (0)