From 8c99a7929b48b4c4a33c80d0b6646f6e6bb563b5 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 03 Jul 2013 21:35:02 -0400
Subject: [PATCH] Documentation

---
 src/main/distrib/data/gitblit.properties |  209 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 202 insertions(+), 7 deletions(-)

diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index c1587d6..f6ed383 100644
--- a/src/main/distrib/data/gitblit.properties
+++ b/src/main/distrib/data/gitblit.properties
@@ -76,6 +76,23 @@
 # SINCE 1.1.0
 git.submoduleUrlPatterns = .*?://github.com/(.*)
 
+# Specify the interface for Git Daemon to bind it's service.
+# 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 1.3.0
+# RESTART REQUIRED
+git.daemonBindInterface = localhost
+
+# port for serving the Git Daemon service.  <= 0 disables this service.
+# On Unix/Linux systems, ports < 1024 require root permissions.
+# Recommended value: 9418
+#
+# SINCE 1.3.0
+# RESTART REQUIRED
+git.daemonPort = 9418
+
 # Allow push/pull over http/https with JGit servlet.
 # If you do NOT want to allow Git clients to clone/push to Gitblit set this
 # to false.  You might want to do this if you are only using ssh:// or git://.
@@ -145,6 +162,17 @@
 #
 # SINCE 1.1.0
 git.defaultAuthorizationControl = NAMED
+
+# The default incremental push tag prefix.  Tag prefix applied to a repository
+# that has automatic push tags enabled and does not specify a custom tag prefix.
+#
+# If incremental push tags are enabled, the tips of each branch in the push will
+# be tagged with an increasing revision integer.
+#
+# e.g. refs/tags/r2345 or refs/tags/rev_2345 
+#
+# SINCE 1.3.0
+git.defaultIncrementalPushTagPrefix = r
 
 # Enable JGit-based garbage collection. (!!EXPERIMENTAL!!)
 #
@@ -471,6 +499,8 @@
 # Alternative user services:
 #    com.gitblit.LdapUserService
 #    com.gitblit.RedmineUserService
+#    com.gitblit.SalesforceUserService
+#    com.gitblit.WindowsUserService
 #
 # Any custom user service implementation must have a public default constructor.
 #
@@ -500,6 +530,53 @@
 #
 # SINCE 0.5.0
 web.siteName =
+
+# You may specify a different logo image for the header but it must be 120x45px.
+# If the specified file does not exist, the default Gitblit logo will be used.
+#
+# SINCE 1.3.0
+# BASEFOLDER
+web.headerLogo = ${baseFolder}/logo.png
+
+# You may specify a custom header background CSS color.  If unspecified, the
+# default color will be used.
+#
+# e.g. web.headerBackgroundColor = #002060
+#
+# SINCE 1.3.0
+web.headerBackgroundColor =
+
+# You may specify a custom header foreground CSS color.  If unspecified, the
+# default color will be used.
+#
+# e.g. web.headerForegroundColor = white
+#
+# SINCE 1.3.0
+web.headerForegroundColor =
+
+# You may specify a custom header foreground hover CSS color.  If unspecified, the
+# default color will be used.
+#
+# e.g. web.headerHoverColor = white
+#
+# SINCE 1.3.0
+web.headerHoverColor =
+
+# You may specify a custom header border CSS color.  If unspecified, the default
+# color will be used.
+#
+# e.g. web.headerBorderColor = #002060
+#
+# SINCE 1.3.0
+web.headerBorderColor =
+
+# You may specify a custom header border CSS color.  If unspecified, the default
+# color will be used.
+#
+# e.g. web.headerBorderFocusColor = #ff9900
+#
+# SINCE 1.3.0
+web.headerBorderFocusColor =
 
 # If *web.authenticateAdminPages*=true, users with "admin" role can create
 # repositories, create users, and edit repository metadata.
@@ -723,13 +800,25 @@
 web.forwardSlashCharacter = /
 
 # Show other URLs on the summary page for accessing your git repositories
-# Use spaces to separate urls. {0} is the token for the repository name.
+# Use spaces to separate urls.
+#
+# {0} is the token for the repository name
+# {1} is the token for the username
+#
+# The username is only practical if you have setup your other git serving
+# solutions accounts to have the same username as the Gitblit account.
+#
 # e.g.
-# web.otherUrls = ssh://localhost/git/{0} git://localhost/git/{0}
+# web.otherUrls = ssh://localhost/git/{0} git://localhost/git/{0} https://{1}@localhost/r/{0}
 #
 # SPACE-DELIMITED
 # SINCE 0.5.0
 web.otherUrls = 
+
+# Should app-specific clone links be displayed for SourceTree, SparkleShare, etc?
+#
+# SINCE 1.3.0
+web.allowAppCloneLinks = true
 
 # Choose how to present the repositories list.
 #   grouped = group nested/subfolder repositories together (no sorting)
@@ -773,11 +862,38 @@
 # SINCE 0.5.0 
 web.generateActivityGraph = true
 
-# The number of days to show on the activity page.
-# Value must exceed 0 else default of 14 is used
+# The default number of days to show on the activity page.
+# Value must exceed 0 else default of 7 is used
 #
 # SINCE 0.8.0
