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 1dc3cce..a832830 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -69,49 +69,54 @@ cache-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
@@ -341,48 +346,52 @@ virtual-root::
341 same kind of virtual urls, so this option will probably be deprecated. 346 same kind of virtual urls, so this option will probably be deprecated.
342 347
343REPOSITORY SETTINGS 348REPOSITORY SETTINGS
344------------------- 349-------------------
345repo.about-filter:: 350repo.about-filter::
346 Override the default about-filter. Default value: none. See also: 351 Override the default about-filter. Default value: none. See also:
347 "enable-filter-overrides". 352 "enable-filter-overrides".
348 353
349repo.clone-url:: 354repo.clone-url::
350 A list of space-separated urls which can be used to clone this repo. 355 A list of space-separated urls which can be used to clone this repo.
351 Default value: none. 356 Default value: none.
352 357
353repo.commit-filter:: 358repo.commit-filter::
354 Override the default commit-filter. Default value: none. See also: 359 Override the default commit-filter. Default value: none. See also:
355 "enable-filter-overrides". 360 "enable-filter-overrides".
356 361
357repo.defbranch:: 362repo.defbranch::
358 The name of the default branch for this repository. If no such branch 363 The name of the default branch for this repository. If no such branch
359 exists in the repository, the first branch name (when sorted) is used 364 exists in the repository, the first branch name (when sorted) is used
360 as default instead. Default value: "master". 365 as default instead. Default value: "master".
361 366
362repo.desc:: 367repo.desc::
363 The value to show as repository description. Default value: none. 368 The value to show as repository description. Default value: none.
364 369
370repo.enable-commit-graph::
371 A flag which can be used to disable the global setting
372 `enable-commit-graph'. Default value: none.
373
365repo.enable-log-filecount:: 374repo.enable-log-filecount::
366 A flag which can be used to disable the global setting 375 A flag which can be used to disable the global setting
367 `enable-log-filecount'. Default value: none. 376 `enable-log-filecount'. Default value: none.
368 377
369repo.enable-log-linecount:: 378repo.enable-log-linecount::
370 A flag which can be used to disable the global setting 379 A flag which can be used to disable the global setting
371 `enable-log-linecount'. Default value: none. 380 `enable-log-linecount'. Default value: none.
372 381
373repo.enable-remote-branches:: 382repo.enable-remote-branches::
374 Flag which, when set to "1", will make cgit display remote branches 383 Flag which, when set to "1", will make cgit display remote branches
375 in the summary and refs views. Default value: <enable-remote-branches>. 384 in the summary and refs views. Default value: <enable-remote-branches>.
376 385
377repo.enable-subject-links:: 386repo.enable-subject-links::
378 A flag which can be used to override the global setting 387 A flag which can be used to override the global setting
379 `enable-subject-links'. Default value: none. 388 `enable-subject-links'. Default value: none.
380 389
381repo.max-stats:: 390repo.max-stats::
382 Override the default maximum statistics period. Valid values are equal 391 Override the default maximum statistics period. Valid values are equal
383 to the values specified for the global "max-stats" setting. Default 392 to the values specified for the global "max-stats" setting. Default
384 value: none. 393 value: none.
385 394
386repo.name:: 395repo.name::
387 The value to show as repository name. Default value: <repo.url>. 396 The value to show as repository name. Default value: <repo.url>.
388 397
@@ -428,48 +437,52 @@ options are only acknowledged in repo-specific config files when
428 437
429Note: the "repo." prefix is dropped from the option names in repo-specific 438Note: the "repo." prefix is dropped from the option names in repo-specific
430config files, e.g. "repo.desc" becomes "desc". 439config files, e.g. "repo.desc" becomes "desc".
431 440
432 441
433EXAMPLE CGITRC FILE 442EXAMPLE CGITRC FILE
434------------------- 443-------------------
435 444
436.... 445....
437# Enable caching of up to 1000 output entriess 446# Enable caching of up to 1000 output entriess
438cache-size=1000 447cache-size=1000
439 448
440 449
441# Specify some default clone prefixes 450# Specify some default clone prefixes
442clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git 451clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
443 452
444# Specify the css url 453# Specify the css url
445css=/css/cgit.css 454css=/css/cgit.css
446 455
447 456
448# Show extra links for each repository on the index page 457# Show extra links for each repository on the index page
449enable-index-links=1 458enable-index-links=1
450 459
451 460
461# Enable ASCII art commit history graph on the log pages
462enable-commit-graph=1
463
464
452# Show number of affected files per commit on the log pages 465# Show number of affected files per commit on the log pages
453enable-log-filecount=1 466enable-log-filecount=1
454 467
455 468
456# Show number of added/removed lines per commit on the log pages 469# Show number of added/removed lines per commit on the log pages
457enable-log-linecount=1 470enable-log-linecount=1
458 471
459 472
460# Add a cgit favicon 473# Add a cgit favicon
461favicon=/favicon.ico 474favicon=/favicon.ico
462 475
463 476
464# Use a custom logo 477# Use a custom logo
465logo=/img/mylogo.png 478logo=/img/mylogo.png
466 479
467 480
468# Enable statistics per week, month and quarter 481# Enable statistics per week, month and quarter
469max-stats=quarter 482max-stats=quarter
470 483
471 484
472# Set the title and heading of the repository index page 485# Set the title and heading of the repository index page
473root-title=example.com git repositories 486root-title=example.com git repositories
474 487
475 488