]> gitweb.ps.run Git - ps-cgit/blob - cgitrc.5.txt
ui-refs.c: Refactor print_tag()
[ps-cgit] / cgitrc.5.txt
1 :man source:   cgit
2 :man manual:   cgit
3
4 CGITRC(5)
5 ========
6
7
8 NAME
9 ----
10 cgitrc - runtime configuration for cgit
11
12
13 SYNOPSIS
14 --------
15 Cgitrc contains all runtime settings for cgit, including the list of git
16 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
17 lines, and lines starting with '#', are ignored.
18
19
20 LOCATION
21 --------
22 The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
23 runtime, cgit will consult the environment variable CGIT_CONFIG and, if
24 defined, use its value instead.
25
26
27 GLOBAL SETTINGS
28 ---------------
29 about-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, and the STDOUT from the
33         command will be included verbatim on the about page. Default value:
34         none. See also: "FILTER API".
35
36 agefile::
37         Specifies a path, relative to each repository path, which can be used
38         to specify the date and time of the youngest commit in the repository.
39         The first line in the file is used as input to the "parse_date"
40         function in libgit. Recommended timestamp-format is "yyyy-mm-dd
41         hh:mm:ss". Default value: "info/web/last-modified".
42
43 cache-root::
44         Path used to store the cgit cache entries. Default value:
45         "/var/cache/cgit". See also: "MACRO EXPANSION".
46
47 cache-dynamic-ttl::
48         Number which specifies the time-to-live, in minutes, for the cached
49         version of repository pages accessed without a fixed SHA1. Default
50         value: "5".
51
52 cache-repo-ttl::
53         Number which specifies the time-to-live, in minutes, for the cached
54         version of the repository summary page. Default value: "5".
55
56 cache-root-ttl::
57         Number which specifies the time-to-live, in minutes, for the cached
58         version of the repository index page. Default value: "5".
59
60 cache-scanrc-ttl::
61         Number which specifies the time-to-live, in minutes, for the result
62         of scanning a path for git repositories. Default value: "15".
63
64 cache-size::
65         The maximum number of entries in the cgit cache. Default value: "0"
66         (i.e. caching is disabled).
67
68 cache-static-ttl::
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:
71         "5".
72
73 case-sensitive-sort::
74         Sort items in the repo list case sensitively. Default value: "1".
75         See also: repository-sort, section-sort.
76
77 clone-prefix::
78         Space-separated list of common prefixes which, when combined with a
79         repository url, generates valid clone urls for the repository. This
80         setting is only used if `repo.clone-url` is unspecified. Default value:
81         none.
82
83 clone-url::
84         Space-separated list of clone-url templates. This setting is only
85         used if `repo.clone-url` is unspecified. Default value: none. See
86         also: "MACRO EXPANSION", "FILTER API".
87
88 commit-filter::
89         Specifies a command which will be invoked to format commit messages.
90         The command will get the message on its STDIN, and the STDOUT from the
91         command will be included verbatim as the commit message, i.e. this can
92         be used to implement bugtracker integration. Default value: none.
93         See also: "FILTER API".
94
95 css::
96         Url which specifies the css document to include in all cgit pages.
97         Default value: "/cgit.css".
98
99 embedded::
100         Flag which, when set to "1", will make cgit generate a html fragment
101         suitable for embedding in other html pages. Default value: none. See
102         also: "noheader".
103
104 enable-commit-graph::
105         Flag which, when set to "1", will make cgit print an ASCII-art commit
106         history graph to the left of the commit messages in the repository
107         log page. Default value: "0".
108
109 enable-filter-overrides::
110         Flag which, when set to "1", allows all filter settings to be
111         overridden in repository-specific cgitrc files. Default value: none.
112
113 enable-http-clone::
114         If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
115         If you use an alternate way of serving git repositories, you may wish
116         to disable this. Default value: "1".
117
118 enable-index-links::
119         Flag which, when set to "1", will make cgit generate extra links for
120         each repo in the repository index (specifically, to the "summary",
121         "commit" and "tree" pages). Default value: "0".
122
123 enable-index-owner::
124         Flag which, when set to "1", will make cgit display the owner of
125         each repo in the repository index. Default value: "1".
126
127 enable-log-filecount::
128         Flag which, when set to "1", will make cgit print the number of
129         modified files for each commit on the repository log page. Default
130         value: "0".
131
132 enable-log-linecount::
133         Flag which, when set to "1", will make cgit print the number of added
134         and removed lines for each commit on the repository log page. Default
135         value: "0".
136
137 enable-remote-branches::
138         Flag which, when set to "1", will make cgit display remote branches
139         in the summary and refs views. Default value: "0". See also:
140         "repo.enable-remote-branches".
141
142 enable-subject-links::
143         Flag which, when set to "1", will make cgit use the subject of the
144         parent commit as link text when generating links to parent commits
145         in commit view. Default value: "0". See also:
146         "repo.enable-subject-links".
147
148 enable-tree-linenumbers::
149         Flag which, when set to "1", will make cgit generate linenumber links
150         for plaintext blobs printed in the tree view. Default value: "1".
151
152 enable-git-config::
153         Flag which, when set to "1", will allow cgit to use git config to set
154         any repo specific settings. This option is used in conjunction with
155         "scan-path" to augment repo-specific settings. The keys gitweb.owner,
156         gitweb.category, and gitweb.description will map to the cgit keys
157         repo.owner, repo.section, and repo.desc, respectivly. All git config
158         keys that begin with "cgit." will be mapped to the corresponding "repo."
159         key in cgit. Default value: "0". See also: scan-path, section-from-path.
160
161 favicon::
162         Url used as link to a shortcut icon for cgit. If specified, it is
163         suggested to use the value "/favicon.ico" since certain browsers will
164         ignore other values. Default value: none.
165
166 footer::
167         The content of the file specified with this option will be included
168         verbatim at the bottom of all pages (i.e. it replaces the standard
169         "generated by..." message. Default value: none.
170
171 head-include::
172         The content of the file specified with this option will be included
173         verbatim in the html HEAD section on all pages. Default value: none.
174
175 header::
176         The content of the file specified with this option will be included
177         verbatim at the top of all pages. Default value: none.
178
179 include::
180         Name of a configfile to include before the rest of the current config-
181         file is parsed. Default value: none. See also: "MACRO EXPANSION".
182
183 index-header::
184         The content of the file specified with this option will be included
185         verbatim above the repository index. This setting is deprecated, and
186         will not be supported by cgit-1.0 (use root-readme instead). Default
187         value: none.
188
189 index-info::
190         The content of the file specified with this option will be included
191         verbatim below the heading on the repository index page. This setting
192         is deprecated, and will not be supported by cgit-1.0 (use root-desc
193         instead). Default value: none.
194
195 local-time::
196         Flag which, if set to "1", makes cgit print commit and tag times in the
197         servers timezone. Default value: "0".
198
199 commit-sort::
200         Flag which, when set to "date", enables strict date ordering in the
201         commit log, and when set to "topo" enables strict topological
202         ordering. If unset, the default ordering of "git log" is used. Default
203         value: unset.
204
205 logo::
206         Url which specifies the source of an image which will be used as a logo
207         on all cgit pages. Default value: "/cgit.png".
208
209 logo-link::
210         Url loaded when clicking on the cgit logo image. If unspecified the
211         calculated url of the repository index page will be used. Default
212         value: none.
213
214 max-atom-items::
215         Specifies the number of items to display in atom feeds view. Default
216         value: "10".
217
218 max-commit-count::
219         Specifies the number of entries to list per page in "log" view. Default
220         value: "50".
221
222 max-message-length::
223         Specifies the maximum number of commit message characters to display in
224         "log" view. Default value: "80".
225
226 max-repo-count::
227         Specifies the number of entries to list per page on the repository
228         index page. Default value: "50".
229
230 max-repodesc-length::
231         Specifies the maximum number of repo description characters to display
232         on the repository index page. Default value: "80".
233
234 max-blob-size::
235         Specifies the maximum size of a blob to display HTML for in KBytes.
236         Default value: "0" (limit disabled).
237
238 max-stats::
239         Set the default maximum statistics period. Valid values are "week",
240         "month", "quarter" and "year". If unspecified, statistics are
241         disabled. Default value: none. See also: "repo.max-stats".
242
243 mimetype.<ext>::
244         Set the mimetype for the specified filename extension. This is used
245         by the `plain` command when returning blob content.
246
247 mimetype-file::
248         Specifies the file to use for automatic mimetype lookup. If specified
249         then this field is used as a fallback when no "mimetype.<ext>" match is
250         found. If unspecified then no such lookup is performed. The typical file
251         to use on a Linux system is /etc/mime.types. The format of the file must
252         comply to:
253         - a comment line is an empty line or a line starting with a hash (#),
254           optionally preceded by whitespace
255         - a non-comment line starts with the mimetype (like image/png), followed
256           by one or more file extensions (like jpg), all separated by whitespace
257         Default value: none. See also: "mimetype.<ext>".
258
259 module-link::
260         Text which will be used as the formatstring for a hyperlink when a
261         submodule is printed in a directory listing. The arguments for the
262         formatstring are the path and SHA1 of the submodule commit. Default
263         value: none.
264
265 nocache::
266         If set to the value "1" caching will be disabled. This settings is
267         deprecated, and will not be honored starting with cgit-1.0. Default
268         value: "0".
269
270 noplainemail::
271         If set to "1" showing full author email adresses will be disabled.
272         Default value: "0".
273
274 noheader::
275         Flag which, when set to "1", will make cgit omit the standard header
276         on all pages. Default value: none. See also: "embedded".
277
278 project-list::
279         A list of subdirectories inside of scan-path, relative to it, that
280         should loaded as git repositories. This must be defined prior to
281         scan-path. Default value: none. See also: scan-path, "MACRO
282         EXPANSION".
283
284 readme::
285         Text which will be used as default value for "repo.readme". Default
286         value: none.
287
288 remove-suffix::
289         If set to "1" and scan-path is enabled, if any repositories are found
290         with a suffix of ".git", this suffix will be removed for the url and
291         name. Default value: "0". See also: scan-path.
292
293 renamelimit::
294         Maximum number of files to consider when detecting renames. The value
295          "-1" uses the compiletime value in git (for further info, look at
296           `man git-diff`). Default value: "-1".
297
298 repo.group::
299         Legacy alias for "section". This option is deprecated and will not be
300         supported in cgit-1.0.
301
302 robots::
303         Text used as content for the "robots" meta-tag. Default value:
304         "index, nofollow".
305
306 root-desc::
307         Text printed below the heading on the repository index page. Default
308         value: "a fast webinterface for the git dscm".
309
310 root-readme::
311         The content of the file specified with this option will be included
312         verbatim below the "about" link on the repository index page. Default
313         value: none.
314
315 root-title::
316         Text printed as heading on the repository index page. Default value:
317         "Git Repository Browser".
318
319 scan-hidden-path::
320         If set to "1" and scan-path is enabled, scan-path will recurse into
321         directories whose name starts with a period ('.'). Otherwise,
322         scan-path will stay away from such directories (considered as
323         "hidden"). Note that this does not apply to the ".git" directory in
324         non-bare repos. This must be defined prior to scan-path.
325         Default value: 0. See also: scan-path.
326
327 scan-path::
328         A path which will be scanned for repositories. If caching is enabled,
329         the result will be cached as a cgitrc include-file in the cache
330         directory. If project-list has been defined prior to scan-path,
331         scan-path loads only the directories listed in the file pointed to by
332         project-list. Be advised that only the global settings taken
333         before the scan-path directive will be applied to each repository.
334         Default value: none. See also: cache-scanrc-ttl, project-list,
335         "MACRO EXPANSION".
336
337 section::
338         The name of the current repository section - all repositories defined
339         after this option will inherit the current section name. Default value:
340         none.
341
342 repository-sort::
343         The way in which repositories in each section are sorted. Valid values
344         are "name" for sorting by the repo name or "age" for sorting by the
345         most recently updated repository. Default value: "name". See also:
346         section, case-sensitive-sort, section-sort.
347
348 section-sort::
349         Flag which, when set to "1", will sort the sections on the repository
350         listing by name. Set this flag to "0" if the order in the cgitrc file should
351         be preserved. Default value: "1". See also: section,
352         case-sensitive-sort, repository-sort.
353
354 section-from-path::
355         A number which, if specified before scan-path, specifies how many
356         path elements from each repo path to use as a default section name.
357         If negative, cgit will discard the specified number of path elements
358         above the repo directory. Default value: "0".
359
360 side-by-side-diffs::
361         If set to "1" shows side-by-side diffs instead of unidiffs per
362         default. Default value: "0".
363
364 snapshots::
365         Text which specifies the default set of snapshot formats generated by
366         cgit. The value is a space-separated list of zero or more of the
367         values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
368         none.
369
370 source-filter::
371         Specifies a command which will be invoked to format plaintext blobs
372         in the tree view. The command will get the blob content on its STDIN
373         and the name of the blob as its only command line argument. The STDOUT
374         from the command will be included verbatim as the blob contents, i.e.
375         this can be used to implement e.g. syntax highlighting. Default value:
376         none. See also: "FILTER API".
377
378 summary-branches::
379         Specifies the number of branches to display in the repository "summary"
380         view. Default value: "10".
381
382 summary-log::
383         Specifies the number of log entries to display in the repository
384         "summary" view. Default value: "10".
385
386 summary-tags::
387         Specifies the number of tags to display in the repository "summary"
388         view. Default value: "10".
389
390 strict-export::
391         Filename which, if specified, needs to be present within the repository
392         for cgit to allow access to that repository. This can be used to emulate
393         gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
394         repositories to match those exported by git-daemon. This option MUST come
395         before 'scan-path'.
396
397 virtual-root::
398         Url which, if specified, will be used as root for all cgit links. It
399         will also cause cgit to generate 'virtual urls', i.e. urls like
400         '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
401         value: none.
402         NOTE: cgit has recently learned how to use PATH_INFO to achieve the
403         same kind of virtual urls, so this option will probably be deprecated.
404
405
406 REPOSITORY SETTINGS
407 -------------------
408 repo.about-filter::
409         Override the default about-filter. Default value: none. See also:
410         "enable-filter-overrides". See also: "FILTER API".
411
412 repo.clone-url::
413         A list of space-separated urls which can be used to clone this repo.
414         Default value: none. See also: "MACRO EXPANSION".
415
416 repo.commit-filter::
417         Override the default commit-filter. Default value: none. See also:
418         "enable-filter-overrides". See also: "FILTER API".
419
420 repo.defbranch::
421         The name of the default branch for this repository. If no such branch
422         exists in the repository, the first branch name (when sorted) is used
423         as default instead. Default value: branch pointed to by HEAD, or
424         "master" if there is no suitable HEAD.
425
426 repo.desc::
427         The value to show as repository description. Default value: none.
428
429 repo.enable-commit-graph::
430         A flag which can be used to disable the global setting
431         `enable-commit-graph'. Default value: none.
432
433 repo.enable-log-filecount::
434         A flag which can be used to disable the global setting
435         `enable-log-filecount'. Default value: none.
436
437 repo.enable-log-linecount::
438         A flag which can be used to disable the global setting
439         `enable-log-linecount'. Default value: none.
440
441 repo.enable-remote-branches::
442         Flag which, when set to "1", will make cgit display remote branches
443         in the summary and refs views. Default value: <enable-remote-branches>.
444
445 repo.enable-subject-links::
446         A flag which can be used to override the global setting
447         `enable-subject-links'. Default value: none.
448
449 repo.commit-sort::
450         Flag which, when set to "date", enables strict date ordering in the
451         commit log, and when set to "topo" enables strict topological
452         ordering. If unset, the default ordering of "git log" is used. Default
453         value: unset.
454
455 repo.logo::
456         Url which specifies the source of an image which will be used as a logo
457         on this repo's pages. Default value: global logo.
458
459 repo.logo-link::
460         Url loaded when clicking on the cgit logo image. If unspecified the
461         calculated url of the repository index page will be used. Default
462         value: global logo-link.
463
464 repo.module-link::
465         Text which will be used as the formatstring for a hyperlink when a
466         submodule is printed in a directory listing. The arguments for the
467         formatstring are the path and SHA1 of the submodule commit. Default
468         value: <module-link>
469
470 repo.module-link.<path>::
471         Text which will be used as the formatstring for a hyperlink when a
472         submodule with the specified subdirectory path is printed in a
473         directory listing. The only argument for the formatstring is the SHA1
474         of the submodule commit. Default value: none.
475
476 repo.max-stats::
477         Override the default maximum statistics period. Valid values are equal
478         to the values specified for the global "max-stats" setting. Default
479         value: none.
480
481 repo.name::
482         The value to show as repository name. Default value: <repo.url>.
483
484 repo.owner::
485         A value used to identify the owner of the repository. Default value:
486         none.
487
488 repo.path::
489         An absolute path to the repository directory. For non-bare repositories
490         this is the .git-directory. Default value: none.
491
492 repo.readme::
493         A path (relative to <repo.path>) which specifies a file to include
494         verbatim as the "About" page for this repo. You may also specify a
495         git refspec by head or by hash by prepending the refspec followed by
496         a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
497
498 repo.snapshots::
499         A mask of allowed snapshot-formats for this repo, restricted by the
500         "snapshots" global setting. Default value: <snapshots>.
501
502 repo.section::
503         Override the current section name for this repository. Default value:
504         none.
505
506 repo.source-filter::
507         Override the default source-filter. Default value: none. See also:
508         "enable-filter-overrides". See also: "FILTER API".
509
510 repo.url::
511         The relative url used to access the repository. This must be the first
512         setting specified for each repo. Default value: none.
513
514
515 REPOSITORY-SPECIFIC CGITRC FILE
516 -------------------------------
517 When the option "scan-path" is used to auto-discover git repositories, cgit
518 will try to parse the file "cgitrc" within any found repository. Such a
519 repo-specific config file may contain any of the repo-specific options
520 described above, except "repo.url" and "repo.path". Additionally, the "filter"
521 options are only acknowledged in repo-specific config files when
522 "enable-filter-overrides" is set to "1".
523
524 Note: the "repo." prefix is dropped from the option names in repo-specific
525 config files, e.g. "repo.desc" becomes "desc".
526
527
528 FILTER API
529 ----------
530 about filter::
531         This filter is given no arguments. The about text that is to be
532         filtered is available on standard input and the filtered text is
533         expected on standard output.
534
535 commit filter::
536         This filter is given no arguments. The commit message text that is to
537         be filtered is available on standard input and the filtered text is
538         expected on standard output.
539
540 source filter::
541         This filter is given a single parameter: the filename of the source
542         file to filter. The filter can use the filename to determine (for
543         example) the syntax highlighting mode. The contents of the source
544         file that is to be filtered is available on standard input and the
545         filtered contents is expected on standard output.
546
547 Also, all filters are handed the following environment variables:
548
549 - CGIT_REPO_URL (from repo.url)
550 - CGIT_REPO_NAME (from repo.name)
551 - CGIT_REPO_PATH (from repo.path)
552 - CGIT_REPO_OWNER (from repo.owner)
553 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
554 - CGIT_REPO_SECTION (from repo.section)
555 - CGIT_REPO_CLONE_URL (from repo.clone-url)
556
557 If a setting is not defined for a repository and the corresponding global
558 setting is also not defined (if applicable), then the corresponding
559 environment variable will be unset.
560
561
562 MACRO EXPANSION
563 ---------------
564 The following cgitrc options supports a simple macro expansion feature,
565 where tokens prefixed with "$" are replaced with the value of a similary
566 named environment variable:
567
568 - cache-root
569 - include
570 - project-list
571 - scan-path
572
573 Macro expansion will also happen on the content of $CGIT_CONFIG, if
574 defined.
575
576 One usage of this feature is virtual hosting, which in its simplest form
577 can be accomplished by adding the following line to /etc/cgitrc:
578
579         include=/etc/cgitrc.d/$HTTP_HOST
580
581 The following options are expanded during request processing, and support
582 the environment variables defined in "FILTER API":
583
584 - clone-url
585 - repo.clone-url
586
587
588 EXAMPLE CGITRC FILE
589 -------------------
590
591 ....
592 # Enable caching of up to 1000 output entriess
593 cache-size=1000
594
595
596 # Specify some default clone urls using macro expansion
597 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
598
599 # Specify the css url
600 css=/css/cgit.css
601
602
603 # Show extra links for each repository on the index page
604 enable-index-links=1
605
606
607 # Enable ASCII art commit history graph on the log pages
608 enable-commit-graph=1
609
610
611 # Show number of affected files per commit on the log pages
612 enable-log-filecount=1
613
614
615 # Show number of added/removed lines per commit on the log pages
616 enable-log-linecount=1
617
618
619 # Add a cgit favicon
620 favicon=/favicon.ico
621
622
623 # Use a custom logo
624 logo=/img/mylogo.png
625
626
627 # Enable statistics per week, month and quarter
628 max-stats=quarter
629
630
631 # Set the title and heading of the repository index page
632 root-title=example.com git repositories
633
634
635 # Set a subheading for the repository index page
636 root-desc=tracking the foobar development
637
638
639 # Include some more info about example.com on the index page
640 root-readme=/var/www/htdocs/about.html
641
642
643 # Allow download of tar.gz, tar.bz2 and zip-files
644 snapshots=tar.gz tar.bz2 zip
645
646
647 ##
648 ## List of common mimetypes
649 ##
650
651 mimetype.gif=image/gif
652 mimetype.html=text/html
653 mimetype.jpg=image/jpeg
654 mimetype.jpeg=image/jpeg
655 mimetype.pdf=application/pdf
656 mimetype.png=image/png
657 mimetype.svg=image/svg+xml
658
659
660 ##
661 ## List of repositories.
662 ## PS: Any repositories listed when section is unset will not be
663 ##     displayed under a section heading
664 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
665 ##      and included like this:
666 ##        include=/etc/cgitrepos
667 ##
668
669
670 repo.url=foo
671 repo.path=/pub/git/foo.git
672 repo.desc=the master foo repository
673 repo.owner=fooman@example.com
674 repo.readme=info/web/about.html
675
676
677 repo.url=bar
678 repo.path=/pub/git/bar.git
679 repo.desc=the bars for your foo
680 repo.owner=barman@example.com
681 repo.readme=info/web/about.html
682
683
684 # The next repositories will be displayed under the 'extras' heading
685 section=extras
686
687
688 repo.url=baz
689 repo.path=/pub/git/baz.git
690 repo.desc=a set of extensions for bar users
691
692 repo.url=wiz
693 repo.path=/pub/git/wiz.git
694 repo.desc=the wizard of foo
695
696
697 # Add some mirrored repositories
698 section=mirrors
699
700
701 repo.url=git
702 repo.path=/pub/git/git.git
703 repo.desc=the dscm
704
705
706 repo.url=linux
707 repo.path=/pub/git/linux.git
708 repo.desc=the kernel
709
710 # Disable adhoc downloads of this repo
711 repo.snapshots=0
712
713 # Disable line-counts for this repo
714 repo.enable-log-linecount=0
715
716 # Restrict the max statistics period for this repo
717 repo.max-stats=month
718 ....
719
720
721 BUGS
722 ----
723 Comments currently cannot appear on the same line as a setting; the comment
724 will be included as part of the value. E.g. this line:
725
726         robots=index  # allow indexing
727
728 will generate the following html element:
729
730         <meta name='robots' content='index  # allow indexing'/>
731
732
733
734 AUTHOR
735 ------
736 Lars Hjemli <hjemli@gmail.com>
737 Jason A. Donenfeld <Jason@zx2c4.com>