Documentation

James Moger

2012-04-24 6e15cb51ddcf24c725633c4ab1ff71959b036eb4

 distrib/gitblit.properties

@@ -91,26 +91,6 @@
# SINCE 0.8.0

groovy.postReceiveScripts =



# If true, a Lucene index will be generated and maintained for each repository.

# Lucene search replaces brute-force Git repository traversal.

#

# SINCE 0.9.0

# RESTART REQUIRED

lucene.enable  = false



# If *lucene.pollingMode* = true, Gitblit will periodically check all repositories

# for branch updates.

# If *lucene.pollingMode* = false, repositories will only be indexed on pushes

# to Gitblit.

#

# Regardless of this setting, Gitblit will check all repositories for branch

# updates 1 minute after startup. Indexes will automatically be built for any

# repository that is missing its index  or if an index version change is detected.

#

# SINCE 0.9.0

# RESTART REQUIRED

lucene.pollingMode = false



#

# Authentication Settings

#

@@ -136,7 +116,11 @@
# 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

@@ -155,6 +139,99 @@
#

# SINCE 0.5.0 

realm.minPasswordLength = 5



# URL of the LDAP server.

#

# SINCE 1.0.0

realm.ldap.server = ldap://localhost



# Login username for LDAP searches.

# If this value is unspecified, anonymous LDAP login will be used.

# 
# e.g. mydomain\\username

#

# SINCE 1.0.0

realm.ldap.username = cn=Directory Manager



# Login password for LDAP searches.

#

# SINCE 1.0.0

realm.ldap.password = password



# The LdapUserService must be backed by another user service for standard user

# and team management.

# default: users.conf

#

# SINCE 1.0.0

# RESTART REQUIRED

realm.ldap.backingUserService = users.conf



# Delegate team membership control to LDAP.

#

# If true, team user memberships will be specified by LDAP groups.  This will

# disable team selection in Edit User and user selection in Edit Team.

#

# If false, LDAP will only be used for authentication and Gitblit will maintain

# team memberships with the *realm.ldap.backingUserService*.

#

# SINCE 1.0.0

realm.ldap.maintainTeams = false



# Root node for all LDAP users

#

# 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 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:

#    ${username} - The text entered as the user name

#

# SINCE 1.0.0

realm.ldap.accountPattern = (&(objectClass=person)(sAMAccountName=${username}))



# Root node for all LDAP groups to be used as Gitblit Teams

#

# 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 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:

#    ${username} - The text entered as the user name

#    ${dn} - The Distinguished Name of the user logged in

#

# 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}))



# 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".

#

# e.g. realm.ldap.admins = john @git_admins "@git admins"

#

# SPACE-DELIMITED

# SINCE 1.0.0

realm.ldap.admins= @Git_Admins



#

# Gitblit Web Settings

@@ -203,6 +280,15 @@
#

# SINCE 0.5.0   

web.allowZipDownloads = true



# Allow optional Lucene integration. Lucene indexing is an opt-in feature.

# A repository may specify branches to index with Lucene instead of using Git

# commit traversal. There are scenarios where you may want to completely disable

# Lucene indexing despite a repository specifying indexed branches.  One such

# scenario is on a resource-constrained federated Gitblit mirror.

#

# SINCE 0.9.0

web.allowLuceneIndexing = true



# Use Clippy (Flash solution) to provide a copy-to-clipboard button.

# If false, a button with a more primitive JavaScript-based prompt box will

@@ -393,6 +479,12 @@
# SINCE 0.5.0

web.itemsPerPage = 50



# Registered file extensions to ignore during Lucene indexing

#

# SPACE-DELIMITED

# SINCE 0.9.0

web.luceneIgnoreExtensions = 7z arc arj bin bmp dll doc docx exe gif gz jar jpg lib lzh odg odf odt pdf ppt png so swf xcf xls xlsx zip



# Registered extensions for google-code-prettify

#

# SPACE-DELIMITED