summaryrefslogtreecommitdiffstats
path: root/distrib
diff options
context:
space:
mode:
Diffstat (limited to 'distrib')
-rw-r--r--distrib/gitblit.properties52
1 files changed, 32 insertions, 20 deletions
diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index 527b7268..9ccd35d6 100644
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -116,7 +116,11 @@ web.allowCookieAuthentication = true
# Either the full path to a user config file (users.conf)
# OR the full path to a simple user properties file (users.properties)
# OR a fully qualified class name that implements the IUserService interface.
-# Any custom implementation must have a public default constructor.
+#
+# Alternative user services:
+# com.gitblit.LdapUserService
+#
+# Any custom user service implementation must have a public default constructor.
#
# SINCE 0.5.0
# RESTART REQUIRED
@@ -142,9 +146,7 @@ realm.minPasswordLength = 5
realm.ldap.server = ldap://localhost
# Login username for LDAP searches.
-# The domain prefix may be omitted if it matches the domain specified in
-# *realm.ldap.domain*. If this value is unspecified, anonymous LDAP login will
-# be used.
+# If this value is unspecified, anonymous LDAP login will be used.
#
# e.g. mydomain\\username
#
@@ -175,49 +177,59 @@ realm.ldap.backingUserService = users.conf
# SINCE 1.0.0
realm.ldap.maintainTeams = false
-# Root node that all Users sit under in LDAP
+# Root node for all LDAP users
#
-# This is the root node that searches for user information will begin from in LDAP
-# If blank, it will search ALL of ldap.
+# This is the root node from which subtree user searches will begin.
+# If blank, Gitblit will search ALL nodes.
#
# SINCE 1.0.0
realm.ldap.accountBase = OU=Users,OU=UserControl,OU=MyOrganization,DC=MyDomain
-# Filter Criteria for Users in LDAP
+# Filter criteria for LDAP users
#
# Query pattern to use when searching for a user account. This may be any valid
-# LDAP query expression, including the standard (&) and (|) operators. Variables may
-# be injected via the ${variableName} syntax. Recognized variables are:
+# LDAP query expression, including the standard (&) and (|) operators.
+#
+# Variables may be injected via the ${variableName} syntax.
+# Recognized variables are:
# ${username} - The text entered as the user name
#
# SINCE 1.0.0
realm.ldap.accountPattern = (&(objectClass=person)(sAMAccountName=${username}))
-# Root node that all Teams sit under in LDAP
+# Root node for all LDAP groups to be used as Gitblit Teams
#
-# This is the node that searches for team information will begin from in LDAP
-# If blank, it will search ALL of ldap.
+# This is the root node from which subtree team searches will begin.
+# If blank, Gitblit will search ALL nodes.
#
# SINCE 1.0.0
realm.ldap.groupBase = OU=Groups,OU=UserControl,OU=MyOrganization,DC=MyDomain
-# Filter Criteria for Teams in LDAP
+# Filter criteria for LDAP groups
#
# Query pattern to use when searching for a team. This may be any valid
-# LDAP query expression, including the standard (&) and (|) operators. Variables may
-# be injected via the ${variableName} syntax. Recognized variables are:
+# LDAP query expression, including the standard (&) and (|) operators.
+#
+# Variables may be injected via the ${variableName} syntax.
+# Recognized variables are:
# ${username} - The text entered as the user name
# ${dn} - The Distinguished Name of the user logged in
-# All attributes on the User's record are also passed in. For example, if a user has an
-# attribute "fullName" set to "John", "(fn=${fullName})" will be translated to "(fn=John)".
+#
+# All attributes from the LDAP User record are available. For example, if a user
+# has an attribute "fullName" set to "John", "(fn=${fullName})" will be
+# translated to "(fn=John)".
#
# SINCE 1.0.0
realm.ldap.groupMemberPattern = (&(objectClass=group)(member=${dn}))
-# Users and or teams that are Admins, read from LDAP
+# LDAP users or groups that should be given administrator privileges.
+#
+# Teams are specified with a leading '@' character. Groups with spaces in the
+# name can be entered as "@team name".
#
-# This is a space delimited list. If it starts with @, it indicates a Team Name
+# e.g. realm.ldap.admins = john @git_admins "@git admins"
#
+# SPACE-DELIMITED
# SINCE 1.0.0
realm.ldap.admins= @Git_Admins