From d65f712ea3d8941f4b9145c0630c30c20af80d13 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 11 Nov 2011 17:22:21 -0500
Subject: [PATCH] Documentation. Add javadoc and source jars to the gbapi download.

---
 distrib/gitblit.properties |  128 +++++++++++++++++++++++++++++++++---------
 1 files changed, 100 insertions(+), 28 deletions(-)

diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index ebdd0b0..0048e55 100644
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -59,7 +59,9 @@
 realm.userService = users.properties
 
 # How to store passwords.
-# Valid values are plain or md5.  Default is md5.
+# Valid values are plain, md5, or combined-md5.  md5 is the hash of password.
+# combined-md5 is the hash of username.toLowerCase()+password.
+# Default is md5.
 #
 # SINCE 0.5.0 
 realm.passwordStorage = md5
@@ -87,6 +89,27 @@
 # SINCE 0.5.0 
 web.allowAdministration = true
 
+# Allows rpc clients to list repositories and possibly manage or administer the 
+# Gitblit server, if the authenticated account has administrator permissions.
+# See *web.enableRpcManagement* and *web.enableRpcAdministration*.
+#
+# SINCE 0.7.0 
+web.enableRpcServlet = true
+
+# Allows rpc clients to manage repositories and users of the Gitblit instance,
+# if the authenticated account has administrator permissions.
+# Requires *web.enableRpcServlet=true*.
+#
+# SINCE 0.7.0 
+web.enableRpcManagement = false
+
+# Allows rpc clients to control the server settings and monitor the health of this
+# this Gitblit instance, if the authenticated account has administrator permissions.
+# Requires *web.enableRpcServlet=true* and *web.enableRpcManagement*.
+#
+# SINCE 0.7.0 
+web.enableRpcAdministration = false
+
 # Allow dynamic zip downloads.
 #
 # SINCE 0.5.0   
@@ -110,7 +133,14 @@
 # SINCE 0.6.0
 web.showFederationRegistrations = false
 
-# This is the message display above the repositories table.
+# This is the message displayed when *web.authenticateViewPages=true*.
+# This can point to a file with Markdown content.
+# Specifying "gitblit" uses the internal login message.
+#
+# SINCE 0.7.0
+web.loginMessage = gitblit
+
+# This is the message displayed above the repositories table.
 # This can point to a file with Markdown content.
 # Specifying "gitblit" uses the internal welcome message.
 #
@@ -155,7 +185,7 @@
 # to preemptively replace '/' with '*' or '!' for url string parameters.
 #
 # <https://issues.apache.org/jira/browse/WICKET-1303>
-# <http://tomcat.apache.org/security-6.html>
+# <http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10>
 #
 # SINCE 0.5.2
 web.forwardSlashCharacter = /
@@ -226,22 +256,26 @@
 
 # Registered extensions for google-code-prettify
 #
+# SPACE-DELIMITED
 # SINCE 0.5.0
 web.prettyPrintExtensions = c cpp cs css htm html java js php pl prefs properties py rb sh sql xml vb
 
 # Registered extensions for markdown transformation
 #
+# SPACE-DELIMITED
 # CASE-SENSITIVE
 # SINCE 0.5.0
 web.markdownExtensions = md mkd markdown MD MKD
 
 # Image extensions
 #
+# SPACE-DELIMITED
 # SINCE 0.5.0
 web.imageExtensions = bmp jpg gif png 
 
 # Registered extensions for binary blobs
 #
+# SPACE-DELIMITED
 # SINCE 0.5.0
 web.binaryExtensions = jar pdf tar.gz zip
 
@@ -265,10 +299,13 @@
 # Example global regex substitutions
 # Use !!! to separate the search pattern and the replace pattern
 # searchpattern!!!replacepattern
