summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 75b6584..b45c46b 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -45,97 +45,102 @@ cache-root::
45 "/var/cache/cgit". 45 "/var/cache/cgit".
46 46
47cache-dynamic-ttl:: 47cache-dynamic-ttl::
48 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed without a fixed SHA1. Default 49 version of repository pages accessed without a fixed SHA1. Default
50 value: "5". 50 value: "5".
51 51
52cache-repo-ttl:: 52cache-repo-ttl::
53 Number which specifies the time-to-live, in minutes, for the cached 53 Number which specifies the time-to-live, in minutes, for the cached
54 version of the repository summary page. Default value: "5". 54 version of the repository summary page. Default value: "5".
55 55
56cache-root-ttl:: 56cache-root-ttl::
57 Number which specifies the time-to-live, in minutes, for the cached 57 Number which specifies the time-to-live, in minutes, for the cached
58 version of the repository index page. Default value: "5". 58 version of the repository index page. Default value: "5".
59 59
60cache-scanrc-ttl:: 60cache-scanrc-ttl::
61 Number which specifies the time-to-live, in minutes, for the result 61 Number which specifies the time-to-live, in minutes, for the result
62 of scanning a path for git repositories. Default value: "15". 62 of scanning a path for git repositories. Default value: "15".
63 63
64cache-size:: 64cache-size::
65 The maximum number of entries in the cgit cache. Default value: "0" 65 The maximum number of entries in the cgit cache. Default value: "0"
66 (i.e. caching is disabled). 66 (i.e. caching is disabled).
67 67
68cache-static-ttl:: 68cache-static-ttl::
69 Number which specifies the time-to-live, in minutes, for the cached 69 Number which specifies the time-to-live, in minutes, for the cached
70 version of repository pages accessed with a fixed SHA1. Default value: 70 version of repository pages accessed with a fixed SHA1. Default value:
71 "5". 71 "5".
72 72
73clone-prefix:: 73clone-prefix::
74 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
76 setting is only used if `repo.clone-url` is unspecified. Default value: 76 setting is only used if `repo.clone-url` is unspecified. Default value:
77 none. 77 none.
78 78
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
82 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-commit-graph::
95 Flag which, when set to "1", will make cgit print an ASCII-art commit
96 history graph to the left of the commit messages in the repository
97 log page. Default value: "0".
98
94enable-filter-overrides:: 99enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 100 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 101 overridden in repository-specific cgitrc files. Default value: none.
97 102
98enable-gitweb-owner:: 103enable-gitweb-owner::
99 If set to "1" and scan-path is enabled, we first check each repository 104 If set to "1" and scan-path is enabled, we first check each repository
100 for the git config value "gitweb.owner" to determine the owner. 105 for the git config value "gitweb.owner" to determine the owner.
101 Default value: "1". See also: scan-path. 106 Default value: "1". See also: scan-path.
102 107
103enable-index-links:: 108enable-index-links::
104 Flag which, when set to "1", will make cgit generate extra links for 109 Flag which, when set to "1", will make cgit generate extra links for
105 each repo in the repository index (specifically, to the "summary", 110 each repo in the repository index (specifically, to the "summary",
106 "commit" and "tree" pages). Default value: "0". 111 "commit" and "tree" pages). Default value: "0".
107 112
108enable-log-filecount:: 113enable-log-filecount::
109 Flag which, when set to "1", will make cgit print the number of 114 Flag which, when set to "1", will make cgit print the number of
110 modified files for each commit on the repository log page. Default 115 modified files for each commit on the repository log page. Default
111 value: "0". 116 value: "0".
112 117
113enable-log-linecount:: 118enable-log-linecount::
114 Flag which, when set to "1", will make cgit print the number of added 119 Flag which, when set to "1", will make cgit print the number of added
115 and removed lines for each commit on the repository log page. Default 120 and removed lines for each commit on the repository log page. Default
116 value: "0". 121 value: "0".
117 122
118enable-remote-branches:: 123enable-remote-branches::
119 Flag which, when set to "1", will make cgit display remote branches 124 Flag which, when set to "1", will make cgit display remote branches
120 in the summary and refs views. Default value: "0". See also: 125 in the summary and refs views. Default value: "0". See also:
121 "repo.enable-remote-branches". 126 "repo.enable-remote-branches".
122 127
123enable-subject-links:: 128enable-subject-links::
124 Flag which, when set to "1", will make cgit use the subject of the 129 Flag which, when set to "1", will make cgit use the subject of the
125 parent commit as link text when generating links to parent commits 130 parent commit as link text when generating links to parent commits
126 in commit view. Default value: "0". See also: 131 in commit view. Default value: "0". See also:
127 "repo.enable-subject-links". 132 "repo.enable-subject-links".
128 133
129enable-tree-linenumbers:: 134enable-tree-linenumbers::
130 Flag which, when set to "1", will make cgit generate linenumber links 135 Flag which, when set to "1", will make cgit generate linenumber links
131 for plaintext blobs printed in the tree view. Default value: "1". 136 for plaintext blobs printed in the tree view. Default value: "1".
132 137
133favicon:: 138favicon::
134 Url used as link to a shortcut icon for cgit. If specified, it is 139 Url used as link to a shortcut icon for cgit. If specified, it is
135 suggested to use the value "/favicon.ico" since certain browsers will 140 suggested to use the value "/favicon.ico" since certain browsers will
136 ignore other values. Default value: none. 141 ignore other values. Default value: none.
137 142
138footer:: 143footer::
139 The content of the file specified with this option will be included 144 The content of the file specified with this option will be included
140 verbatim at the bottom of all pages (i.e. it replaces the standard 145 verbatim at the bottom of all pages (i.e. it replaces the standard
141 "generated by..." message. Default value: none. 146 "generated by..." message. Default value: none.
@@ -309,183 +314,191 @@ summary-branches::
309 Specifies the number of branches to display in the repository "summary" 314 Specifies the number of branches to display in the repository "summary"
310 view. Default value: "10". 315 view. Default value: "10".
311 316
312summary-log:: 317summary-log::
313 Specifies the number of log entries to display in the repository 318 Specifies the number of log entries to display in the repository
314 "summary" view. Default value: "10". 319 "summary" view. Default value: "10".
315 320
316summary-tags:: 321summary-tags::
317 Specifies the number of tags to display in the repository "summary" 322 Specifies the number of tags to display in the repository "summary"
318 view. Default value: "10". 323 view. Default value: "10".
319 324
320strict-export:: 325strict-export::
321 Filename which, if specified, needs to be present within the repository 326 Filename which, if specified, needs to be present within the repository
322 for cgit to allow access to that repository. This can be used to emulate 327 for cgit to allow access to that repository. This can be used to emulate
323 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's 328 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
324 repositories to match those exported by git-daemon. This option MUST come 329 repositories to match those exported by git-daemon. This option MUST come
325 before 'scan-path'. 330 before 'scan-path'.
326 331
327virtual-root:: 332virtual-root::
328 Url which, if specified, will be used as root for all cgit links. It 333 Url which, if specified, will be used as root for all cgit links. It
329 will also cause cgit to generate 'virtual urls', i.e. urls like 334 will also cause cgit to generate 'virtual urls', i.e. urls like
330 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 335 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
331 value: none. 336 value: none.
332 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 337 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
333 same kind of virtual urls, so this option will probably be deprecated. 338 same kind of virtual urls, so this option will probably be deprecated.
334 339
335REPOSITORY SETTINGS 340REPOSITORY SETTINGS
336------------------- 341-------------------
337repo.about-filter:: 342repo.about-filter::
338 Override the default about-filter. Default value: none. See also: 343 Override the default about-filter. Default value: none. See also:
339 "enable-filter-overrides". 344 "enable-filter-overrides".
340 345
341repo.clone-url:: 346repo.clone-url::
342 A list of space-separated urls which can be used to clone this repo. 347 A list of space-separated urls which can be used to clone this repo.
343 Default value: none. 348 Default value: none.
344 349
345repo.commit-filter:: 350repo.commit-filter::
346 Override the default commit-filter. Default value: none. See also: 351 Override the default commit-filter. Default value: none. See also:
347 "enable-filter-overrides". 352 "enable-filter-overrides".
348 353
349repo.defbranch:: 354repo.defbranch::
350 The name of the default branch for this repository. If no such branch 355 The name of the default branch for this repository. If no such branch
351 exists in the repository, the first branch name (when sorted) is used 356 exists in the repository, the first branch name (when sorted) is used
352 as default instead. Default value: "master". 357 as default instead. Default value: "master".
353 358
354repo.desc:: 359repo.desc::
355 The value to show as repository description. Default value: none. 360 The value to show as repository description. Default value: none.
356 361
362repo.enable-commit-graph::
363 A flag which can be used to disable the global setting
364 `enable-commit-graph'. Default value: none.
365
357repo.enable-log-filecount:: 366repo.enable-log-filecount::
358 A flag which can be used to disable the global setting 367 A flag which can be used to disable the global setting
359 `enable-log-filecount'. Default value: none. 368 `enable-log-filecount'. Default value: none.
360 369
361repo.enable-log-linecount:: 370repo.enable-log-linecount::
362 A flag which can be used to disable the global setting 371 A flag which can be used to disable the global setting
363 `enable-log-linecount'. Default value: none. 372 `enable-log-linecount'. Default value: none.
364 373
365repo.enable-remote-branches:: 374repo.enable-remote-branches::
366 Flag which, when set to "1", will make cgit display remote branches 375 Flag which, when set to "1", will make cgit display remote branches
367 in the summary and refs views. Default value: <enable-remote-branches>. 376 in the summary and refs views. Default value: <enable-remote-branches>.
368 377
369repo.enable-subject-links:: 378repo.enable-subject-links::
370 A flag which can be used to override the global setting 379 A flag which can be used to override the global setting
371 `enable-subject-links'. Default value: none. 380 `enable-subject-links'. Default value: none.
372 381
373repo.max-stats:: 382repo.max-stats::
374 Override the default maximum statistics period. Valid values are equal 383 Override the default maximum statistics period. Valid values are equal
375 to the values specified for the global "max-stats" setting. Default 384 to the values specified for the global "max-stats" setting. Default
376 value: none. 385 value: none.
377 386
378repo.name:: 387repo.name::
379 The value to show as repository name. Default value: <repo.url>. 388 The value to show as repository name. Default value: <repo.url>.
380 389
381repo.owner:: 390repo.owner::
382 A value used to identify the owner of the repository. Default value: 391 A value used to identify the owner of the repository. Default value:
383 none. 392 none.
384 393
385repo.path:: 394repo.path::
386 An absolute path to the repository directory. For non-bare repositories 395 An absolute path to the repository directory. For non-bare repositories
387 this is the .git-directory. Default value: none. 396 this is the .git-directory. Default value: none.
388 397
389repo.readme:: 398repo.readme::
390 A path (relative to <repo.path>) which specifies a file to include 399 A path (relative to <repo.path>) which specifies a file to include
391 verbatim as the "About" page for this repo. You may also specify a 400 verbatim as the "About" page for this repo. You may also specify a
392 git refspec by head or by hash by prepending the refspec followed by 401 git refspec by head or by hash by prepending the refspec followed by
393 a colon. For example, "master:docs/readme.mkd" Default value: <readme>. 402 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
394 403
395repo.snapshots:: 404repo.snapshots::
396 A mask of allowed snapshot-formats for this repo, restricted by the 405 A mask of allowed snapshot-formats for this repo, restricted by the
397 "snapshots" global setting. Default value: <snapshots>. 406 "snapshots" global setting. Default value: <snapshots>.
398 407
399repo.section:: 408repo.section::
400 Override the current section name for this repository. Default value: 409 Override the current section name for this repository. Default value:
401 none. 410 none.
402 411
403repo.source-filter:: 412repo.source-filter::
404 Override the default source-filter. Default value: none. See also: 413 Override the default source-filter. Default value: none. See also:
405 "enable-filter-overrides". 414 "enable-filter-overrides".
406 415
407repo.url:: 416repo.url::
408 The relative url used to access the repository. This must be the first 417 The relative url used to access the repository. This must be the first
409 setting specified for each repo. Default value: none. 418 setting specified for each repo. Default value: none.
410 419
411 420
412REPOSITORY-SPECIFIC CGITRC FILE 421REPOSITORY-SPECIFIC CGITRC FILE
413------------------------------- 422-------------------------------
414When the option "scan-path" is used to auto-discover git repositories, cgit 423When the option "scan-path" is used to auto-discover git repositories, cgit
415will try to parse the file "cgitrc" within any found repository. Such a 424will try to parse the file "cgitrc" within any found repository. Such a
416repo-specific config file may contain any of the repo-specific options 425repo-specific config file may contain any of the repo-specific options
417described above, except "repo.url" and "repo.path". Additionally, the "filter" 426described above, except "repo.url" and "repo.path". Additionally, the "filter"
418options are only acknowledged in repo-specific config files when 427options are only acknowledged in repo-specific config files when
419"enable-filter-overrides" is set to "1". 428"enable-filter-overrides" is set to "1".
420 429
421Note: the "repo." prefix is dropped from the option names in repo-specific 430Note: the "repo." prefix is dropped from the option names in repo-specific
422config files, e.g. "repo.desc" becomes "desc". 431config files, e.g. "repo.desc" becomes "desc".
423 432
424 433
425EXAMPLE CGITRC FILE 434EXAMPLE CGITRC FILE
426------------------- 435-------------------
427 436
428.... 437....
429# Enable caching of up to 1000 output entriess 438# Enable caching of up to 1000 output entriess
430cache-size=1000 439cache-size=1000
431 440
432 441
433# Specify some default clone prefixes 442# Specify some default clone prefixes
434clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 443clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
435 444
436# Specify the css url 445# Specify the css url
437css=/css/cgit.css 446css=/css/cgit.css
438 447
439 448
440# Show extra links for each repository on the index page 449# Show extra links for each repository on the index page
441enable-index-links=1 450enable-index-links=1
442 451
443 452
453# Enable ASCII art commit history graph on the log pages
454enable-commit-graph=1
455
456
444# Show number of affected files per commit on the log pages 457# Show number of affected files per commit on the log pages
445enable-log-filecount=1 458enable-log-filecount=1
446 459
447 460
448# Show number of added/removed lines per commit on the log pages 461# Show number of added/removed lines per commit on the log pages
449enable-log-linecount=1 462enable-log-linecount=1
450 463
451 464
452# Add a cgit favicon 465# Add a cgit favicon
453favicon=/favicon.ico 466favicon=/favicon.ico
454 467
455 468
456# Use a custom logo 469# Use a custom logo
457logo=/img/mylogo.png 470logo=/img/mylogo.png
458 471
459 472
460# Enable statistics per week, month and quarter 473# Enable statistics per week, month and quarter
461max-stats=quarter 474max-stats=quarter
462 475
463 476
464# Set the title and heading of the repository index page 477# Set the title and heading of the repository index page
465root-title=foobar.com git repositories 478root-title=foobar.com git repositories
466 479
467 480
468# Set a subheading for the repository index page 481# Set a subheading for the repository index page
469root-desc=tracking the foobar development 482root-desc=tracking the foobar development
470 483
471 484
472# Include some more info about foobar.com on the index page 485# Include some more info about foobar.com on the index page
473root-readme=/var/www/htdocs/about.html 486root-readme=/var/www/htdocs/about.html
474 487
475 488
476# Allow download of tar.gz, tar.bz2 and zip-files 489# Allow download of tar.gz, tar.bz2 and zip-files
477snapshots=tar.gz tar.bz2 zip 490snapshots=tar.gz tar.bz2 zip
478 491
479 492
480## 493##
481## List of common mimetypes 494## List of common mimetypes
482## 495##
483 496
484mimetype.gif=image/gif 497mimetype.gif=image/gif
485mimetype.html=text/html 498mimetype.html=text/html
486mimetype.jpg=image/jpeg 499mimetype.jpg=image/jpeg
487mimetype.jpeg=image/jpeg 500mimetype.jpeg=image/jpeg
488mimetype.pdf=application/pdf 501mimetype.pdf=application/pdf
489mimetype.png=image/png 502mimetype.png=image/png
490mimetype.svg=image/svg+xml 503mimetype.svg=image/svg+xml
491 504