Documentation

James Moger

2014-02-26 d020116c3a9e5a26ece6ea09f19ccccbaa1cf0f5

 src/main/distrib/data/gitblit.properties

@@ -381,6 +381,33 @@
# Common unit suffixes of k, m, or g are supported.

# Documentation courtesy of the Gerrit project.

#

#

# NOTE: The importance of JGit's streamFileTreshold AND Git's bigFileThreshold

# ISSUE: https://bugs.eclipse.org/bugs/show_bug.cgi?id=394078

#

# "core.bigFileThreshold  
#

#    Files larger than this size are stored deflated, without

#    attempting delta compression.  Storing large files without

#    delta compression avoids excessive memory usage, at the

#    slight expense of increased disk usage.

#

#  Default is 512 MiB on all platforms.

#  This should be reasonable for most projects as source code and other 
#  text files can still be delta compressed, 
#  but larger binary media files won't be."

#  -- Git documentation

#

# If streamFileTreshold < bigFileTreshold you _may_ spend alot of time waiting

# for push and/or fetch to complete.  It may even look hung.

#

# Until the issue is resolved gracefully, a workaround is to configure

# bigFileThreshold < streamFileTreshold AND then repack the repository.

#

# e.g. from the repository folder with Gitblit NOT running:

#     git config core.bigFileTreshold 40m

#     git gc --aggressive

#

# SINCE 1.0.0

# RESTART REQUIRED

git.streamFileThreshold = 50m

@@ -1147,6 +1174,7 @@
# Enable/disable global regex substitutions (i.e. shared across repositories)

#

# SINCE 0.5.0

# DEPRECATED 1.4.0 (migrate to bugtraq instead)

regex.global = true



# Example global regex substitutions

@@ -1352,6 +1380,12 @@
# SINCE 1.3.0

realm.windows.allowGuests = false



# Allow user accounts belonging to the BUILTIN\Administrators group to be

# Gitblit administrators.

#

# SINCE 1.4.0

realm.windows.permitBuiltInAdministrators = true



# The default domain for authentication.

#

# If specified, this domain will be used for authentication UNLESS the supplied

@@ -1460,10 +1494,20 @@
# SINCE 1.0.0

realm.ldap.groupMemberPattern = (&(objectClass=group)(member=${dn}))



# Filter criteria for empty LDAP groups

#

# Query pattern to use when searching for an empty team. This may be any valid 
# LDAP query expression, including the standard (&) and (|) operators.

#

# default: (&(objectClass=group)(!(member=*)))

# SINCE 1.4.0

realm.ldap.groupEmptyMemberPattern = (&(objectClass=group)(!(member=*)))



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

# name can be entered as "@team name".  This setting only applies when using

# LDAP to maintain team memberships.

#

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

#

@@ -1493,45 +1537,44 @@
# SINCE 1.0.0

realm.ldap.email = email



# Defines the cache period to be used when caching LDAP queries. This is currently

# only used for LDAP user synchronization.

#

# Must be of the form '<long> <TimeUnit>' where <TimeUnit> is one of 'MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS' 
# default: 2 MINUTES

#

# RESTART REQUIRED

realm.ldap.ldapCachePeriod = 2 MINUTES



# Defines whether to synchronize all LDAP users into the backing user service

#

# Valid values: true, false

# If left blank, false is assumed

realm.ldap.synchronizeUsers.enable = false



# Defines the period to be used when synchronizing users from ldap. This is currently

# only used for LDAP user synchronization.

#

# Must be of the form '<long> <TimeUnit>' where <TimeUnit> is one of 'MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS' 
# <long> is at least 5 Minutes if lower values are given the default is used.

# default: 5 MINUTES

#

# RESTART REQUIRED

realm.ldap.synchronizeUsers.ldapSyncPeriod = 5 MINUTES



# Defines whether to delete non-existent LDAP users from the backing user service

# during synchronization. depends on  realm.ldap.synchronizeUsers.enable = true

#

# Valid values: true, false

# If left blank, true is assumed

realm.ldap.synchronizeUsers.removeDeleted = true



# Attribute on the USER record that indicate their username to be used in gitblit

# when synchronizing users from LDAP

# if blank, Gitblit will use uid

# For MS Active Directory this may be sAMAccountName

#

# SINCE 1.0.0

realm.ldap.uid = uid



# Defines whether to synchronize all LDAP users and teams into the user service

#

# Valid values: true, false

# If left blank, false is assumed

#

# SINCE 1.4.0

realm.ldap.synchronize = false



# Defines the period to be used when synchronizing users and teams from ldap.

#

# Must be of the form '<long> <TimeUnit>' where <TimeUnit> is one of 'MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS' 


# default: 5 MINUTES

#

# RESTART REQUIRED

# SINCE 1.4.0

realm.ldap.syncPeriod = 5 MINUTES



# Defines whether to delete non-existent LDAP users from the user service

# during synchronization. depends on  realm.ldap.synchronize = true

#

# Valid values: true, false

# If left blank, true is assumed

#

# SINCE 1.4.0

realm.ldap.removeDeletedUsers = true



# URL of the Redmine.

#

# SINCE 1.2.0

realm.redmine.url = http://example.com/redmine



#