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