Documentation. Changed status RPC protection. Status tab for Manager.

James Moger

2011-10-25 486ee115abb831b2ec78be6777fb1bca9e931df0

 distrib/gitblit.properties

@@ -20,6 +20,10 @@
git.searchRepositoriesSubfolders = true



# 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://.

# If you set this false, consider changing the *web.otherUrls* setting to

# indicate your clone/push urls.

#

# SINCE 0.5.0

git.enableGitServlet = true

@@ -55,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

@@ -74,14 +80,34 @@
# SINCE 0.5.0

web.siteName =



# If web.authenticateAdminPages=true, users with "admin" role can create

# 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

# If *web.authenticateAdminPages*=false, any user can execute the aforementioned

# functions. 

#

# SINCE 0.5.0 

web.allowAdministration = true



# Allows remote clients to list repositories and possibly administer the Gitblit

# server, if the authenticated account has administrator permissions.

#

# SINCE 0.7.0 
web.enableRpcServlet = true



# Allows remote 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 remote clients to control the server settings of the 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.

#

@@ -93,7 +119,27 @@
# SINCE 0.5.0

web.syndicationEntries = 25



# This is the message display above the repositories table.

# Show the size of each repository on the repositories page.

# This requires recursive traversal of each repository folder.  This may be

# non-performant on some operating systems and/or filesystems. 
#

# SINCE 0.5.2

web.showRepositorySizes = true



# Show federation registrations (without token) and the current pull status

# to non-administrator users. 
#

# SINCE 0.6.0

web.showFederationRegistrations = false



# 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.

#

@@ -109,20 +155,39 @@
# RESTART REQUIRED

web.useClientTimezone = false



# Date and Time formats

# http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html

# Short date format

# <http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html>

#

# SINCE 0.5.0

web.datestampShortFormat = yyyy-MM-dd



# Long timestamp format

# <http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html>

#

# SINCE 0.5.0

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

# Mount URL parameters

# This setting controls if pretty or parameter URLs are used.

# i.e.

# if true:

#     http://localhost/commit/myrepo/abcdef

# if false:

#     http://localhost/commit/?r=myrepo&h=abcdef

#

# SINCE 0.5.0

# RESTART REQUIRED

web.mountParameters = true



# Some servlet containers (e.g. Tomcat >= 6.0.10) disallow '/' (%2F) encoding

# in URLs as a security precaution for proxies.  This setting tells Gitblit

# to preemptively replace '/' with '*' or '!' for url string parameters.

#

# <https://issues.apache.org/jira/browse/WICKET-1303>

# <http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10>

#

# SINCE 0.5.2

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.

@@ -190,22 +255,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



@@ -229,11 +298,170 @@
# 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>



#

# Mail Settings

# SINCE 0.6.0

#

# Mail settings are used to notify administrators of received federation proposals

#



# ip or hostname of smtp server

#

# SINCE 0.6.0

mail.server =



# port to use for smtp requests

#

# SINCE 0.6.0

mail.port = 25



# debug the mail executor

#

# SINCE 0.6.0

mail.debug = false



# if your smtp server requires authentication, supply the credentials here

#

# SINCE 0.6.0

mail.username =

# SINCE 0.6.0

mail.password =



# from address for generated emails

#

# SINCE 0.6.0

mail.fromAddress = 


# List of email addresses for the Gitblit administrators

#

# SPACE-DELIMITED

# SINCE 0.6.0

mail.adminAddresses = 


#

# Federation Settings

# SINCE 0.6.0

#

# A Gitblit federation is a way to backup one Gitblit instance to another.

#

# *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

# instance to send your Gitblit instance the federation pull data.

#

# SINCE 0.6.0

federation.allowProposals = false



# The destination folder for cached federation proposals.

# Use forward slashes even on Windows!!

#

# SINCE 0.6.0

federation.proposalsFolder = proposals



# The default pull frequency if frequency is unspecified on a registration

#

# SINCE 0.6.0

federation.defaultFrequency = 60 mins



# 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.

#

# SPACE-DELIMITED

# CASE-SENSITIVE

# SINCE 0.6.0

federation.sets = 


# Federation pull registrations

# Registrations are read once, at startup.

#

# RESTART REQUIRED

#

# frequency:

#   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 or are unspecified default to *federation.defaultFrequency*

#

# folder:

#   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 
#   users.properties file 
#

# notifyOnError:

#   if true and the mail configuration is properly set, administrators will be

#   notified by email of pull failures

#

# include and exclude:

#   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.*)



#

# (Nearly) Perfect Mirror example

#



#federation.example1.url = https://go.gitblit.com

#federation.example1.token = 6f3b8a24bf970f17289b234284c94f43eb42f0e4

#federation.example1.frequency = 120 mins

#federation.example1.folder =

#federation.example1.bare = true 
#federation.example1.mirror = true 
#federation.example1.mergeAccounts = true



#

# Server Settings

@@ -251,17 +479,28 @@
# 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

#

# SINCE 0.5.0

# RESTART REQUIRED

server.httpPort = 0



# Secure/SSL https port to serve. <= 0 disables this connector.

# On Unix/Linux systems, ports < 1024 require root permissions.

# Recommended value: 443 or 8443

#

# SINCE 0.5.0

# RESTART REQUIRED

server.httpsPort = 443

server.httpsPort = 8443



# Specify the interface for Jetty to bind the standard connector.

# You may specify an ip or an empty value to bind to all interfaces.