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