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