aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--cgitrc.5.txt176
1 files changed, 88 insertions, 88 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index acfae91..f6f6502 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -54,14 +54,10 @@ branch-sort::
54 list, and when set to "name" enables ordering by branch name. Default 54 list, and when set to "name" enables ordering by branch name. Default
55 value: "name". 55 value: "name".
56 56
57cache-root:: 57cache-about-ttl::
58 Path used to store the cgit cache entries. Default value:
59 "/var/cache/cgit". See also: "MACRO EXPANSION".
60
61cache-static-ttl::
62 Number which specifies the time-to-live, in minutes, for the cached 58 Number which specifies the time-to-live, in minutes, for the cached
63 version of repository pages accessed with a fixed SHA1. See also: 59 version of the repository about page. See also: "CACHE". Default
64 "CACHE". Default value: -1". 60 value: "15".
65 61
66cache-dynamic-ttl:: 62cache-dynamic-ttl::
67 Number which specifies the time-to-live, in minutes, for the cached 63 Number which specifies the time-to-live, in minutes, for the cached
@@ -73,6 +69,10 @@ cache-repo-ttl::
73 version of the repository summary page. See also: "CACHE". Default 69 version of the repository summary page. See also: "CACHE". Default
74 value: "5". 70 value: "5".
75 71
72cache-root::
73 Path used to store the cgit cache entries. Default value:
74 "/var/cache/cgit". See also: "MACRO EXPANSION".
75
76cache-root-ttl:: 76cache-root-ttl::
77 Number which specifies the time-to-live, in minutes, for the cached 77 Number which specifies the time-to-live, in minutes, for the cached
78 version of the repository index page. See also: "CACHE". Default 78 version of the repository index page. See also: "CACHE". Default
@@ -83,22 +83,22 @@ cache-scanrc-ttl::
83 of scanning a path for git repositories. See also: "CACHE". Default 83 of scanning a path for git repositories. See also: "CACHE". Default
84 value: "15". 84 value: "15".
85 85
86cache-about-ttl:: 86case-sensitive-sort::
87 Number which specifies the time-to-live, in minutes, for the cached 87 Sort items in the repo list case sensitively. Default value: "1".
88 version of the repository about page. See also: "CACHE". Default 88 See also: repository-sort, section-sort.
89 value: "15".
90
91cache-snapshot-ttl::
92 Number which specifies the time-to-live, in minutes, for the cached
93 version of snapshots. See also: "CACHE". Default value: "5".
94 89
95cache-size:: 90cache-size::
96 The maximum number of entries in the cgit cache. When set to "0", 91 The maximum number of entries in the cgit cache. When set to "0",
97 caching is disabled. See also: "CACHE". Default value: "0" 92 caching is disabled. See also: "CACHE". Default value: "0"
98 93
99case-sensitive-sort:: 94cache-snapshot-ttl::
100 Sort items in the repo list case sensitively. Default value: "1". 95 Number which specifies the time-to-live, in minutes, for the cached
101 See also: repository-sort, section-sort. 96 version of snapshots. See also: "CACHE". Default value: "5".
97
98cache-static-ttl::
99 Number which specifies the time-to-live, in minutes, for the cached
100 version of repository pages accessed with a fixed SHA1. See also:
101 "CACHE". Default value: -1".
102 102
103clone-prefix:: 103clone-prefix::
104 Space-separated list of common prefixes which, when combined with a 104 Space-separated list of common prefixes which, when combined with a
@@ -159,12 +159,29 @@ enable-follow-links::
159 Flag which, when set to "1", allows users to follow a file in the log 159 Flag which, when set to "1", allows users to follow a file in the log
160 view. Default value: "0". 160 view. Default value: "0".
161 161
162enable-git-config::
163 Flag which, when set to "1", will allow cgit to use git config to set
164 any repo specific settings. This option is used in conjunction with
165 "scan-path", and must be defined prior, to augment repo-specific
166 settings. The keys gitweb.owner, gitweb.category, gitweb.description,
167 and gitweb.homepage will map to the cgit keys repo.owner, repo.section,
168 repo.desc, and repo.homepage respectively. All git config keys that begin
169 with "cgit." will be mapped to the corresponding "repo." key in cgit.
170 Default value: "0". See also: scan-path, section-from-path.
171
162enable-http-clone:: 172enable-http-clone::
163 If set to "1", cgit will act as an dumb HTTP endpoint for git clones. 173 If set to "1", cgit will act as a dumb HTTP endpoint for git clones.
164 You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url 174 You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url
165 to expose this feature. If you use an alternate way of serving git 175 to expose this feature. If you use an alternate way of serving git
166 repositories, you may wish to disable this. Default value: "1". 176 repositories, you may wish to disable this. Default value: "1".
167 177
178enable-html-serving::
179 Flag which, when set to "1", will allow the /plain handler to serve
180 mimetype headers that result in the file being treated as HTML by the
181 browser. When set to "0", such file types are returned instead as
182 text/plain or application/octet-stream. Default value: "0". See also:
183 "repo.enable-html-serving".
184
168enable-index-links:: 185enable-index-links::
169 Flag which, when set to "1", will make cgit generate extra links for 186 Flag which, when set to "1", will make cgit generate extra links for
170 each repo in the repository index (specifically, to the "summary", 187 each repo in the repository index (specifically, to the "summary",
@@ -195,27 +212,10 @@ enable-subject-links::
195 in commit view. Default value: "0". See also: 212 in commit view. Default value: "0". See also:
196 "repo.enable-subject-links". 213 "repo.enable-subject-links".
197 214
198enable-html-serving::
199 Flag which, when set to "1", will allow the /plain handler to serve
200 mimetype headers that result in the file being treated as HTML by the
201 browser. When set to "0", such file types are returned instead as
202 text/plain or application/octet-stream. Default value: "0". See also:
203 "repo.enable-html-serving".
204
205enable-tree-linenumbers:: 215enable-tree-linenumbers::
206 Flag which, when set to "1", will make cgit generate linenumber links 216 Flag which, when set to "1", will make cgit generate linenumber links
207 for plaintext blobs printed in the tree view. Default value: "1". 217 for plaintext blobs printed in the tree view. Default value: "1".
208 218
209enable-git-config::
210 Flag which, when set to "1", will allow cgit to use git config to set
211 any repo specific settings. This option is used in conjunction with
212 "scan-path", and must be defined prior, to augment repo-specific
213 settings. The keys gitweb.owner, gitweb.category, gitweb.description,
214 and gitweb.homepage will map to the cgit keys repo.owner, repo.section,
215 repo.desc, and repo.homepage respectively. All git config keys that begin
216 with "cgit." will be mapped to the corresponding "repo." key in cgit.
217 Default value: "0". See also: scan-path, section-from-path.
218
219favicon:: 219favicon::
220 Url used as link to a shortcut icon for cgit. It is suggested to use 220 Url used as link to a shortcut icon for cgit. It is suggested to use
221 the value "/favicon.ico" since certain browsers will ignore other 221 the value "/favicon.ico" since certain browsers will ignore other
@@ -251,19 +251,14 @@ logo-link::
251 calculated url of the repository index page will be used. Default 251 calculated url of the repository index page will be used. Default
252 value: none. 252 value: none.
253 253
254owner-filter::
255 Specifies a command which will be invoked to format the Owner
256 column of the main page. The command will get the owner on STDIN,
257 and the STDOUT from the command will be included verbatim in the
258 table. This can be used to link to additional context such as an
259 owners home page. When active this filter is used instead of the
260 default owner query url. Default value: none.
261 See also: "FILTER API".
262
263max-atom-items:: 254max-atom-items::
264 Specifies the number of items to display in atom feeds view. Default 255 Specifies the number of items to display in atom feeds view. Default
265 value: "10". 256 value: "10".
266 257
258max-blob-size::
259 Specifies the maximum size of a blob to display HTML for in KBytes.
260 Default value: "0" (limit disabled).
261
267max-commit-count:: 262max-commit-count::
268 Specifies the number of entries to list per page in "log" view. Default 263 Specifies the number of entries to list per page in "log" view. Default
269 value: "50". 264 value: "50".
@@ -280,10 +275,6 @@ max-repodesc-length::
280 Specifies the maximum number of repo description characters to display 275 Specifies the maximum number of repo description characters to display
281 on the repository index page. Default value: "80". 276 on the repository index page. Default value: "80".
282 277
283max-blob-size::
284 Specifies the maximum size of a blob to display HTML for in KBytes.
285 Default value: "0" (limit disabled).
286
287max-stats:: 278max-stats::
288 Set the default maximum statistics period. Valid values are "week", 279 Set the default maximum statistics period. Valid values are "week",
289 "month", "quarter" and "year". If unspecified, statistics are 280 "month", "quarter" and "year". If unspecified, statistics are
@@ -319,6 +310,15 @@ noheader::
319 Flag which, when set to "1", will make cgit omit the standard header 310 Flag which, when set to "1", will make cgit omit the standard header
320 on all pages. Default value: none. See also: "embedded". 311 on all pages. Default value: none. See also: "embedded".
321 312
313owner-filter::
314 Specifies a command which will be invoked to format the Owner
315 column of the main page. The command will get the owner on STDIN,
316 and the STDOUT from the command will be included verbatim in the
317 table. This can be used to link to additional context such as an
318 owners home page. When active this filter is used instead of the
319 default owner query url. Default value: none.
320 See also: "FILTER API".
321
322project-list:: 322project-list::
323 A list of subdirectories inside of scan-path, relative to it, that 323 A list of subdirectories inside of scan-path, relative to it, that
324 should loaded as git repositories. This must be defined prior to 324 should loaded as git repositories. This must be defined prior to
@@ -481,9 +481,6 @@ repo.defbranch::
481repo.desc:: 481repo.desc::
482 The value to show as repository description. Default value: none. 482 The value to show as repository description. Default value: none.
483 483
484repo.homepage::
485 The value to show as repository homepage. Default value: none.
486
487repo.email-filter:: 484repo.email-filter::
488 Override the default email-filter. Default value: none. See also: 485 Override the default email-filter. Default value: none. See also:
489 "enable-filter-overrides". See also: "FILTER API". 486 "enable-filter-overrides". See also: "FILTER API".
@@ -492,6 +489,10 @@ repo.enable-commit-graph::
492 A flag which can be used to disable the global setting 489 A flag which can be used to disable the global setting
493 `enable-commit-graph'. Default value: none. 490 `enable-commit-graph'. Default value: none.
494 491
492repo.enable-html-serving::
493 A flag which can be used to override the global setting
494 `enable-html-serving`. Default value: none.
495
495repo.enable-log-filecount:: 496repo.enable-log-filecount::
496 A flag which can be used to disable the global setting 497 A flag which can be used to disable the global setting
497 `enable-log-filecount'. Default value: none. 498 `enable-log-filecount'. Default value: none.
@@ -508,15 +509,14 @@ repo.enable-subject-links::
508 A flag which can be used to override the global setting 509 A flag which can be used to override the global setting
509 `enable-subject-links'. Default value: none. 510 `enable-subject-links'. Default value: none.
510 511
511repo.enable-html-serving::
512 A flag which can be used to override the global setting
513 `enable-html-serving`. Default value: none.
514
515repo.hide:: 512repo.hide::
516 Flag which, when set to "1", hides the repository from the repository 513 Flag which, when set to "1", hides the repository from the repository
517 index. The repository can still be accessed by providing a direct path. 514 index. The repository can still be accessed by providing a direct path.
518 Default value: "0". See also: "repo.ignore". 515 Default value: "0". See also: "repo.ignore".
519 516
517repo.homepage::
518 The value to show as repository homepage. Default value: none.
519
520repo.ignore:: 520repo.ignore::
521 Flag which, when set to "1", ignores the repository. The repository 521 Flag which, when set to "1", ignores the repository. The repository
522 is not shown in the index and cannot be accessed by providing a direct 522 is not shown in the index and cannot be accessed by providing a direct
@@ -531,10 +531,6 @@ repo.logo-link::
531 calculated url of the repository index page will be used. Default 531 calculated url of the repository index page will be used. Default
532 value: global logo-link. 532 value: global logo-link.
533 533
534repo.owner-filter::
535 Override the default owner-filter. Default value: none. See also:
536 "enable-filter-overrides". See also: "FILTER API".
537
538repo.module-link:: 534repo.module-link::
539 Text which will be used as the formatstring for a hyperlink when a 535 Text which will be used as the formatstring for a hyperlink when a
540 submodule is printed in a directory listing. The arguments for the 536 submodule is printed in a directory listing. The arguments for the
@@ -559,6 +555,10 @@ repo.owner::
559 A value used to identify the owner of the repository. Default value: 555 A value used to identify the owner of the repository. Default value:
560 none. 556 none.
561 557
558repo.owner-filter::
559 Override the default owner-filter. Default value: none. See also:
560 "enable-filter-overrides". See also: "FILTER API".
561
562repo.path:: 562repo.path::
563 An absolute path to the repository directory. For non-bare repositories 563 An absolute path to the repository directory. For non-bare repositories
564 this is the .git-directory. Default value: none. 564 this is the .git-directory. Default value: none.
@@ -574,6 +574,10 @@ repo.readme::
574 are no non-public files located in the same directory as the readme 574 are no non-public files located in the same directory as the readme
575 file. Default value: <readme>. 575 file. Default value: <readme>.
576 576
577repo.section::
578 Override the current section name for this repository. Default value:
579 none.
580
577repo.snapshots:: 581repo.snapshots::
578 A mask of snapshot formats for this repo that cgit generates links for, 582 A mask of snapshot formats for this repo that cgit generates links for,
579 restricted by the global "snapshots" setting. Default value: 583 restricted by the global "snapshots" setting. Default value:
@@ -586,10 +590,6 @@ repo.snapshot-prefix::
586 of "linux-stable-3.15.4". Default value: <empty> meaning to use 590 of "linux-stable-3.15.4". Default value: <empty> meaning to use
587 the repository basename. 591 the repository basename.
588 592
589repo.section::
590 Override the current section name for this repository. Default value:
591 none.
592
593repo.source-filter:: 593repo.source-filter::
594 Override the default source-filter. Default value: none. See also: 594 Override the default source-filter. Default value: none. See also:
595 "enable-filter-overrides". See also: "FILTER API". 595 "enable-filter-overrides". See also: "FILTER API".
@@ -662,30 +662,6 @@ about filter::
662 The about text that is to be filtered is available on standard input 662 The about text that is to be filtered is available on standard input
663 and the filtered text is expected on standard output. 663 and the filtered text is expected on standard output.
664 664
665commit filter::
666 This filter is given no arguments. The commit message text that is to
667 be filtered is available on standard input and the filtered text is
668 expected on standard output.
669
670email filter::
671 This filter is given two parameters: the email address of the relevant
672 author and a string indicating the originating page. The filter will
673 then receive the text string to format on standard input and is
674 expected to write to standard output the formatted text to be included
675 in the page.
676
677owner filter::
678 This filter is given no arguments. The owner text is available on
679 standard input and the filter is expected to write to standard
680 output. The output is included in the Owner column.
681
682source filter::
683 This filter is given a single parameter: the filename of the source
684 file to filter. The filter can use the filename to determine (for
685 example) the syntax highlighting mode. The contents of the source
686 file that is to be filtered is available on standard input and the
687 filtered contents is expected on standard output.
688
689auth filter:: 665auth filter::
690 The authentication filter receives 12 parameters: 666 The authentication filter receives 12 parameters:
691 - filter action, explained below, which specifies which action the 667 - filter action, explained below, which specifies which action the
@@ -712,6 +688,30 @@ auth filter::
712 Please see `filters/simple-authentication.lua` for a clear example 688 Please see `filters/simple-authentication.lua` for a clear example
713 script that may be modified. 689 script that may be modified.
714 690
691commit filter::
692 This filter is given no arguments. The commit message text that is to
693 be filtered is available on standard input and the filtered text is
694 expected on standard output.
695
696email filter::
697 This filter is given two parameters: the email address of the relevant
698 author and a string indicating the originating page. The filter will
699 then receive the text string to format on standard input and is
700 expected to write to standard output the formatted text to be included
701 in the page.
702
703owner filter::
704 This filter is given no arguments. The owner text is available on
705 standard input and the filter is expected to write to standard
706 output. The output is included in the Owner column.
707
708source filter::
709 This filter is given a single parameter: the filename of the source
710 file to filter. The filter can use the filename to determine (for
711 example) the syntax highlighting mode. The contents of the source
712 file that is to be filtered is available on standard input and the
713 filtered contents is expected on standard output.
714
715 715
716All filters are handed the following environment variables: 716All filters are handed the following environment variables:
717 717