+# SINCE 0.5.0
 regex.global.bug = \\b(Bug:)(\\s*[#]?|-){0,1}(\\d+)\\b!!!<a href="http://somehost/bug/$3">Bug-Id: $3</a>
+# SINCE 0.5.0
 regex.global.changeid = \\b(Change-Id:\\s*)([A-Za-z0-9]*)\\b!!!<a href="http://somehost/changeid/$2">Change-Id: $2</a>
 
 # Example per-repository regex substitutions overrides global
+# SINCE 0.5.0
 regex.myrepository.bug = \\b(Bug:)(\\s*[#]?|-){0,1}(\\d+)\\b!!!<a href="http://elsewhere/bug/$3">Bug-Id: $3</a>
 
 #
@@ -297,6 +334,7 @@
 #
 # SINCE 0.6.0
 mail.username =
+# SINCE 0.6.0
 mail.password =
 
 # from address for generated emails
@@ -304,8 +342,9 @@
 # SINCE 0.6.0
 mail.fromAddress = 
 
-# Space-separated list of email addresses for the Gitblit administrators
+# List of email addresses for the Gitblit administrators
 #
+# SPACE-DELIMITED
 # SINCE 0.6.0
 mail.adminAddresses = 
 
@@ -317,7 +356,30 @@
 #
 # *git.enableGitServlet* must be true to use this feature.
 
+# Your federation name is used for federation status acknowledgments.  If it is
+# unset, and you elect to send a status acknowledgment, your Gitblit instance
+# will be identified by its hostname, if available, else your internal ip address.
+# The source Gitblit instance will also append your external IP address to your
+# identification to differentiate multiple pulling systems behind a single proxy.
 #
+# SINCE 0.6.0
+federation.name =
+
+# Specify the passphrase of this Gitblit instance.
+#
+# An unspecified (empty) passphrase disables processing federation requests.
+#
+# This value can be anything you want: an integer, a sentence, an haiku, etc.
+# Keep the value simple, though, to avoid Java properties file encoding issues.
+#
+# Changing your passphrase will break any registrations you have established with other
+# Gitblit instances.
+#
+# CASE-SENSITIVE
+# SINCE 0.6.0
+# RESTART REQUIRED *(only to enable or disable federation)*
+federation.passphrase =
+
 # Control whether or not this Gitblit instance can receive federation proposals
 # from another Gitblit instance.  Registering a federated Gitblit is a manual
 # process.  Proposals help to simplify that process by allowing a remote Gitblit
@@ -337,29 +399,16 @@
 # SINCE 0.6.0
 federation.defaultFrequency = 60 mins
 
-# Specify the unique id of this Gitblit instance.
+# Federation Sets are named groups of repositories.  The Federation Sets are 
+# available for selection in the repository settings page.  You can assign a
+# repository to one or more sets and then distribute the token for the set.
+# This allows you to grant federation pull access to a subset of your available
+# repositories.  Tokens for federation sets only grant repository pull access.
 #
-# An unspecified (empty) uuid disables procesing federation requests.
-#
-# This value can be anything you want: an integer, a sentence, an haiku, etc.
-# Keep the value simple, though, to avoid Java properties file encoding issues.
-#
-# Changing your uuid will break any registrations you have established with other
-# Gitblit instances.
-#
+# SPACE-DELIMITED
 # CASE-SENSITIVE
 # SINCE 0.6.0
-# RESTART REQUIRED
-federation.uuid =
-
-# Your federation name is used for federation status acknowledgments.  If it is
-# unset, and you elect to send a status acknowledgment, your Gitblit instance
-# will be identified by its hostname, if available, else your internal ip address.
-# The source Gitblit instance will also append your external IP address to your
-# identification to differentiate multiple pulling systems behind a single proxy.
-#
-# SINCE 0.6.0
-federation.name = 
+federation.sets = 
 
 # Federation pull registrations
 # Registrations are read once, at startup.
@@ -370,11 +419,25 @@
 #   The shortest frequency allowed is every 5 minutes
 #   Decimal frequency values are cast to integers
 #   Frequency values may be specified in mins, hours, or days
-#   Values that can not be parsed default to *federation.defaultFrequency*
+#   Values that can not be parsed or are unspecified default to *federation.defaultFrequency*
 #
 # folder:
-#   if blank, the folder is *git.repositoriesFolder*
+#   if unspecified, the folder is *git.repositoriesFolder*
 #   if specified, the folder is relative to *git.repositoriesFolder*
+#
+# bare:
+#   if true, each repository will be created as a *bare* repository and will not
+#   have a working directory.
+#
+#   if false, each repository will be created as a normal repository suitable
+#   for local work.
+#
+# mirror:
+#   if true, each repository HEAD is reset to *origin/master* after each pull.
+#   The repository will be flagged *isFrozen* after the initial clone.
+#
+#   if false, each repository HEAD will point to the FETCH_HEAD of the initial
+#   clone from the origin until pushed to or otherwise manipulated.
 #
 # mergeAccounts:
 #   if true, remote accounts and their permissions are merged into your 
@@ -385,7 +448,7 @@
 #   notified by email of pull failures
 #
 # include and exclude:
-#   space-separated list of repositories to include or exclude from pull
+#   Space-delimited list of repositories to include or exclude from pull
 #   may be * wildcard to include or exclude all
 #   may use fuzzy match (e.g. org.eclipse.*)
 
@@ -396,7 +459,9 @@
 #federation.example1.url = https://go.gitblit.com
 #federation.example1.token = 6f3b8a24bf970f17289b234284c94f43eb42f0e4
 #federation.example1.frequency = 120 mins
-#federation.example1.folder = 
+#federation.example1.folder =
+#federation.example1.bare = true 
+#federation.example1.mirror = true 
 #federation.example1.mergeAccounts = true
 
 #
@@ -415,6 +480,13 @@
 # RESTART REQUIRED
 server.useNio = true
 
+# 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.
+#
+# SINCE 0.7.0
+# RESTART REQUIRED
+server.contextPath = /
+
 # Standard http port to serve.  <= 0 disables this connector.
 # On Unix/Linux systems, ports < 1024 require root permissions.
 # Recommended value: 80 or 8080

--
Gitblit v1.9.1