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