From b2ef5a6b0f5d5f78b334296aa9dfdde7571083e6 Mon Sep 17 00:00:00 2001
From: Kyle Gottfried <kgottfried@eotech.com>
Date: Tue, 01 Jul 2014 09:25:23 -0400
Subject: [PATCH] Refine web.canonicalUrl documentation
---
src/main/distrib/data/gitblit.properties | 117 ++++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 88 insertions(+), 29 deletions(-)
diff --git a/src/main/distrib/data/gitblit.properties b/src/main/distrib/data/gitblit.properties
index c7e3a21..d8ddc28 100644
--- a/src/main/distrib/data/gitblit.properties
+++ b/src/main/distrib/data/gitblit.properties
@@ -126,10 +126,14 @@
# SSH backend NIO2|MINA.
#
+# The Apache Mina project recommends using the NIO2 backend.
+#
# SINCE 1.5.0
git.sshBackend = NIO2
-# Number of thread for starting SSH commands.
+# Number of threads used to parse a command line submitted by a client over SSH
+# for execution, create the internal data structures used by that command,
+# and schedule it for execution on another thread.
#
# SINCE 1.5.0
git.sshCommandStartThreads = 2
@@ -266,6 +270,11 @@
#
# SINCE 1.4.0
git.createRepositoriesShared = false
+
+# Directory for gitignore templates used during repository creation.
+#
+# SINCE 1.6.0
+git.gitignoreFolder = ${baseFolder}/gitignore
# Enable JGit-based garbage collection. (!!EXPERIMENTAL!!)
#
@@ -481,6 +490,45 @@
# RESTART REQUIRED
git.packedGitMmap = false
+# Validate all received (pushed) objects are valid.
+#
+# SINCE 1.5.0
+git.checkReceivedObjects = true
+
+# Validate all referenced but not supplied objects are reachable.
+#
+# If enabled, Gitblit will verify that references to objects not contained
+# within the received pack are already reachable through at least one other
+# reference advertised to clients.
+#
+# This feature is useful when Gitblit doesn't trust the client to not provide a
+# forged SHA-1 reference to an object, in an attempt to access parts of the DAG
+# that they aren't allowed to see and which have been hidden from them via the
+# configured AdvertiseRefsHook or RefFilter.
+#
+# Enabling this feature may imply at least some, if not all, of the same functionality
+# performed by git.checkReceivedObjects.
+#
+# SINCE 1.5.0
+git.checkReferencedObjectsAreReachable = true
+
+# Set the maximum allowed Git object size.
+#
+# If an object is larger than the given size the pack-parsing will throw an exception
+# aborting the receive-pack operation. The default value, 0, disables maximum
+# object size checking.
+#
+# SINCE 1.5.0
+git.maxObjectSizeLimit = 0
+
+# Set the maximum allowed pack size.
+#
+# A pack exceeding this size will be rejected. The default value, -1, disables
+# maximum pack size checking.
+#
+# SINCE 1.5.0
+git.maxPackSizeLimit = -1
+
# Use the Gitblit patch receive pack for processing contributions and tickets.
# This allows the user to push a patch using the familiar Gerrit syntax:
#
@@ -568,7 +616,13 @@
# The registry of available plugins.
#
# SINCE 1.5.0
-plugins.registry = http://gitblit.github.io/gitblit-registry/plugins.json
+plugins.registry = http://plugins.gitblit.com/plugins.json
+
+# Number of threads used to handle miscellaneous tasks in the background.
+#
+# SINCE 1.6.0
+# RESTART REQUIRED
+execution.defaultThreadPoolSize = 1
#
# Groovy Integration
@@ -723,6 +777,16 @@
# SINCE 0.5.0
web.allowCookieAuthentication = true
+# Allow deletion of non-empty repositories. This is enforced for all delete vectors.
+#
+# SINCE 1.6.0
+web.allowDeletingNonEmptyRepositories = true
+
+# Setting to include personal repositories in the main repositories list.
+#
+# SINCE 1.6.0
+web.includePersonalRepositories = false
+
# Config file for storing project metadata
#
# SINCE 1.2.0
@@ -780,8 +844,18 @@
# SINCE 0.5.0
web.siteName =
-# The canonical url of your Gitblit server to bs used in email notifications.
-# e.g. web.canonicalUrl = https://demo-gitblit.rhcloud.com
+# The canonical url of your Gitblit server to be used in repository url generation,
+# RSS feeds, and all embedded links in email and plugin-based notifications.
+#
+# If you are running Gitblit on a non-standard http port (i.e. not 80 and not 443)
+# then you must specify that port in this url otherwise your generated urls will be
+# incorrect.
+#
+# The hostname of this url will be extracted for SSH and GIT protocol repository
+# url generation.
+#
+# e.g. web.canonicalUrl = https://dev.gitblit.com
+# web.canonicalUrl = https://dev.gitblit.com:8443
#
# SINCE 1.4.0
web.canonicalUrl =
@@ -1367,6 +1441,11 @@
# use SMTPs flag
mail.smtps = false
+# use STARTTLS flag
+#
+# SINCE 1.6.0
+mail.starttls = false
+
# if your smtp server requires authentication, supply the credentials here
#
# SINCE 0.6.0
@@ -1736,7 +1815,8 @@
realm.redmine.url = http://example.com/redmine
#
-# Server Settings
+# Gitblit GO Server Settings
+# The following settings only affect the integrated GO variant.
#
# The temporary folder to decompress the embedded gitblit webapp.
@@ -1746,13 +1826,9 @@
# BASEFOLDER
server.tempFolder = ${baseFolder}/temp
-# Use Jetty NIO connectors. If false, Jetty Socket connectors will be used.
-#
-# SINCE 0.5.0
-# RESTART REQUIRED
-server.useNio = true
-
-# Specify the maximum number of concurrent http/https worker threads to allow.
+# Specify the maximum number of concurrent http/https Jetty worker
+# threads to allow. This setting does not affect other threaded
+# daemons and components of Gitblit.
#
# SINCE 1.3.0
# RESTART REQUIRED
@@ -1781,14 +1857,6 @@
# RESTART REQUIRED
server.httpsPort = 8443
-# Port for serving an Apache JServ Protocol (AJP) 1.3 connector for integrating
-# Gitblit GO into an Apache HTTP server setup. <= 0 disables this connector.
-# Recommended value: 8009
-#
-# SINCE 0.9.0
-# RESTART REQUIRED
-server.ajpPort = 0
-
# Automatically redirect http requests to the secure https connector.
#
# This setting requires that you have configured server.httpPort and server.httpsPort.
@@ -1816,15 +1884,6 @@
# SINCE 0.5.0
# RESTART REQUIRED
server.httpsBindInterface =
-
-# Specify the interface for Jetty to bind the AJP 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.9.0
-# RESTART REQUIRED
-server.ajpBindInterface = localhost
# Alias of certificate to use for https/SSL serving. If blank the first
# certificate found in the keystore will be used.
--
Gitblit v1.9.1