-web.activityDuration = 14
+web.activityDuration = 7
+
+# Choices for days of activity to display.
+#
+# SPACE-DELIMITED
+# SINCE 1.3.0
+web.activityDurationChoices = 1 3 7 14 21 28
+
+# The number of days of commits to cache in memory for the dashboard, activity,
+# and project pages.  A value of 0 will disable all caching and will parse commits
+# in each repository per-request.  If the value > 0 these pages will try to fulfill
+# requests using the commit cache.  If the request specifies a period which falls
+# outside the commit cache window, then the cache will be ignored and the request
+# will be fulfilled by brute-force parsing all relevant commits per-repository.
+#
+# Consider the values specified for *web.activityDurationChoices* when setting
+# the cache size AND consider adjusting the JVM -Xmx heap parameter appropriately.
+#
+# SINCE 1.3.0
+# RESTART REQUIRED
+web.activityCacheDays = 14
+
+# Case-insensitive list of authors to exclude from metrics.  Useful for
+# eliminating bots.
+#
+# SPACE-DELIMITED
+# SINCE 1.3.0
+web.metricAuthorExclusions =
 
 # The number of commits to display on the summary page
 # Value must exceed 0 else default of 20 is used
@@ -794,10 +910,22 @@
 web.summaryRefsCount = 5
 
 # The number of items to show on a page before showing the first, prev, next
-# pagination links.  A default if 50 is used for any invalid value.
+# pagination links.  A default of 50 is used for any invalid value.
 #
 # SINCE 0.5.0
 web.itemsPerPage = 50
+
+# The number of reflog changes to display on the overview page
+# Value must exceed 0 else default of 5 is used
+#
+# SINCE 1.3.0
+web.overviewReflogCount = 5
+
+# The number of reflog changes to show on a reflog page before show the first,
+#  prev, next pagination links.  A default of 10 is used for any invalid value.
+#
+# SINCE 1.3.0
+web.reflogChangesPerPage = 10
 
 # Registered file extensions to ignore during Lucene indexing
 #
@@ -809,7 +937,7 @@
 #
 # SPACE-DELIMITED
 # SINCE 0.5.0
-web.prettyPrintExtensions = c cpp cs css frm groovy htm html java js moxie php pl prefs properties py rb scala sh sql xml vb yaml yml
+web.prettyPrintExtensions = aea agc basic c cbm cl clj cpp cs css dart el erl erlang frm fs go groovy hs htm html java js latex lisp ll llvm lsp lua ml moxie mumps n nemerle pascal php pl prefs properties proto py r R rb rd Rd rkt s S scala scm sh Splus sql ss tcl tex vb vbs vhd vhdl wiki xml xq xquery yaml yml ymlapollo
 
 # Registered extensions for markdown transformation
 #
@@ -841,6 +969,16 @@
 # SINCE 0.5.0
 # RESTART REQUIRED
 web.debugMode = false
+
+# Force a default locale for all users, ignoring the browser's settings.
+# An empty value allows Gitblit to use the translation preferred by the browser.
+#
+# Changing this value while the server is running will only affect new sessions.
+#
+# e.g. web.forceDefaultLocale = en
+#
+# SINCE 1.3.0
+web.forceDefaultLocale = 
 
 # Enable/disable global regex substitutions (i.e. shared across repositories)
 #
@@ -880,6 +1018,9 @@
 #
 # SINCE 0.6.0
 mail.debug = false
+
+# use SMTPs flag
+mail.smtps = false
 
 # if your smtp server requires authentication, supply the credentials here
 #
@@ -1030,6 +1171,54 @@
 #
 # Advanced Realm Settings
 #
+
+# Auto-creates user accounts based on the servlet container principal.  This
+# assumes that your Gitblit install is a protected resource and your container's
+# authentication process intercepts all Gitblit requests.
+#
+# SINCE 1.3.0
+realm.container.autoCreateAccounts = false
+
+# The WindowsUserService must be backed by another user service for standard user
+# and team management.
+# default: users.conf
+#
+# RESTART REQUIRED
+# BASEFOLDER
+# SINCE 1.3.0
+realm.windows.backingUserService = ${baseFolder}/users.conf
+
+# Allow or prohibit Windows guest account logins
+#
+# SINCE 1.3.0
+realm.windows.allowGuests = false
+
+# The default domain for authentication.
+#
+# If specified, this domain will be used for authentication UNLESS the supplied
+# login name manually specifies a domain (.e.g. mydomain\james or james@mydomain)
+#
+# If unspecified, the username must be specified in UPN format (name@domain).
+#
+# if "." (dot) is specified, ONLY the local account database will be used.
+#
+# SINCE 1.3.0
+realm.windows.defaultDomain =
+
+# The SalesforceUserService must be backed by another user service for standard user
+# and team management.
+# default: users.conf
+#
+# RESTART REQUIRED
+# BASEFOLDER
+# SINCE 1.3.0
+realm.salesforce.backingUserService = ${baseFolder}/users.conf
+
+# Restrict the Salesforce user to members of this org.
+# default: 0 (i.e. do not check the Org ID)
+#
+# SINCE 1.3.0
+realm.salesforce.orgId = 0
 
 # URL of the LDAP server.
 # To use encrypted transport, use either ldaps:// URL for SSL or ldap+tls:// to
@@ -1205,6 +1394,12 @@
 # RESTART REQUIRED
 server.useNio = true
 
+# Specify the maximum number of concurrent http/https worker threads to allow. 
+#
+# SINCE 1.3.0
+# RESTART REQUIRED
+server.threadPoolSize = 50
+
 # Context path for the GO application.  You might want to change the context
 # path if running Gitblit behind a proxy layer such as mod_proxy.
 #

--
Gitblit v1.9.1