summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index e7f1a78..0c13485 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -331,171 +331,171 @@ repo.snapshots::
331repo.section:: 331repo.section::
332 Override the current section name for this repository. Default value: 332 Override the current section name for this repository. Default value:
333 none. 333 none.
334 334
335repo.source-filter:: 335repo.source-filter::
336 Override the default source-filter. Default value: none. See also: 336 Override the default source-filter. Default value: none. See also:
337 "enable-filter-overrides". 337 "enable-filter-overrides".
338 338
339repo.url:: 339repo.url::
340 The relative url used to access the repository. This must be the first 340 The relative url used to access the repository. This must be the first
341 setting specified for each repo. Default value: none. 341 setting specified for each repo. Default value: none.
342 342
343 343
344REPOSITORY-SPECIFIC CGITRC FILE 344REPOSITORY-SPECIFIC CGITRC FILE
345------------------------------- 345-------------------------------
346When the option "scan-path" is used to auto-discover git repositories, cgit 346When the option "scan-path" is used to auto-discover git repositories, cgit
347will try to parse the file "cgitrc" within any found repository. Such a 347will try to parse the file "cgitrc" within any found repository. Such a
348repo-specific config file may contain any of the repo-specific options 348repo-specific config file may contain any of the repo-specific options
349described above, except "repo.url" and "repo.path". Additionally, the "filter" 349described above, except "repo.url" and "repo.path". Additionally, the "filter"
350options are only acknowledged in repo-specific config files when 350options are only acknowledged in repo-specific config files when
351"enable-filter-overrides" is set to "1". 351"enable-filter-overrides" is set to "1".
352 352
353Note: the "repo." prefix is dropped from the option names in repo-specific 353Note: the "repo." prefix is dropped from the option names in repo-specific
354config files, e.g. "repo.desc" becomes "desc". 354config files, e.g. "repo.desc" becomes "desc".
355 355
356 356
357EXAMPLE CGITRC FILE 357EXAMPLE CGITRC FILE
358------------------- 358-------------------
359 359
360.... 360....
361# Enable caching of up to 1000 output entriess 361# Enable caching of up to 1000 output entriess
362cache-size=1000 362cache-size=1000
363 363
364 364
365# Specify some default clone prefixes 365# Specify some default clone prefixes
366clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 366clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
367 367
368# Specify the css url 368# Specify the css url
369css=/css/cgit.css 369css=/css/cgit.css
370 370
371 371
372# Show extra links for each repository on the index page 372# Show extra links for each repository on the index page
373enable-index-links=1 373enable-index-links=1
374 374
375 375
376# Show number of affected files per commit on the log pages 376# Show number of affected files per commit on the log pages
377enable-log-filecount=1 377enable-log-filecount=1
378 378
379 379
380# Show number of added/removed lines per commit on the log pages 380# Show number of added/removed lines per commit on the log pages
381enable-log-linecount=1 381enable-log-linecount=1
382 382
383 383
384# Add a cgit favicon 384# Add a cgit favicon
385favicon=/favicon.ico 385favicon=/favicon.ico
386 386
387 387
388# Use a custom logo 388# Use a custom logo
389logo=/img/mylogo.png 389logo=/img/mylogo.png
390 390
391 391
392# Enable statistics per week, month and quarter 392# Enable statistics per week, month and quarter
393max-stats=quarter 393max-stats=quarter
394 394
395 395
396# Set the title and heading of the repository index page 396# Set the title and heading of the repository index page
397root-title=foobar.com git repositories 397root-title=foobar.com git repositories
398 398
399 399
400# Set a subheading for the repository index page 400# Set a subheading for the repository index page
401root-desc=tracking the foobar development 401root-desc=tracking the foobar development
402 402
403 403
404# Include some more info about foobar.com on the index page 404# Include some more info about foobar.com on the index page
405root-readme=/var/www/htdocs/about.html 405root-readme=/var/www/htdocs/about.html
406 406
407 407
408# Allow download of tar.gz, tar.bz2 and zip-files 408# Allow download of tar.gz, tar.bz2 and zip-files
409snapshots=tar.gz tar.bz2 zip 409snapshots=tar.gz tar.bz2 zip
410 410
411 411
412## 412##
413## List of common mimetypes 413## List of common mimetypes
414## 414##
415 415
416mimetype.git=image/git 416mimetype.git=image/git
417mimetype.html=text/html 417mimetype.html=text/html
418mimetype.jpg=image/jpeg 418mimetype.jpg=image/jpeg
419mimetype.jpeg=image/jpeg 419mimetype.jpeg=image/jpeg
420mimetype.pdf=application/pdf 420mimetype.pdf=application/pdf
421mimetype.png=image/png 421mimetype.png=image/png
422mimetype.svg=image/svg+xml 422mimetype.svg=image/svg+xml
423 423
424 424
425## 425##
426## List of repositories. 426## List of repositories.
427## PS: Any repositories listed when repo.group is unset will not be 427## PS: Any repositories listed when section is unset will not be
428## displayed under a group heading 428## displayed under a section heading
429## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 429## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
430## and included like this: 430## and included like this:
431## include=/etc/cgitrepos 431## include=/etc/cgitrepos
432## 432##
433 433
434 434
435repo.url=foo 435repo.url=foo
436repo.path=/pub/git/foo.git 436repo.path=/pub/git/foo.git
437repo.desc=the master foo repository 437repo.desc=the master foo repository
438repo.owner=fooman@foobar.com 438repo.owner=fooman@foobar.com
439repo.readme=info/web/about.html 439repo.readme=info/web/about.html
440 440
441 441
442repo.url=bar 442repo.url=bar
443repo.path=/pub/git/bar.git 443repo.path=/pub/git/bar.git
444repo.desc=the bars for your foo 444repo.desc=the bars for your foo
445repo.owner=barman@foobar.com 445repo.owner=barman@foobar.com
446repo.readme=info/web/about.html 446repo.readme=info/web/about.html
447 447
448 448
449# The next repositories will be displayed under the 'extras' heading 449# The next repositories will be displayed under the 'extras' heading
450repo.group=extras 450section=extras
451 451
452 452
453repo.url=baz 453repo.url=baz
454repo.path=/pub/git/baz.git 454repo.path=/pub/git/baz.git
455repo.desc=a set of extensions for bar users 455repo.desc=a set of extensions for bar users
456 456
457repo.url=wiz 457repo.url=wiz
458repo.path=/pub/git/wiz.git 458repo.path=/pub/git/wiz.git
459repo.desc=the wizard of foo 459repo.desc=the wizard of foo
460 460
461 461
462# Add some mirrored repositories 462# Add some mirrored repositories
463repo.group=mirrors 463section=mirrors
464 464
465 465
466repo.url=git 466repo.url=git
467repo.path=/pub/git/git.git 467repo.path=/pub/git/git.git
468repo.desc=the dscm 468repo.desc=the dscm
469 469
470 470
471repo.url=linux 471repo.url=linux
472repo.path=/pub/git/linux.git 472repo.path=/pub/git/linux.git
473repo.desc=the kernel 473repo.desc=the kernel
474 474
475# Disable adhoc downloads of this repo 475# Disable adhoc downloads of this repo
476repo.snapshots=0 476repo.snapshots=0
477 477
478# Disable line-counts for this repo 478# Disable line-counts for this repo
479repo.enable-log-linecount=0 479repo.enable-log-linecount=0
480 480
481# Restrict the max statistics period for this repo 481# Restrict the max statistics period for this repo
482repo.max-stats=month 482repo.max-stats=month
483.... 483....
484 484
485 485
486BUGS 486BUGS
487---- 487----
488Comments currently cannot appear on the same line as a setting; the comment 488Comments currently cannot appear on the same line as a setting; the comment
489will be included as part of the value. E.g. this line: 489will be included as part of the value. E.g. this line:
490 490
491 robots=index # allow indexing 491 robots=index # allow indexing
492 492
493will generate the following html element: 493will generate the following html element:
494 494
495 <meta name='robots' content='index # allow indexing'/> 495 <meta name='robots' content='index # allow indexing'/>
496 496
497 497
498 498
499AUTHOR 499AUTHOR
500------ 500------
501Lars Hjemli <hjemli@gmail.com> 501Lars Hjemli <hjemli@gmail.com>