cgitrc.5.txt (view raw)
1:man source: cgit
2:man manual: cgit
3
4CGITRC(5)
5========
6
7
8NAME
9----
10cgitrc - runtime configuration for cgit
11
12
13SYNOPSIS
14--------
15Cgitrc contains all runtime settings for cgit, including the list of git
16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
17lines, and lines starting with '#', are ignored.
18
19
20LOCATION
21--------
22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
23runtime, cgit will consult the environment variable CGIT_CONFIG and, if
24defined, use its value instead.
25
26
27GLOBAL SETTINGS
28---------------
29about-filter::
30 Specifies a command which will be invoked to format the content of
31 about pages (both top-level and for each repository). The command will
32 get the content of the about-file on its STDIN, the name of the file
33 as the first argument, and the STDOUT from the command will be
34 included verbatim on the about page. Default value: none. See
35 also: "FILTER API".
36
37agefile::
38 Specifies a path, relative to each repository path, which can be used
39 to specify the date and time of the youngest commit in the repository.
40 The first line in the file is used as input to the "parse_date"
41 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
42 hh:mm:ss". You may want to generate this file from a post-receive
43 hook. Default value: "info/web/last-modified".
44
45auth-filter::
46 Specifies a command that will be invoked for authenticating repository
47 access. Receives quite a few arguments, and data on both stdin and
48 stdout for authentication processing. Details follow later in this
49 document. If no auth-filter is specified, no authentication is
50 performed. Default value: none. See also: "FILTER API".
51
52branch-sort::
53 Flag which, when set to "age", enables date ordering in the branch ref
54 list, and when set to "name" enables ordering by branch name. Default
55 value: "name".
56
57cache-about-ttl::
58 Number which specifies the time-to-live, in minutes, for the cached
59 version of the repository about page. See also: "CACHE". Default
60 value: "15".
61
62cache-dynamic-ttl::
63 Number which specifies the time-to-live, in minutes, for the cached
64 version of repository pages accessed without a fixed SHA1. See also:
65 "CACHE". Default value: "5".
66
67cache-repo-ttl::
68 Number which specifies the time-to-live, in minutes, for the cached
69 version of the repository summary page. See also: "CACHE". Default
70 value: "5".
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::
77 Number which specifies the time-to-live, in minutes, for the cached
78 version of the repository index page. See also: "CACHE". Default
79 value: "5".
80
81cache-scanrc-ttl::
82 Number which specifies the time-to-live, in minutes, for the result
83 of scanning a path for git repositories. See also: "CACHE". Default
84 value: "15".
85
86case-sensitive-sort::
87 Sort items in the repo list case sensitively. Default value: "1".
88 See also: repository-sort, section-sort.
89
90cache-size::
91 The maximum number of entries in the cgit cache. When set to "0",
92 caching is disabled. See also: "CACHE". Default value: "0"
93
94cache-snapshot-ttl::
95 Number which specifies the time-to-live, in minutes, for the cached
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
103clone-prefix::
104 Space-separated list of common prefixes which, when combined with a
105 repository url, generates valid clone urls for the repository. This
106 setting is only used if `repo.clone-url` is unspecified. Default value:
107 none.
108
109clone-url::
110 Space-separated list of clone-url templates. This setting is only
111 used if `repo.clone-url` is unspecified. Default value: none. See
112 also: "MACRO EXPANSION", "FILTER API".
113
114commit-filter::
115 Specifies a command which will be invoked to format commit messages.
116 The command will get the message on its STDIN, and the STDOUT from the
117 command will be included verbatim as the commit message, i.e. this can
118 be used to implement bugtracker integration. Default value: none.
119 See also: "FILTER API".
120
121commit-sort::
122 Flag which, when set to "date", enables strict date ordering in the
123 commit log, and when set to "topo" enables strict topological
124 ordering. If unset, the default ordering of "git log" is used. Default
125 value: unset.
126
127css::
128 Url which specifies the css document to include in all cgit pages.
129 Default value: "/cgit.css".
130
131email-filter::
132 Specifies a command which will be invoked to format names and email
133 address of committers, authors, and taggers, as represented in various
134 places throughout the cgit interface. This command will receive an
135 email address and an origin page string as its command line arguments,
136 and the text to format on STDIN. It is to write the formatted text back
137 out onto STDOUT. Default value: none. See also: "FILTER API".
138
139embedded::
140 Flag which, when set to "1", will make cgit generate a html fragment
141 suitable for embedding in other html pages. Default value: none. See
142 also: "noheader".
143
144enable-blame::
145 Flag which, when set to "1", will allow cgit to provide a "blame" page
146 for files, and will make it generate links to that page in appropriate
147 places. Default value: "0".
148
149enable-commit-graph::
150 Flag which, when set to "1", will make cgit print an ASCII-art commit
151 history graph to the left of the commit messages in the repository
152 log page. Default value: "0".
153
154enable-filter-overrides::
155 Flag which, when set to "1", allows all filter settings to be
156 overridden in repository-specific cgitrc files. Default value: none.
157
158enable-follow-links::
159 Flag which, when set to "1", allows users to follow a file in the log
160 view. Default value: "0".
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
172enable-http-clone::
173 If set to "1", cgit will act as a dumb HTTP endpoint for git clones.
174 You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url
175 to expose this feature. If you use an alternate way of serving git
176 repositories, you may wish to disable this. Default value: "1".
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
185enable-index-links::
186 Flag which, when set to "1", will make cgit generate extra links for
187 each repo in the repository index (specifically, to the "summary",
188 "commit" and "tree" pages). Default value: "0".
189
190enable-index-owner::
191 Flag which, when set to "1", will make cgit display the owner of
192 each repo in the repository index. Default value: "1".
193
194enable-log-filecount::
195 Flag which, when set to "1", will make cgit print the number of
196 modified files for each commit on the repository log page. Default
197 value: "0".
198
199enable-log-linecount::
200 Flag which, when set to "1", will make cgit print the number of added
201 and removed lines for each commit on the repository log page. Default
202 value: "0".
203
204enable-remote-branches::
205 Flag which, when set to "1", will make cgit display remote branches
206 in the summary and refs views. Default value: "0". See also:
207 "repo.enable-remote-branches".
208
209enable-subject-links::
210 Flag which, when set to "1", will make cgit use the subject of the
211 parent commit as link text when generating links to parent commits
212 in commit view. Default value: "0". See also:
213 "repo.enable-subject-links".
214
215enable-tree-linenumbers::
216 Flag which, when set to "1", will make cgit generate linenumber links
217 for plaintext blobs printed in the tree view. Default value: "1".
218
219favicon::
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
222 values. Default value: "/favicon.ico".
223
224footer::
225 The content of the file specified with this option will be included
226 verbatim at the bottom of all pages (i.e. it replaces the standard
227 "generated by..." message. Default value: none.
228
229head-include::
230 The content of the file specified with this option will be included
231 verbatim in the html HEAD section on all pages. Default value: none.
232
233header::
234 The content of the file specified with this option will be included
235 verbatim at the top of all pages. Default value: none.
236
237include::
238 Name of a configfile to include before the rest of the current config-
239 file is parsed. Default value: none. See also: "MACRO EXPANSION".
240
241local-time::
242 Flag which, if set to "1", makes cgit print commit and tag times in the
243 servers timezone. Default value: "0".
244
245logo::
246 Url which specifies the source of an image which will be used as a logo
247 on all cgit pages. Default value: "/cgit.png".
248
249logo-link::
250 Url loaded when clicking on the cgit logo image. If unspecified the
251 calculated url of the repository index page will be used. Default
252 value: none.
253
254max-atom-items::
255 Specifies the number of items to display in atom feeds view. Default
256 value: "10".
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
262max-commit-count::
263 Specifies the number of entries to list per page in "log" view. Default
264 value: "50".
265
266max-message-length::
267 Specifies the maximum number of commit message characters to display in
268 "log" view. Default value: "80".
269
270max-repo-count::
271 Specifies the number of entries to list per page on the repository
272 index page. Default value: "50".
273
274max-repodesc-length::
275 Specifies the maximum number of repo description characters to display
276 on the repository index page. Default value: "80".
277
278max-stats::
279 Set the default maximum statistics period. Valid values are "week",
280 "month", "quarter" and "year". If unspecified, statistics are
281 disabled. Default value: none. See also: "repo.max-stats".
282
283mimetype.<ext>::
284 Set the mimetype for the specified filename extension. This is used
285 by the `plain` command when returning blob content.
286
287mimetype-file::
288 Specifies the file to use for automatic mimetype lookup. If specified
289 then this field is used as a fallback when no "mimetype.<ext>" match is
290 found. If unspecified then no such lookup is performed. The typical file
291 to use on a Linux system is /etc/mime.types. The format of the file must
292 comply to:
293 - a comment line is an empty line or a line starting with a hash (#),
294 optionally preceded by whitespace
295 - a non-comment line starts with the mimetype (like image/png), followed
296 by one or more file extensions (like jpg), all separated by whitespace
297 Default value: none. See also: "mimetype.<ext>".
298
299module-link::
300 Text which will be used as the formatstring for a hyperlink when a
301 submodule is printed in a directory listing. The arguments for the
302 formatstring are the path and SHA1 of the submodule commit. Default
303 value: none.
304
305noplainemail::
306 If set to "1" showing full author email addresses will be disabled.
307 Default value: "0".
308
309noheader::
310 Flag which, when set to "1", will make cgit omit the standard header
311 on all pages. Default value: none. See also: "embedded".
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::
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
325 scan-path. Default value: none. See also: scan-path, "MACRO
326 EXPANSION".
327
328readme::
329 Text which will be used as default value for "repo.readme". Multiple
330 config keys may be specified, and cgit will use the first found file
331 in this list. This is useful in conjunction with scan-path. Default
332 value: none. See also: scan-path, repo.readme.
333
334remove-suffix::
335 If set to "1" and scan-path is enabled, if any repositories are found
336 with a suffix of ".git", this suffix will be removed for the url and
337 name. This must be defined prior to scan-path. Default value: "0".
338 See also: scan-path.
339
340renamelimit::
341 Maximum number of files to consider when detecting renames. The value
342 "-1" uses the compiletime value in git (for further info, look at
343 `man git-diff`). Default value: "-1".
344
345repository-sort::
346 The way in which repositories in each section are sorted. Valid values
347 are "name" for sorting by the repo name or "age" for sorting by the
348 most recently updated repository. Default value: "name". See also:
349 section, case-sensitive-sort, section-sort.
350
351robots::
352 Text used as content for the "robots" meta-tag. Default value:
353 "index, nofollow".
354
355root-desc::
356 Text printed below the heading on the repository index page. Default
357 value: "a fast webinterface for the git dscm".
358
359root-readme::
360 The content of the file specified with this option will be included
361 verbatim below the "about" link on the repository index page. Default
362 value: none.
363
364root-title::
365 Text printed as heading on the repository index page. Default value:
366 "Git Repository Browser".
367
368scan-hidden-path::
369 If set to "1" and scan-path is enabled, scan-path will recurse into
370 directories whose name starts with a period ('.'). Otherwise,
371 scan-path will stay away from such directories (considered as
372 "hidden"). Note that this does not apply to the ".git" directory in
373 non-bare repos. This must be defined prior to scan-path.
374 Default value: 0. See also: scan-path.
375
376scan-path::
377 A path which will be scanned for repositories. If caching is enabled,
378 the result will be cached as a cgitrc include-file in the cache
379 directory. If project-list has been defined prior to scan-path,
380 scan-path loads only the directories listed in the file pointed to by
381 project-list. Be advised that only the global settings taken
382 before the scan-path directive will be applied to each repository.
383 Default value: none. See also: cache-scanrc-ttl, project-list,
384 "MACRO EXPANSION".
385
386section::
387 The name of the current repository section - all repositories defined
388 after this option will inherit the current section name. Default value:
389 none.
390
391section-sort::
392 Flag which, when set to "1", will sort the sections on the repository
393 listing by name. Set this flag to "0" if the order in the cgitrc file should
394 be preserved. Default value: "1". See also: section,
395 case-sensitive-sort, repository-sort.
396
397section-from-path::
398 A number which, if defined prior to scan-path, specifies how many
399 path elements from each repo path to use as a default section name.
400 If negative, cgit will discard the specified number of path elements
401 above the repo directory. Default value: "0".
402
403side-by-side-diffs::
404 If set to "1" shows side-by-side diffs instead of unidiffs per
405 default. Default value: "0".
406
407snapshots::
408 Text which specifies the default set of snapshot formats that cgit
409 generates links for. The value is a space-separated list of zero or
410 more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip".
411 The special value "all" enables all snapshot formats.
412 Default value: none.
413
414source-filter::
415 Specifies a command which will be invoked to format plaintext blobs
416 in the tree view. The command will get the blob content on its STDIN
417 and the name of the blob as its only command line argument. The STDOUT
418 from the command will be included verbatim as the blob contents, i.e.
419 this can be used to implement e.g. syntax highlighting. Default value:
420 none. See also: "FILTER API".
421
422summary-branches::
423 Specifies the number of branches to display in the repository "summary"
424 view. Default value: "10".
425
426summary-log::
427 Specifies the number of log entries to display in the repository
428 "summary" view. Default value: "10".
429
430summary-tags::
431 Specifies the number of tags to display in the repository "summary"
432 view. Default value: "10".
433
434strict-export::
435 Filename which, if specified, needs to be present within the repository
436 for cgit to allow access to that repository. This can be used to emulate
437 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
438 repositories to match those exported by git-daemon. This option must
439 be defined prior to scan-path.
440
441virtual-root::
442 Url which, if specified, will be used as root for all cgit links. It
443 will also cause cgit to generate 'virtual urls', i.e. urls like
444 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
445 value: none.
446 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
447 same kind of virtual urls, so this option will probably be deprecated.
448
449
450REPOSITORY SETTINGS
451-------------------
452repo.about-filter::
453 Override the default about-filter. Default value: none. See also:
454 "enable-filter-overrides". See also: "FILTER API".
455
456repo.branch-sort::
457 Flag which, when set to "age", enables date ordering in the branch ref
458 list, and when set to "name" enables ordering by branch name. Default
459 value: "name".
460
461repo.clone-url::
462 A list of space-separated urls which can be used to clone this repo.
463 Default value: none. See also: "MACRO EXPANSION".
464
465repo.commit-filter::
466 Override the default commit-filter. Default value: none. See also:
467 "enable-filter-overrides". See also: "FILTER API".
468
469repo.commit-sort::
470 Flag which, when set to "date", enables strict date ordering in the
471 commit log, and when set to "topo" enables strict topological
472 ordering. If unset, the default ordering of "git log" is used. Default
473 value: unset.
474
475repo.defbranch::
476 The name of the default branch for this repository. If no such branch
477 exists in the repository, the first branch name (when sorted) is used
478 as default instead. Default value: branch pointed to by HEAD, or
479 "master" if there is no suitable HEAD.
480
481repo.desc::
482 The value to show as repository description. Default value: none.
483
484repo.email-filter::
485 Override the default email-filter. Default value: none. See also:
486 "enable-filter-overrides". See also: "FILTER API".
487
488repo.enable-blame::
489 A flag which can be used to disable the global setting
490 `enable-blame'. Default value: none.
491
492repo.enable-commit-graph::
493 A flag which can be used to disable the global setting
494 `enable-commit-graph'. Default value: none.
495
496repo.enable-html-serving::
497 A flag which can be used to override the global setting
498 `enable-html-serving`. Default value: none.
499
500repo.enable-log-filecount::
501 A flag which can be used to disable the global setting
502 `enable-log-filecount'. Default value: none.
503
504repo.enable-log-linecount::
505 A flag which can be used to disable the global setting
506 `enable-log-linecount'. Default value: none.
507
508repo.enable-remote-branches::
509 Flag which, when set to "1", will make cgit display remote branches
510 in the summary and refs views. Default value: <enable-remote-branches>.
511
512repo.enable-subject-links::
513 A flag which can be used to override the global setting
514 `enable-subject-links'. Default value: none.
515
516repo.extra-head-content::
517 This value will be added verbatim to the head section of each page
518 displayed for this repo. Default value: none.
519
520repo.hide::
521 Flag which, when set to "1", hides the repository from the repository
522 index. The repository can still be accessed by providing a direct path.
523 Default value: "0". See also: "repo.ignore".
524
525repo.homepage::
526 The value to show as repository homepage. Default value: none.
527
528repo.ignore::
529 Flag which, when set to "1", ignores the repository. The repository
530 is not shown in the index and cannot be accessed by providing a direct
531 path. Default value: "0". See also: "repo.hide".
532
533repo.logo::
534 Url which specifies the source of an image which will be used as a logo
535 on this repo's pages. Default value: global logo.
536
537repo.logo-link::
538 Url loaded when clicking on the cgit logo image. If unspecified the
539 calculated url of the repository index page will be used. Default
540 value: global logo-link.
541
542repo.module-link::
543 Text which will be used as the formatstring for a hyperlink when a
544 submodule is printed in a directory listing. The arguments for the
545 formatstring are the path and SHA1 of the submodule commit. Default
546 value: <module-link>
547
548repo.module-link.<path>::
549 Text which will be used as the formatstring for a hyperlink when a
550 submodule with the specified subdirectory path is printed in a
551 directory listing. The only argument for the formatstring is the SHA1
552 of the submodule commit. Default value: none.
553
554repo.max-stats::
555 Override the default maximum statistics period. Valid values are equal
556 to the values specified for the global "max-stats" setting. Default
557 value: none.
558
559repo.name::
560 The value to show as repository name. Default value: <repo.url>.
561
562repo.owner::
563 A value used to identify the owner of the repository. Default value:
564 none.
565
566repo.owner-filter::
567 Override the default owner-filter. Default value: none. See also:
568 "enable-filter-overrides". See also: "FILTER API".
569
570repo.path::
571 An absolute path to the repository directory. For non-bare repositories
572 this is the .git-directory. Default value: none.
573
574repo.readme::
575 A path (relative to <repo.path>) which specifies a file to include
576 verbatim as the "About" page for this repo. You may also specify a
577 git refspec by head or by hash by prepending the refspec followed by
578 a colon. For example, "master:docs/readme.mkd". If the value begins
579 with a colon, i.e. ":docs/readme.rst", the default branch of the
580 repository will be used. Sharing any file will expose that entire
581 directory tree to the "/about/PATH" endpoints, so be sure that there
582 are no non-public files located in the same directory as the readme
583 file. Default value: <readme>.
584
585repo.section::
586 Override the current section name for this repository. Default value:
587 none.
588
589repo.snapshots::
590 A mask of snapshot formats for this repo that cgit generates links for,
591 restricted by the global "snapshots" setting. Default value:
592 <snapshots>.
593
594repo.snapshot-prefix::
595 Prefix to use for snapshot links instead of the repository basename.
596 For example, the "linux-stable" repository may wish to set this to
597 "linux" so that snapshots are in the format "linux-3.15.4" instead
598 of "linux-stable-3.15.4". Default value: <empty> meaning to use
599 the repository basename.
600
601repo.source-filter::
602 Override the default source-filter. Default value: none. See also:
603 "enable-filter-overrides". See also: "FILTER API".
604
605repo.url::
606 The relative url used to access the repository. This must be the first
607 setting specified for each repo. Default value: none.
608
609
610REPOSITORY-SPECIFIC CGITRC FILE
611-------------------------------
612When the option "scan-path" is used to auto-discover git repositories, cgit
613will try to parse the file "cgitrc" within any found repository. Such a
614repo-specific config file may contain any of the repo-specific options
615described above, except "repo.url" and "repo.path". Additionally, the "filter"
616options are only acknowledged in repo-specific config files when
617"enable-filter-overrides" is set to "1".
618
619Note: the "repo." prefix is dropped from the option names in repo-specific
620config files, e.g. "repo.desc" becomes "desc".
621
622
623FILTER API
624----------
625By default, filters are separate processes that are executed each time they
626are needed. Alternative technologies may be used by prefixing the filter
627specification with the relevant string; available values are:
628
629'exec:'::
630 The default "one process per filter" mode.
631
632'lua:'::
633 Executes the script using a built-in Lua interpreter. The script is
634 loaded once per execution of cgit, and may be called multiple times
635 during cgit's lifetime, making it a good choice for repeated filters
636 such as the 'email filter'. It responds to three functions:
637
638 'filter_open(argument1, argument2, argument3, ...)'::
639 This is called upon activation of the filter for a particular
640 set of data.
641 'filter_write(buffer)'::
642 This is called whenever cgit writes data to the webpage.
643 'filter_close()'::
644 This is called when the current filtering operation is
645 completed. It must return an integer value. Usually 0
646 indicates success.
647
648 Additionally, cgit exposes to the Lua the following built-in functions:
649
650 'html(str)'::
651 Writes 'str' to the webpage.
652 'html_txt(str)'::
653 HTML escapes and writes 'str' to the webpage.
654 'html_attr(str)'::
655 HTML escapes for an attribute and writes "str' to the webpage.
656 'html_url_path(str)'::
657 URL escapes for a path and writes 'str' to the webpage.
658 'html_url_arg(str)'::
659 URL escapes for an argument and writes 'str' to the webpage.
660 'html_include(file)'::
661 Includes 'file' in webpage.
662
663
664Parameters are provided to filters as follows.
665
666about filter::
667 This filter is given a single parameter: the filename of the source
668 file to filter. The filter can use the filename to determine (for
669 example) the type of syntax to follow when formatting the readme file.
670 The about text that is to be filtered is available on standard input
671 and the filtered text is expected on standard output.
672
673auth filter::
674 The authentication filter receives 12 parameters:
675 - filter action, explained below, which specifies which action the
676 filter is called for
677 - http cookie
678 - http method
679 - http referer
680 - http path
681 - http https flag
682 - cgit repo
683 - cgit page
684 - cgit url
685 - cgit login url
686 When the filter action is "body", this filter must write to output the
687 HTML for displaying the login form, which POSTs to the login url. When
688 the filter action is "authenticate-cookie", this filter must validate
689 the http cookie and return a 0 if it is invalid or 1 if it is invalid,
690 in the exit code / close function. If the filter action is
691 "authenticate-post", this filter receives POST'd parameters on
692 standard input, and should write a complete CGI response, preferably
693 with a 302 redirect, and write to output one or more "Set-Cookie"
694 HTTP headers, each followed by a newline.
695
696 Please see `filters/simple-authentication.lua` for a clear example
697 script that may be modified.
698
699commit filter::
700 This filter is given no arguments. The commit message text that is to
701 be filtered is available on standard input and the filtered text is
702 expected on standard output.
703
704email filter::
705 This filter is given two parameters: the email address of the relevant
706 author and a string indicating the originating page. The filter will
707 then receive the text string to format on standard input and is
708 expected to write to standard output the formatted text to be included
709 in the page.
710
711owner filter::
712 This filter is given no arguments. The owner text is available on
713 standard input and the filter is expected to write to standard
714 output. The output is included in the Owner column.
715
716source filter::
717 This filter is given a single parameter: the filename of the source
718 file to filter. The filter can use the filename to determine (for
719 example) the syntax highlighting mode. The contents of the source
720 file that is to be filtered is available on standard input and the
721 filtered contents is expected on standard output.
722
723
724All filters are handed the following environment variables:
725
726- CGIT_REPO_URL (from repo.url)
727- CGIT_REPO_NAME (from repo.name)
728- CGIT_REPO_PATH (from repo.path)
729- CGIT_REPO_OWNER (from repo.owner)
730- CGIT_REPO_DEFBRANCH (from repo.defbranch)
731- CGIT_REPO_SECTION (from repo.section)
732- CGIT_REPO_CLONE_URL (from repo.clone-url)
733
734If a setting is not defined for a repository and the corresponding global
735setting is also not defined (if applicable), then the corresponding
736environment variable will be unset.
737
738
739MACRO EXPANSION
740---------------
741The following cgitrc options support a simple macro expansion feature,
742where tokens prefixed with "$" are replaced with the value of a similarly
743named environment variable:
744
745- cache-root
746- include
747- project-list
748- scan-path
749
750Macro expansion will also happen on the content of $CGIT_CONFIG, if
751defined.
752
753One usage of this feature is virtual hosting, which in its simplest form
754can be accomplished by adding the following line to /etc/cgitrc:
755
756 include=/etc/cgitrc.d/$HTTP_HOST
757
758The following options are expanded during request processing, and support
759the environment variables defined in "FILTER API":
760
761- clone-url
762- repo.clone-url
763
764
765CACHE
766-----
767
768All cache ttl values are in minutes. Negative ttl values indicate that a page
769type will never expire, and thus the first time a URL is accessed, the result
770will be cached indefinitely, even if the underlying git repository changes.
771Conversely, when a ttl value is zero, the cache is disabled for that
772particular page type, and the page type is never cached.
773
774SIGNATURES
775----------
776
777Cgit can host .asc signatures corresponding to various snapshot formats,
778through use of git notes. For example, the following command may be used to
779add a signature to a .tar.xz archive:
780
781 git notes --ref=refs/notes/signatures/tar.xz add -C "$(
782 gpg --output - --armor --detach-sign cgit-1.1.tar.xz |
783 git hash-object -w --stdin
784 )" v1.1
785
786If it is instead desirable to attach a signature of the underlying .tar, this
787will be linked, as a special case, beside a .tar.* link that does not have its
788own signature. For example, a signature of a tarball of the latest tag might
789be added with a similar command:
790
791 tag="$(git describe --abbrev=0)"
792 git notes --ref=refs/notes/signatures/tar add -C "$(
793 git archive --format tar --prefix "cgit-${tag#v}/" "$tag" |
794 gpg --output - --armor --detach-sign |
795 git hash-object -w --stdin
796 )" "$tag"
797
798Since git-archive(1) is expected to produce stable output between versions,
799this allows one to generate a long-term signature of the contents of a given
800tag.
801
802EXAMPLE CGITRC FILE
803-------------------
804
805....
806# Enable caching of up to 1000 output entries
807cache-size=1000
808
809
810# Specify some default clone urls using macro expansion
811clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
812
813# Specify the css url
814css=/css/cgit.css
815
816
817# Show owner on index page
818enable-index-owner=1
819
820
821# Allow http transport git clone
822enable-http-clone=1
823
824
825# Show extra links for each repository on the index page
826enable-index-links=1
827
828
829# Enable blame page and create links to it from tree page
830enable-blame=1
831
832
833# Enable ASCII art commit history graph on the log pages
834enable-commit-graph=1
835
836
837# Show number of affected files per commit on the log pages
838enable-log-filecount=1
839
840
841# Show number of added/removed lines per commit on the log pages
842enable-log-linecount=1
843
844
845# Sort branches by date
846branch-sort=age
847
848
849# Add a cgit favicon
850favicon=/favicon.ico
851
852
853# Use a custom logo
854logo=/img/mylogo.png
855
856
857# Enable statistics per week, month and quarter
858max-stats=quarter
859
860
861# Set the title and heading of the repository index page
862root-title=example.com git repositories
863
864
865# Set a subheading for the repository index page
866root-desc=tracking the foobar development
867
868
869# Include some more info about example.com on the index page
870root-readme=/var/www/htdocs/about.html
871
872
873# Allow download of tar.gz, tar.bz2 and zip-files
874snapshots=tar.gz tar.bz2 zip
875
876
877##
878## List of common mimetypes
879##
880
881mimetype.gif=image/gif
882mimetype.html=text/html
883mimetype.jpg=image/jpeg
884mimetype.jpeg=image/jpeg
885mimetype.pdf=application/pdf
886mimetype.png=image/png
887mimetype.svg=image/svg+xml
888
889
890# Highlight source code with python pygments-based highlighter
891source-filter=/var/www/cgit/filters/syntax-highlighting.py
892
893# Format markdown, restructuredtext, manpages, text files, and html files
894# through the right converters
895about-filter=/var/www/cgit/filters/about-formatting.sh
896
897##
898## Search for these files in the root of the default branch of repositories
899## for coming up with the about page:
900##
901readme=:README.md
902readme=:readme.md
903readme=:README.mkd
904readme=:readme.mkd
905readme=:README.rst
906readme=:readme.rst
907readme=:README.html
908readme=:readme.html
909readme=:README.htm
910readme=:readme.htm
911readme=:README.txt
912readme=:readme.txt
913readme=:README
914readme=:readme
915readme=:INSTALL.md
916readme=:install.md
917readme=:INSTALL.mkd
918readme=:install.mkd
919readme=:INSTALL.rst
920readme=:install.rst
921readme=:INSTALL.html
922readme=:install.html
923readme=:INSTALL.htm
924readme=:install.htm
925readme=:INSTALL.txt
926readme=:install.txt
927readme=:INSTALL
928readme=:install
929
930
931##
932## List of repositories.
933## PS: Any repositories listed when section is unset will not be
934## displayed under a section heading
935## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
936## and included like this:
937## include=/etc/cgitrepos
938##
939
940
941repo.url=foo
942repo.path=/pub/git/foo.git
943repo.desc=the master foo repository
944repo.owner=fooman@example.com
945repo.readme=info/web/about.html
946
947
948repo.url=bar
949repo.path=/pub/git/bar.git
950repo.desc=the bars for your foo
951repo.owner=barman@example.com
952repo.readme=info/web/about.html
953
954
955# The next repositories will be displayed under the 'extras' heading
956section=extras
957
958
959repo.url=baz
960repo.path=/pub/git/baz.git
961repo.desc=a set of extensions for bar users
962
963repo.url=wiz
964repo.path=/pub/git/wiz.git
965repo.desc=the wizard of foo
966
967
968# Add some mirrored repositories
969section=mirrors
970
971
972repo.url=git
973repo.path=/pub/git/git.git
974repo.desc=the dscm
975
976
977repo.url=linux
978repo.path=/pub/git/linux.git
979repo.desc=the kernel
980
981# Disable adhoc downloads of this repo
982repo.snapshots=0
983
984# Disable line-counts for this repo
985repo.enable-log-linecount=0
986
987# Restrict the max statistics period for this repo
988repo.max-stats=month
989....
990
991
992BUGS
993----
994Comments currently cannot appear on the same line as a setting; the comment
995will be included as part of the value. E.g. this line:
996
997 robots=index # allow indexing
998
999will generate the following html element:
1000
1001 <meta name='robots' content='index # allow indexing'/>
1002
1003
1004
1005AUTHOR
1006------
1007Lars Hjemli <hjemli@gmail.com>
1008Jason A. Donenfeld <Jason@zx2c4.com>