summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2010-06-22 14:15:48 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2010-06-22 14:15:48 (UTC)
commit37a24e4e39737edaa5cdde501346a65eeb280e63 (patch) (unidiff)
treeff23eb0d57edf108edd1aa3e64a8d6cf70062954 /cgitrc.5.txt
parent47187b33be1c3de43fbed6f350ab05bc978aacd0 (diff)
parenta2cbd3c30b64a26b52b2003ba6569f3c083f4092 (diff)
downloadcgit-37a24e4e39737edaa5cdde501346a65eeb280e63.zip
cgit-37a24e4e39737edaa5cdde501346a65eeb280e63.tar.gz
cgit-37a24e4e39737edaa5cdde501346a65eeb280e63.tar.bz2
Merge branch 'jh/path-limit'
Conflicts: cgit.h ui-commit.c
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 5c24381..a853522 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -351,182 +351,182 @@ repo.path::
351 An absolute path to the repository directory. For non-bare repositories 351 An absolute path to the repository directory. For non-bare repositories
352 this is the .git-directory. Default value: none. 352 this is the .git-directory. Default value: none.
353 353
354repo.readme:: 354repo.readme::
355 A path (relative to <repo.path>) which specifies a file to include 355 A path (relative to <repo.path>) which specifies a file to include
356 verbatim as the "About" page for this repo. Default value: none. 356 verbatim as the "About" page for this repo. Default value: none.
357 357
358repo.snapshots:: 358repo.snapshots::
359 A mask of allowed snapshot-formats for this repo, restricted by the 359 A mask of allowed snapshot-formats for this repo, restricted by the
360 "snapshots" global setting. Default value: <snapshots>. 360 "snapshots" global setting. Default value: <snapshots>.
361 361
362repo.section:: 362repo.section::
363 Override the current section name for this repository. Default value: 363 Override the current section name for this repository. Default value:
364 none. 364 none.
365 365
366repo.source-filter:: 366repo.source-filter::
367 Override the default source-filter. Default value: none. See also: 367 Override the default source-filter. Default value: none. See also:
368 "enable-filter-overrides". 368 "enable-filter-overrides".
369 369
370repo.url:: 370repo.url::
371 The relative url used to access the repository. This must be the first 371 The relative url used to access the repository. This must be the first
372 setting specified for each repo. Default value: none. 372 setting specified for each repo. Default value: none.
373 373
374 374
375REPOSITORY-SPECIFIC CGITRC FILE 375REPOSITORY-SPECIFIC CGITRC FILE
376------------------------------- 376-------------------------------
377When the option "scan-path" is used to auto-discover git repositories, cgit 377When the option "scan-path" is used to auto-discover git repositories, cgit
378will try to parse the file "cgitrc" within any found repository. Such a 378will try to parse the file "cgitrc" within any found repository. Such a
379repo-specific config file may contain any of the repo-specific options 379repo-specific config file may contain any of the repo-specific options
380described above, except "repo.url" and "repo.path". Additionally, the "filter" 380described above, except "repo.url" and "repo.path". Additionally, the "filter"
381options are only acknowledged in repo-specific config files when 381options are only acknowledged in repo-specific config files when
382"enable-filter-overrides" is set to "1". 382"enable-filter-overrides" is set to "1".
383 383
384Note: the "repo." prefix is dropped from the option names in repo-specific 384Note: the "repo." prefix is dropped from the option names in repo-specific
385config files, e.g. "repo.desc" becomes "desc". 385config files, e.g. "repo.desc" becomes "desc".
386 386
387 387
388EXAMPLE CGITRC FILE 388EXAMPLE CGITRC FILE
389------------------- 389-------------------
390 390
391.... 391....
392# Enable caching of up to 1000 output entriess 392# Enable caching of up to 1000 output entriess
393cache-size=1000 393cache-size=1000
394 394
395 395
396# Specify some default clone prefixes 396# Specify some default clone prefixes
397clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 397clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
398 398
399# Specify the css url 399# Specify the css url
400css=/css/cgit.css 400css=/css/cgit.css
401 401
402 402
403# Show extra links for each repository on the index page 403# Show extra links for each repository on the index page
404enable-index-links=1 404enable-index-links=1
405 405
406 406
407# Show number of affected files per commit on the log pages 407# Show number of affected files per commit on the log pages
408enable-log-filecount=1 408enable-log-filecount=1
409 409
410 410
411# Show number of added/removed lines per commit on the log pages 411# Show number of added/removed lines per commit on the log pages
412enable-log-linecount=1 412enable-log-linecount=1
413 413
414 414
415# Add a cgit favicon 415# Add a cgit favicon
416favicon=/favicon.ico 416favicon=/favicon.ico
417 417
418 418
419# Use a custom logo 419# Use a custom logo
420logo=/img/mylogo.png 420logo=/img/mylogo.png
421 421
422 422
423# Enable statistics per week, month and quarter 423# Enable statistics per week, month and quarter
424max-stats=quarter 424max-stats=quarter
425 425
426 426
427# Set the title and heading of the repository index page 427# Set the title and heading of the repository index page
428root-title=foobar.com git repositories 428root-title=foobar.com git repositories
429 429
430 430
431# Set a subheading for the repository index page 431# Set a subheading for the repository index page
432root-desc=tracking the foobar development 432root-desc=tracking the foobar development
433 433
434 434
435# Include some more info about foobar.com on the index page 435# Include some more info about foobar.com on the index page
436root-readme=/var/www/htdocs/about.html 436root-readme=/var/www/htdocs/about.html
437 437
438 438
439# Allow download of tar.gz, tar.bz2 and zip-files 439# Allow download of tar.gz, tar.bz2 and zip-files
440snapshots=tar.gz tar.bz2 zip 440snapshots=tar.gz tar.bz2 zip
441 441
442 442
443## 443##
444## List of common mimetypes 444## List of common mimetypes
445## 445##
446 446
447mimetype.git=image/git 447mimetype.gif=image/gif
448mimetype.html=text/html 448mimetype.html=text/html
449mimetype.jpg=image/jpeg 449mimetype.jpg=image/jpeg
450mimetype.jpeg=image/jpeg 450mimetype.jpeg=image/jpeg
451mimetype.pdf=application/pdf 451mimetype.pdf=application/pdf
452mimetype.png=image/png 452mimetype.png=image/png
453mimetype.svg=image/svg+xml 453mimetype.svg=image/svg+xml
454 454
455 455
456## 456##
457## List of repositories. 457## List of repositories.
458## PS: Any repositories listed when section is unset will not be 458## PS: Any repositories listed when section is unset will not be
459## displayed under a section heading 459## displayed under a section heading
460## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 460## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
461## and included like this: 461## and included like this:
462## include=/etc/cgitrepos 462## include=/etc/cgitrepos
463## 463##
464 464
465 465
466repo.url=foo 466repo.url=foo
467repo.path=/pub/git/foo.git 467repo.path=/pub/git/foo.git
468repo.desc=the master foo repository 468repo.desc=the master foo repository
469repo.owner=fooman@foobar.com 469repo.owner=fooman@foobar.com
470repo.readme=info/web/about.html 470repo.readme=info/web/about.html
471 471
472 472
473repo.url=bar 473repo.url=bar
474repo.path=/pub/git/bar.git 474repo.path=/pub/git/bar.git
475repo.desc=the bars for your foo 475repo.desc=the bars for your foo
476repo.owner=barman@foobar.com 476repo.owner=barman@foobar.com
477repo.readme=info/web/about.html 477repo.readme=info/web/about.html
478 478
479 479
480# The next repositories will be displayed under the 'extras' heading 480# The next repositories will be displayed under the 'extras' heading
481section=extras 481section=extras
482 482
483 483
484repo.url=baz 484repo.url=baz
485repo.path=/pub/git/baz.git 485repo.path=/pub/git/baz.git
486repo.desc=a set of extensions for bar users 486repo.desc=a set of extensions for bar users
487 487
488repo.url=wiz 488repo.url=wiz
489repo.path=/pub/git/wiz.git 489repo.path=/pub/git/wiz.git
490repo.desc=the wizard of foo 490repo.desc=the wizard of foo
491 491
492 492
493# Add some mirrored repositories 493# Add some mirrored repositories
494section=mirrors 494section=mirrors
495 495
496 496
497repo.url=git 497repo.url=git
498repo.path=/pub/git/git.git 498repo.path=/pub/git/git.git
499repo.desc=the dscm 499repo.desc=the dscm
500 500
501 501
502repo.url=linux 502repo.url=linux
503repo.path=/pub/git/linux.git 503repo.path=/pub/git/linux.git
504repo.desc=the kernel 504repo.desc=the kernel
505 505
506# Disable adhoc downloads of this repo 506# Disable adhoc downloads of this repo
507repo.snapshots=0 507repo.snapshots=0
508 508
509# Disable line-counts for this repo 509# Disable line-counts for this repo
510repo.enable-log-linecount=0 510repo.enable-log-linecount=0
511 511
512# Restrict the max statistics period for this repo 512# Restrict the max statistics period for this repo
513repo.max-stats=month 513repo.max-stats=month
514.... 514....
515 515
516 516
517BUGS 517BUGS
518---- 518----
519Comments currently cannot appear on the same line as a setting; the comment 519Comments currently cannot appear on the same line as a setting; the comment
520will be included as part of the value. E.g. this line: 520will be included as part of the value. E.g. this line:
521 521
522 robots=index # allow indexing 522 robots=index # allow indexing
523 523
524will generate the following html element: 524will generate the following html element:
525 525
526 <meta name='robots' content='index # allow indexing'/> 526 <meta name='robots' content='index # allow indexing'/>
527 527
528 528
529 529
530AUTHOR 530AUTHOR
531------ 531------
532Lars Hjemli <hjemli@gmail.com> 532Lars Hjemli <hjemli@gmail.com>