From 373a964ce5b9107db243ff13dfd19a934cd7be49 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 01 Jul 2011 17:42:02 -0400
Subject: [PATCH] Documentation. Established convention for documenting settings.

---
 distrib/gitblit.properties |  162 +++++++++++++++++++++++++++++++++++++++++++----------
 1 files changed, 130 insertions(+), 32 deletions(-)

diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index 6adf11e..37fdd34 100644
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -2,13 +2,12 @@
 # Git Servlet Settings
 #
 
-# Allow push/pull over http/https with JGit servlet.
-git.enableGitServlet = true
-
 # Base folder for repositories
-# Changing this value requires a server restart.
 # Use forward slashes even on Windows!!
 # e.g. c:/gitrepos
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 git.repositoriesFolder = git
 
 # Search the repositories folder subfolders for other repositories.
@@ -16,135 +15,215 @@
 # but they may be grouped together in subfolders.
 # e.g. c:/gitrepos/libraries/mylibrary.git
 #      c:/gitrepos/libraries/myotherlibrary.git
+#
+# SINCE 0.5.0
 git.searchRepositoriesSubfolders = true
+
+# Allow push/pull over http/https with JGit servlet.
+#
+# SINCE 0.5.0
+git.enableGitServlet = true
 
 #
 # Authentication Settings
 #
 
 # Require authentication to see everything but the admin pages
-# Changing this value requires a server restart.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 web.authenticateViewPages = false
 
 # Require admin authentication for the admin functions and pages
-# Changing this value requires a server restart.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 web.authenticateAdminPages = true
 
-# Either a simple user realm file to authenticate users
-# OR a fully qualified class name that implements the ILoginService interface.
+# Allow Gitblit to store a cookie in the user's browser for automatic
+# authentication.  The cookie is generated by the user service.
+#
+# SINCE 0.5.0
+web.allowCookieAuthentication = true
+
+# Either the path to a simple user properties file
+# OR a fully qualified class name that implements the IUserService interface.
 # Any custom implementation must have a public default constructor.
-# Changing this value requires a server restart.
-realm.realmFile = users.properties
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
+realm.userService = users.properties
 
 # How to store passwords.
-# Valid values are plain or md5.  Default is md5. 
+# Valid values are plain or md5.  Default is md5.
+#
+# SINCE 0.5.0 
 realm.passwordStorage = md5
 
 # Minimum valid length for a plain text password.
-# Default value is 5.  Absolute minimum is 4. 
+# Default value is 5.  Absolute minimum is 4.
+#
+# SINCE 0.5.0 
 realm.minPasswordLength = 5
 
 #
 # Gitblit Web Settings
 #
 # If blank Gitblit is displayed.
+#
+# SINCE 0.5.0
 web.siteName =
 
 # If web.authenticateAdminPages=true, users with "admin" role can create
 # repositories, create users, and edit repository metadata.
 #
 # If web.authenticateAdminPages=false, any user can execute the aforementioned
-# functions.  
+# functions. 
+#
+# SINCE 0.5.0 
 web.allowAdministration = true
 
-# Allow dyanamic zip downloads.   
+# Allow dynamic zip downloads.
+#
+# SINCE 0.5.0   
 web.allowZipDownloads = true
 
-# Default number of entries to include in RSS/Atom Syndication links
+# Default number of entries to include in RSS Syndication links
+#
+# SINCE 0.5.0
 web.syndicationEntries = 25
 
 # This is the message display above the repositories table.
 # This can point to a file with Markdown content.
 # Specifying "gitblit" uses the internal welcome message.
+#
+# SINCE 0.5.0
 web.repositoriesMessage = gitblit
 
 # Use the client timezone when formatting dates.
-# This uses AJAX to determine the browser's timezone.
-# Changing this value requires a server restart.
+# This uses AJAX to determine the browser's timezone and may require more
+# server overhead because a Wicket session is created.  All Gitblit pages
+# attempt to be stateless, if possible.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 web.useClientTimezone = false
 
 # Date and Time formats
 # http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
+#
+# SINCE 0.5.0
 web.datestampShortFormat = yyyy-MM-dd
 web.datetimestampLongFormat = EEEE, MMMM d, yyyy h:mm a z
