James Moger
2011-09-30 8c5d72248c20fc78c7b2c1d4388d073affccad20
commit | author | age
f98825 1 #
JM 2 # Git Servlet Settings
3 #
4
5 # Base folder for repositories
6 # Use forward slashes even on Windows!!
1f9dae 7 # e.g. c:/gitrepos
373a96 8 #
JM 9 # SINCE 0.5.0
10 # RESTART REQUIRED
2a7306 11 git.repositoriesFolder = git
f98825 12
a125cf 13 # Search the repositories folder subfolders for other repositories.
JM 14 # Repositories MAY NOT be nested (i.e. one repository within another)
15 # but they may be grouped together in subfolders.
1f9dae 16 # e.g. c:/gitrepos/libraries/mylibrary.git
a125cf 17 #      c:/gitrepos/libraries/myotherlibrary.git
373a96 18 #
JM 19 # SINCE 0.5.0
a125cf 20 git.searchRepositoriesSubfolders = true
f98825 21
85c2e6 22 # Allow push/pull over http/https with JGit servlet.
ed21d2 23 # If you do NOT want to allow Git clients to clone/push to Gitblit set this
JM 24 # to false.  You might want to do this if you are only using ssh:// or git://.
a3f474 25 # If you set this false, consider changing the *web.otherUrls* setting to
ed21d2 26 # indicate your clone/push urls.
373a96 27 #
JM 28 # SINCE 0.5.0
85c2e6 29 git.enableGitServlet = true
JM 30
f98825 31 #
JM 32 # Authentication Settings
33 #
34
35 # Require authentication to see everything but the admin pages
373a96 36 #
JM 37 # SINCE 0.5.0
38 # RESTART REQUIRED
f98825 39 web.authenticateViewPages = false
JM 40
41 # Require admin authentication for the admin functions and pages
373a96 42 #
JM 43 # SINCE 0.5.0
44 # RESTART REQUIRED
f98825 45 web.authenticateAdminPages = true
JM 46
85c2e6 47 # Allow Gitblit to store a cookie in the user's browser for automatic
JM 48 # authentication.  The cookie is generated by the user service.
373a96 49 #
JM 50 # SINCE 0.5.0
85c2e6 51 web.allowCookieAuthentication = true
JM 52
53 # Either the path to a simple user properties file
54 # OR a fully qualified class name that implements the IUserService interface.
5450d0 55 # Any custom implementation must have a public default constructor.
373a96 56 #
JM 57 # SINCE 0.5.0
58 # RESTART REQUIRED
85c2e6 59 realm.userService = users.properties
f98825 60
JM 61 # How to store passwords.
373a96 62 # Valid values are plain or md5.  Default is md5.
JM 63 #
64 # SINCE 0.5.0 
f98825 65 realm.passwordStorage = md5
JM 66
a098da 67 # Minimum valid length for a plain text password.
373a96 68 # Default value is 5.  Absolute minimum is 4.
JM 69 #
70 # SINCE 0.5.0 
a098da 71 realm.minPasswordLength = 5
JM 72
f98825 73 #
f13c4c 74 # Gitblit Web Settings
f98825 75 #
f13c4c 76 # If blank Gitblit is displayed.
373a96 77 #
JM 78 # SINCE 0.5.0
f98825 79 web.siteName =
JM 80
a3f474 81 # If *web.authenticateAdminPages*=true, users with "admin" role can create
1f9dae 82 # repositories, create users, and edit repository metadata.
f98825 83 #
a3f474 84 # If *web.authenticateAdminPages*=false, any user can execute the aforementioned
373a96 85 # functions. 
JM 86 #
87 # SINCE 0.5.0 
f98825 88 web.allowAdministration = true
JM 89
373a96 90 # Allow dynamic zip downloads.
JM 91 #
92 # SINCE 0.5.0   
9197d3 93 web.allowZipDownloads = true
JM 94
85c2e6 95 # Default number of entries to include in RSS Syndication links
373a96 96 #
JM 97 # SINCE 0.5.0
c22722 98 web.syndicationEntries = 25
JM 99
5c2841 100 # Show the size of each repository on the repositories page.
JM 101 # This requires recursive traversal of each repository folder.  This may be
102 # non-performant on some operating systems and/or filesystems. 
103 #
104 # SINCE 0.5.2
105 web.showRepositorySizes = true
106
831469 107 # Show federation registrations (without token) and the current pull status
JM 108 # to non-administrator users. 
109 #
110 # SINCE 0.6.0
111 web.showFederationRegistrations = false
112
8c5d72 113 # This is the message displayed when *web.authenticateViewPages=true*.
JM 114 # This can point to a file with Markdown content.
115 # Specifying "gitblit" uses the internal login message.
116 #
117 # SINCE 0.6.1
118 web.loginMessage = gitblit
119
120 # This is the message displayed above the repositories table.
f98825 121 # This can point to a file with Markdown content.
JM 122 # Specifying "gitblit" uses the internal welcome message.
373a96 123 #
JM 124 # SINCE 0.5.0
f98825 125 web.repositoriesMessage = gitblit
JM 126
127 # Use the client timezone when formatting dates.
85c2e6 128 # This uses AJAX to determine the browser's timezone and may require more
JM 129 # server overhead because a Wicket session is created.  All Gitblit pages
130 # attempt to be stateless, if possible.
373a96 131 #
JM 132 # SINCE 0.5.0
133 # RESTART REQUIRED
f98825 134 web.useClientTimezone = false
JM 135
a3f474 136 # Short date format
JM 137 # <http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html>
373a96 138 #
JM 139 # SINCE 0.5.0
f98825 140 web.datestampShortFormat = yyyy-MM-dd
a3f474 141
JM 142 # Long timestamp format
143 # <http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html>
144 #
145 # SINCE 0.5.0
f98825 146 web.datetimestampLongFormat = EEEE, MMMM d, yyyy h:mm a z
JM 147
a3f474 148 # Mount URL parameters
JM 149 # This setting controls if pretty or parameter URLs are used.
150 # i.e.
7e5ee5 151 # if true:
JM 152 #     http://localhost/commit/myrepo/abcdef
153 # if false:
154 #     http://localhost/commit/?r=myrepo&h=abcdef
373a96 155 #
JM 156 # SINCE 0.5.0
157 # RESTART REQUIRED
b01ca0 158 web.mountParameters = true
JM 159
7e5ee5 160 # Some servlet containers (e.g. Tomcat >= 6.0.10) disallow '/' (%2F) encoding
JM 161 # in URLs as a security precaution for proxies.  This setting tells Gitblit
162 # to preemptively replace '/' with '*' or '!' for url string parameters.
163 #
164 # <https://issues.apache.org/jira/browse/WICKET-1303>
165 # <http://tomcat.apache.org/security-6.html>
166 #
167 # SINCE 0.5.2
168 web.forwardSlashCharacter = /
169
17c417 170 # Show other URLs on the summary page for accessing your git repositories
JM 171 # Use spaces to separate urls. {0} is the token for the repository name.
1f9dae 172 # e.g.
17c417 173 # web.otherUrls = ssh://localhost/git/{0} git://localhost/git/{0}
373a96 174 #
JM 175 # SINCE 0.5.0
17c417 176 web.otherUrls = 
JM 177
00afd7 178 # Choose how to present the repositories list.
1f9dae 179 #   grouped = group nested/subfolder repositories together (no sorting)
JM 180 #   flat = flat list of repositories (sorting allowed)
373a96 181 #
JM 182 # SINCE 0.5.0
a4d249 183 web.repositoryListType = grouped
00afd7 184
JM 185 # If using a grouped repository list and there are repositories at the
186 # root level of your repositories folder, you may specify the displayed
187 # group name with this setting.  This value is only used for web presentation.
373a96 188 #
JM 189 # SINCE 0.5.0
00afd7 190 web.repositoryRootGroupName = main
JM 191
f98825 192 # Choose the diff presentation style: gitblt, gitweb, or plain
373a96 193 #
JM 194 # SINCE 0.5.0
f98825 195 web.diffStyle = gitblit
JM 196
197 # Control if email addresses are shown in web ui
373a96 198 #
JM 199 # SINCE 0.5.0
f98825 200 web.showEmailAddresses = true
JM 201
202 # Shows a combobox in the page links header with commit, committer, and author
203 # search selection.  Default search is commit.
373a96 204 #
JM 205 # SINCE 0.5.0
f98825 206 web.showSearchTypeSelection = false
JM 207
208 # Generates a line graph of repository activity over time on the Summary page.
373a96 209 # This uses the Google Charts API.
JM 210 #
211 # SINCE 0.5.0 
f98825 212 web.generateActivityGraph = true
JM 213
214 # The number of commits to display on the summary page
215 # Value must exceed 0 else default of 20 is used
373a96 216 #
JM 217 # SINCE 0.5.0
f98825 218 web.summaryCommitCount = 16
JM 219
85c2e6 220 # The number of tags/branches to display on the summary page.
JM 221 # -1 = all tags/branches
222 # 0 = hide tags/branches
223 # N = N tags/branches
373a96 224 #
JM 225 # SINCE 0.5.0
f98825 226 web.summaryRefsCount = 5
JM 227
228 # The number of items to show on a page before showing the first, prev, next
229 # pagination links.  A default if 50 is used for any invalid value.
373a96 230 #
JM 231 # SINCE 0.5.0
f98825 232 web.itemsPerPage = 50
JM 233
234 # Registered extensions for google-code-prettify
373a96 235 #
8f73a7 236 # SPACE-DELIMITED
373a96 237 # SINCE 0.5.0
f98825 238 web.prettyPrintExtensions = c cpp cs css htm html java js php pl prefs properties py rb sh sql xml vb
JM 239
240 # Registered extensions for markdown transformation
373a96 241 #
8f73a7 242 # SPACE-DELIMITED
373a96 243 # CASE-SENSITIVE
JM 244 # SINCE 0.5.0
1f9dae 245 web.markdownExtensions = md mkd markdown MD MKD
f98825 246
JM 247 # Image extensions
373a96 248 #
8f73a7 249 # SPACE-DELIMITED
373a96 250 # SINCE 0.5.0
f98825 251 web.imageExtensions = bmp jpg gif png 
JM 252
253 # Registered extensions for binary blobs
373a96 254 #
8f73a7 255 # SPACE-DELIMITED
373a96 256 # SINCE 0.5.0
f98825 257 web.binaryExtensions = jar pdf tar.gz zip
JM 258
259 # Aggressive heap management will run the garbage collector on every generated
1f9dae 260 # page.  This slows down page generation a little but improves heap consumption. 
373a96 261 #
JM 262 # SINCE 0.5.0
85c2e6 263 web.aggressiveHeapManagement = false
f98825 264
JM 265 # Run the webapp in debug mode
373a96 266 #
JM 267 # SINCE 0.5.0
268 # RESTART REQUIRED
f98825 269 web.debugMode = false
JM 270
271 # Enable/disable global regex substitutions (i.e. shared across repositories)
373a96 272 #
JM 273 # SINCE 0.5.0
f98825 274 regex.global = true
JM 275
276 # Example global regex substitutions
277 # Use !!! to separate the search pattern and the replace pattern
278 # searchpattern!!!replacepattern
5450d0 279 regex.global.bug = \\b(Bug:)(\\s*[#]?|-){0,1}(\\d+)\\b!!!<a href="http://somehost/bug/$3">Bug-Id: $3</a>
JM 280 regex.global.changeid = \\b(Change-Id:\\s*)([A-Za-z0-9]*)\\b!!!<a href="http://somehost/changeid/$2">Change-Id: $2</a>
f98825 281
JM 282 # Example per-repository regex substitutions overrides global
5450d0 283 regex.myrepository.bug = \\b(Bug:)(\\s*[#]?|-){0,1}(\\d+)\\b!!!<a href="http://elsewhere/bug/$3">Bug-Id: $3</a>
f98825 284
JM 285 #
831469 286 # Mail Settings
JM 287 # SINCE 0.6.0
288 #
289 # Mail settings are used to notify administrators of received federation proposals
290 #
291
292 # ip or hostname of smtp server
293 #
294 # SINCE 0.6.0
295 mail.server =
296
297 # port to use for smtp requests
298 #
299 # SINCE 0.6.0
300 mail.port = 25
301
302 # debug the mail executor
303 #
304 # SINCE 0.6.0
305 mail.debug = false
306
307 # if your smtp server requires authentication, supply the credentials here
308 #
309 # SINCE 0.6.0
310 mail.username =
311 mail.password =
312
313 # from address for generated emails
314 #
315 # SINCE 0.6.0
316 mail.fromAddress = 
317
8f73a7 318 # List of email addresses for the Gitblit administrators
831469 319 #
8f73a7 320 # SPACE-DELIMITED
831469 321 # SINCE 0.6.0
JM 322 mail.adminAddresses = 
323
324 #
325 # Federation Settings
326 # SINCE 0.6.0
327 #
328 # A Gitblit federation is a way to backup one Gitblit instance to another.
329 #
330 # *git.enableGitServlet* must be true to use this feature.
331
2c32fd 332 # Your federation name is used for federation status acknowledgments.  If it is
JM 333 # unset, and you elect to send a status acknowledgment, your Gitblit instance
334 # will be identified by its hostname, if available, else your internal ip address.
335 # The source Gitblit instance will also append your external IP address to your
336 # identification to differentiate multiple pulling systems behind a single proxy.
831469 337 #
2c32fd 338 # SINCE 0.6.0
JM 339 federation.name =
340
341 # Specify the passphrase of this Gitblit instance.
342 #
343 # An unspecified (empty) passphrase disables processing federation requests.
344 #
345 # This value can be anything you want: an integer, a sentence, an haiku, etc.
346 # Keep the value simple, though, to avoid Java properties file encoding issues.
347 #
348 # Changing your passphrase will break any registrations you have established with other
349 # Gitblit instances.
350 #
351 # CASE-SENSITIVE
352 # SINCE 0.6.0
8f73a7 353 # RESTART REQUIRED *(only to enable or disable federation)*
2c32fd 354 federation.passphrase =
JM 355
831469 356 # Control whether or not this Gitblit instance can receive federation proposals
JM 357 # from another Gitblit instance.  Registering a federated Gitblit is a manual
358 # process.  Proposals help to simplify that process by allowing a remote Gitblit
359 # instance to send your Gitblit instance the federation pull data.
360 #
361 # SINCE 0.6.0
362 federation.allowProposals = false
363
364 # The destination folder for cached federation proposals.
365 # Use forward slashes even on Windows!!
366 #
367 # SINCE 0.6.0
368 federation.proposalsFolder = proposals
369
370 # The default pull frequency if frequency is unspecified on a registration
371 #
372 # SINCE 0.6.0
373 federation.defaultFrequency = 60 mins
374
8f73a7 375 # Federation Sets are named groups of repositories.  The Federation Sets are 
JM 376 # available for selection in the repository settings page.  You can assign a
377 # repository to one or more sets and then distribute the token for the set.
378 # This allows you to grant federation pull access to a subset of your available
379 # repositories.  Tokens for federation sets only grant repository pull access.
380 #
381 # SPACE-DELIMITED
382 # CASE-SENSITIVE
383 # SINCE 0.6.0
384 federation.sets = 
385
831469 386 # Federation pull registrations
JM 387 # Registrations are read once, at startup.
388 #
389 # RESTART REQUIRED
390 #
391 # frequency:
392 #   The shortest frequency allowed is every 5 minutes
393 #   Decimal frequency values are cast to integers
394 #   Frequency values may be specified in mins, hours, or days
8f73a7 395 #   Values that can not be parsed or are unspecified default to *federation.defaultFrequency*
831469 396 #
JM 397 # folder:
8f73a7 398 #   if unspecified, the folder is *git.repositoriesFolder*
831469 399 #   if specified, the folder is relative to *git.repositoriesFolder*
JM 400 #
b083f5 401 # bare:
JM 402 #   if true, each repository will be created as a *bare* repository and will not
403 #   have a working directory.
404 #
405 #   if false, each repository will be created as a normal repository suitable
406 #   for local work.
407 #
2548a7 408 # mirror:
JM 409 #   if true, each repository HEAD is reset to *origin/master* after each pull.
410 #   The repository will be flagged *isFrozen* after the initial clone.
411 #
412 #   if false, each repository HEAD will point to the FETCH_HEAD of the initial
413 #   clone from the origin until pushed to or otherwise manipulated.
414 #
831469 415 # mergeAccounts:
JM 416 #   if true, remote accounts and their permissions are merged into your 
417 #   users.properties file 
418 #
419 # notifyOnError:
420 #   if true and the mail configuration is properly set, administrators will be
421 #   notified by email of pull failures
422 #
423 # include and exclude:
8f73a7 424 #   Space-delimited list of repositories to include or exclude from pull
831469 425 #   may be * wildcard to include or exclude all
JM 426 #   may use fuzzy match (e.g. org.eclipse.*)
427
428 #
429 # (Nearly) Perfect Mirror example
430 #
431
432 #federation.example1.url = https://go.gitblit.com
433 #federation.example1.token = 6f3b8a24bf970f17289b234284c94f43eb42f0e4
434 #federation.example1.frequency = 120 mins
2548a7 435 #federation.example1.folder =
f6740d 436 #federation.example1.bare = true 
2548a7 437 #federation.example1.mirror = true 
831469 438 #federation.example1.mergeAccounts = true
JM 439
440 #
f98825 441 # Server Settings
JM 442 #
1f9dae 443
373a96 444 # The temporary folder to decompress the embedded gitblit webapp. 
JM 445 #
446 # SINCE 0.5.0
447 # RESTART REQUIRED
f98825 448 server.tempFolder = temp
JM 449
450 # Use Jetty NIO connectors.  If false, Jetty Socket connectors will be used.
373a96 451 #
JM 452 # SINCE 0.5.0
453 # RESTART REQUIRED
f98825 454 server.useNio = true
JM 455
456 # Standard http port to serve.  <= 0 disables this connector.
18422e 457 # On Unix/Linux systems, ports < 1024 require root permissions.
JM 458 # Recommended value: 80 or 8080
373a96 459 #
JM 460 # SINCE 0.5.0
461 # RESTART REQUIRED
f98825 462 server.httpPort = 0
JM 463
464 # Secure/SSL https port to serve. <= 0 disables this connector.
18422e 465 # On Unix/Linux systems, ports < 1024 require root permissions.
JM 466 # Recommended value: 443 or 8443
373a96 467 #
JM 468 # SINCE 0.5.0
469 # RESTART REQUIRED
18422e 470 server.httpsPort = 8443
f98825 471
JM 472 # Specify the interface for Jetty to bind the standard connector.
dd7961 473 # You may specify an ip or an empty value to bind to all interfaces.
1f9dae 474 # Specifying localhost will result in Gitblit ONLY listening to requests to
dd7961 475 # localhost.
373a96 476 #
JM 477 # SINCE 0.5.0
478 # RESTART REQUIRED
f98825 479 server.httpBindInterface = localhost
JM 480
481 # Specify the interface for Jetty to bind the secure connector.
482 # You may specify an ip or an empty value to bind to all interfaces.
1f9dae 483 # Specifying localhost will result in Gitblit ONLY listening to requests to
dd7961 484 # localhost.
373a96 485 #
JM 486 # SINCE 0.5.0
487 # RESTART REQUIRED
f98825 488 server.httpsBindInterface = localhost
JM 489
490 # Password for SSL keystore.
491 # Keystore password and certificate password must match.
492 # This is provided for convenience, its probably more secure to set this value
493 # using the --storePassword command line parameter.
373a96 494 #
JM 495 # SINCE 0.5.0
496 # RESTART REQUIRED
1f9dae 497 server.storePassword = gitblit
f98825 498
JM 499 # Port for shutdown monitor to listen on.
373a96 500 #
JM 501 # SINCE 0.5.0
502 # RESTART REQUIRED
f98825 503 server.shutdownPort = 8081