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