+
+# Mount parameters
+# true: http://localhost/commit/myrepo/abcdef
+# false: http://localhost/commit/?r=myrepo&h=abcdef
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
+web.mountParameters = true
 
 # 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.
 # e.g.
 # web.otherUrls = ssh://localhost/git/{0} git://localhost/git/{0}
+#
+# SINCE 0.5.0
 web.otherUrls = 
 
 # Choose how to present the repositories list.
 #   grouped = group nested/subfolder repositories together (no sorting)
 #   flat = flat list of repositories (sorting allowed)
+#
+# SINCE 0.5.0
 web.repositoryListType = grouped
 
 # If using a grouped repository list and there are repositories at the
 # root level of your repositories folder, you may specify the displayed
 # group name with this setting.  This value is only used for web presentation.
+#
+# SINCE 0.5.0
 web.repositoryRootGroupName = main
 
 # Choose the diff presentation style: gitblt, gitweb, or plain
+#
+# SINCE 0.5.0
 web.diffStyle = gitblit
 
 # Control if email addresses are shown in web ui
+#
+# SINCE 0.5.0
 web.showEmailAddresses = true
 
 # Shows a combobox in the page links header with commit, committer, and author
 # search selection.  Default search is commit.
+#
+# SINCE 0.5.0
 web.showSearchTypeSelection = false
 
 # Generates a line graph of repository activity over time on the Summary page.
-# This uses the Google Charts API. 
+# This uses the Google Charts API.
+#
+# SINCE 0.5.0 
 web.generateActivityGraph = true
 
 # The number of commits to display on the summary page
 # Value must exceed 0 else default of 20 is used
+#
+# SINCE 0.5.0
 web.summaryCommitCount = 16
 
-# The number of tags/heads to display on the summary page
-# Value must exceed 0 else default of 5 is used
+# The number of tags/branches to display on the summary page.
+# -1 = all tags/branches
+# 0 = hide tags/branches
+# N = N tags/branches
+#
+# SINCE 0.5.0
 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.
+#
+# SINCE 0.5.0
 web.itemsPerPage = 50
 
 # Registered extensions for google-code-prettify
-# (case-insensitive)
+#
+# 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
-# (CASE-SENSITIVE)
+#
+# CASE-SENSITIVE
+# SINCE 0.5.0
 web.markdownExtensions = md mkd markdown MD MKD
 
 # Image extensions
-# (case-insensitive)
+#
+# SINCE 0.5.0
 web.imageExtensions = bmp jpg gif png 
 
 # Registered extensions for binary blobs
-# (case-insensitive)
+#
+# SINCE 0.5.0
 web.binaryExtensions = jar pdf tar.gz zip
 
 # Aggressive heap management will run the garbage collector on every generated
 # page.  This slows down page generation a little but improves heap consumption. 
-web.aggressiveHeapManagement = true
+#
+# SINCE 0.5.0
+web.aggressiveHeapManagement = false
 
 # Run the webapp in debug mode
-# Changing this value requires a server restart.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 web.debugMode = false
 
 # Enable/disable global regex substitutions (i.e. shared across repositories)
+#
+# SINCE 0.5.0
 regex.global = true
 
 # Example global regex substitutions
@@ -159,41 +238,60 @@
 #
 # Server Settings
 #
-# Changing any of these values requires a server restart.
 
-# The temporary folder to decompress the gitblit webapp. 
+# The temporary folder to decompress the embedded gitblit webapp. 
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.tempFolder = temp
 
-#
-# Jetty Settings
-#
-
 # Use Jetty NIO connectors.  If false, Jetty Socket connectors will be used.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.useNio = true
 
 # Standard http port to serve.  <= 0 disables this connector.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.httpPort = 0
 
 # Secure/SSL https port to serve. <= 0 disables this connector.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.httpsPort = 443
 
 # 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
 # localhost.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.httpBindInterface = localhost
 
 # Specify the interface for Jetty to bind the secure 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.5.0
+# RESTART REQUIRED
 server.httpsBindInterface = 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
 # using the --storePassword command line parameter.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.storePassword = gitblit
 
 # Port for shutdown monitor to listen on.
+#
+# SINCE 0.5.0
+# RESTART REQUIRED
 server.shutdownPort = 8081

--
Gitblit v1.9.1