Expose JGit's runtime configuration settings (issue 93)

1 files changed, 211 insertions, 115 deletions

diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index 58833c0f..5292a91e 100644
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -47,6 +47,98 @@ git.onlyAccessBareRepositories = false
 # SINCE 1.0.0

 git.defaultAccessRestriction = NONE

 

+# Number of bytes of a pack file to load into memory in a single read operation.

+# This is the "page size" of the JGit buffer cache, used for all pack access

+# operations. All disk IO occurs as single window reads. Setting this too large

+# may cause the process to load more data than is required; setting this too small

+# may increase the frequency of read() system calls.

+#

+# Default on JGit is 8 KiB on all platforms.

+#

+# Common unit suffixes of k, m, or g are supported.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.packedGitWindowSize = 8k

+

+# Maximum number of bytes to load and cache in memory from pack files. If JGit

+# needs to access more than this many bytes it will unload less frequently used

+# windows to reclaim memory space within the process. As this buffer must be shared

+# with the rest of the JVM heap, it should be a fraction of the total memory available.

+#

+# The JGit team recommends setting this value larger than the size of your biggest

+# repository. This ensures you can serve most requests from memory.

+#

+# Default on JGit is 10 MiB on all platforms.

+#

+# Common unit suffixes of k, m, or g are supported.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.packedGitLimit = 10m

+

+# Maximum number of bytes to reserve for caching base objects that multiple deltafied

+# objects reference. By storing the entire decompressed base object in a cache Git

+# is able to avoid unpacking and decompressing frequently used base objects multiple times.

+#

+# Default on JGit is 10 MiB on all platforms. You probably do not need to adjust

+# this value.

+#

+# Common unit suffixes of k, m, or g are supported.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.deltaBaseCacheLimit = 10m

+

+# Maximum number of pack files to have open at once. A pack file must be opened

+# in order for any of its data to be available in a cached window.

+#

+# If you increase this to a larger setting you may need to also adjust the ulimit

+# on file descriptors for the host JVM, as Gitblit needs additional file descriptors

+# available for network sockets and other repository data manipulation.

+#

+# Default on JGit is 128 file descriptors on all platforms.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.packedGitOpenFiles = 128

+

+# Largest object size, in bytes, that JGit will allocate as a contiguous byte

+# array. Any file revision larger than this threshold will have to be streamed,

+# typically requiring the use of temporary files under $GIT_DIR/objects to implement

+# psuedo-random access during delta decompression.

+#

+# Servers with very high traffic should set this to be larger than the size of

+# their common big files. For example a server managing the Android platform

+# typically has to deal with ~10-12 MiB XML files, so 15 m would be a reasonable

+# setting in that environment. Setting this too high may cause the JVM to run out

+# of heap space when handling very big binary files, such as device firmware or

+# CD-ROM ISO images. Make sure to adjust your JVM heap accordingly. 

+#

+# Default is 50 MiB on all platforms.

+#

+# Common unit suffixes of k, m, or g are supported.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.streamFileThreshold = 50m

+

+# When true, JGit will use mmap() rather than malloc()+read() to load data from

+# pack files.  The use of mmap can be problematic on some JVMs as the garbage

+# collector must deduce that a memory mapped segment is no longer in use before

+# a call to munmap() can be made by the JVM native code.

+#

+# In server applications (such as Gitblit) that need to access many pack files,

+# setting this to true risks artificially running out of virtual address space, 

+# as the garbage collector cannot reclaim unused mapped spaces fast enough.

+#

+# Default on JGit is false. Although potentially slower, it yields much more

+# predictable behavior.

+#

+# SINCE 1.0.0

+# RESTART REQUIRED

+git.packedGitMmap = false

+

 #

 # Groovy Integration

 #

@@ -165,121 +257,6 @@ realm.passwordStorage = md5
 # 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

-

-# Attribute(s) on the USER record that indicate their display (or full) name.

-# Leave blank for no mapping available in LDAP.

-#

-# This may be a single attribute, or a string of multiple attributes.  Examples:

-#  displayName - Uses the attribute 'displayName' on the user record

-#  ${personalTitle}. ${givenName} ${surname} - Will concatenate the 3 

-#       attributes together, with a '.' after personalTitle

-#

-# SINCE 1.0.0

-realm.ldap.displayName = displayName

-

-# Attribute(s) on the USER record that indicate their email address.

-# Leave blank for no mapping available in LDAP.

-#

-# This may be a single attribute, or a string of multiple attributes.  Examples:

-#  email - Uses the attribute 'email' on the user record

-#  ${givenName}.${surname}@gitblit.com -Will concatenate the 2 attributes

-#       together with a '.' and '@' creating something like first.last@gitblit.com 

-#

-# SINCE 1.0.0

-realm.ldap.email = email

-

 #

 # Gitblit Web Settings

 #

@@ -754,6 +731,125 @@ federation.sets =
 #federation.example1.mergeAccounts = true

 

 #

+# Advanced Realm Settings

+#

+

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

+

+# Attribute(s) on the USER record that indicate their display (or full) name.

+# Leave blank for no mapping available in LDAP.

+#

+# This may be a single attribute, or a string of multiple attributes.  Examples:

+#  displayName - Uses the attribute 'displayName' on the user record

+#  ${personalTitle}. ${givenName} ${surname} - Will concatenate the 3 

+#       attributes together, with a '.' after personalTitle

+#

+# SINCE 1.0.0

+realm.ldap.displayName = displayName

+

+# Attribute(s) on the USER record that indicate their email address.

+# Leave blank for no mapping available in LDAP.

+#

+# This may be a single attribute, or a string of multiple attributes.  Examples:

+#  email - Uses the attribute 'email' on the user record

+#  ${givenName}.${surname}@gitblit.com -Will concatenate the 2 attributes

+#       together with a '.' and '@' creating something like first.last@gitblit.com 

+#

+# SINCE 1.0.0

+realm.ldap.email = email

+

+#

 # Server Settings

 #