]> source.dussan.org Git - gitblit.git/commitdiff
Documentation. Established convention for documenting settings.
authorJames Moger <james.moger@gitblit.com>
Fri, 1 Jul 2011 21:42:02 +0000 (17:42 -0400)
committerJames Moger <james.moger@gitblit.com>
Fri, 1 Jul 2011 21:42:02 +0000 (17:42 -0400)
distrib/gitblit.properties

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