Documentation

James Moger

2012-04-24 6e15cb51ddcf24c725633c4ab1ff71959b036eb4

 distrib/gitblit.properties

@@ -2,7 +2,9 @@
# Git Servlet Settings

#



# Base folder for repositories

# Base folder for repositories.

# This folder may contain bare and non-bare repositories but Gitblit will only

# allow you to push to bare repositories.

# Use forward slashes even on Windows!!

# e.g. c:/gitrepos

#

@@ -27,6 +29,13 @@
#

# SINCE 0.5.0

git.enableGitServlet = true



# Only serve/display bare repositories.

# If there are non-bare repositories in git.repositoriesFolder and this setting

# is true, they will be excluded from the ui. 
#

# SINCE 0.9.0

git.onlyAccessBareRepositories = false



#

# Groovy Integration

@@ -107,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

@@ -126,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

@@ -175,6 +281,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

# offer a 3-step (click, ctrl+c, enter) copy-to-clipboard alternative.

@@ -222,6 +337,15 @@
#

# SINCE 0.5.0

web.repositoriesMessage = gitblit



# Manually set the default timezone to be used by Gitblit for display in the 
# web ui.  This value is independent of the JVM timezone.  Specifying a blank

# value will default to the JVM timezone.

# e.g. America/New_York, US/Pacific, UTC, Europe/Berlin

#

# SINCE 0.9.0

# RESTART REQUIRED

web.timezone =



# Use the client timezone when formatting dates.

# This uses AJAX to determine the browser's timezone and may require more

@@ -273,7 +397,8 @@
#

# <https://issues.apache.org/jira/browse/WICKET-1303>

# <http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10>

# Add *org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true* to *CATALINA_OPTS*

# Add *-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true* to your

# *CATALINA_OPTS* or to your JVM launch parameters

#

# SINCE 0.5.2

web.forwardSlashCharacter = /

@@ -353,6 +478,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

#

@@ -614,6 +745,14 @@
# RESTART REQUIRED

server.httpsPort = 8443



# Port for serving an Apache JServ Protocol (AJP) 1.3 connector for integrating

# Gitblit GO into an Apache HTTP server setup.  <= 0 disables this connector.

# Recommended value: 8009

#

# SINCE 0.9.0

# RESTART REQUIRED

server.ajpPort = 0



# Specify the interface for Jetty to bind the standard connector.

# You may specify an ip or an empty value to bind to all interfaces.

# Specifying localhost will result in Gitblit ONLY listening to requests to

@@ -632,6 +771,15 @@
# RESTART REQUIRED

server.httpsBindInterface = localhost



# Specify the interface for Jetty to bind the AJP connector.

# You may specify an ip or an empty value to bind to all interfaces.

# Specifying localhost will result in Gitblit ONLY listening to requests to

# localhost.

#

# SINCE 0.9.0

# RESTART REQUIRED

server.ajpBindInterface = localhost



# Password for SSL keystore.

# Keystore password and certificate password must match.

# This is provided for convenience, its probably more secure to set this value