10 cgitrc - runtime configuration for cgit
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.
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.
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".
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".
44 Path used to store the cgit cache entries. Default value:
45 "/var/cache/cgit". See also: "MACRO EXPANSION".
48 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed without a fixed SHA1. Default
53 Number which specifies the time-to-live, in minutes, for the cached
54 version of the repository summary page. Default value: "5".
57 Number which specifies the time-to-live, in minutes, for the cached
58 version of the repository index page. Default value: "5".
61 Number which specifies the time-to-live, in minutes, for the result
62 of scanning a path for git repositories. Default value: "15".
65 The maximum number of entries in the cgit cache. Default value: "0"
66 (i.e. caching is disabled).
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:
74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This
76 setting is only used if `repo.clone-url` is unspecified. Default value:
80 Space-separated list of clone-url templates. This setting is only
81 used if `repo.clone-url` is unspecified. Default value: none. See
82 also: "MACRO EXPANSION", "FILTER API".
85 Specifies a command which will be invoked to format commit messages.
86 The command will get the message on its STDIN, and the STDOUT from the
87 command will be included verbatim as the commit message, i.e. this can
88 be used to implement bugtracker integration. Default value: none.
89 See also: "FILTER API".
92 Url which specifies the css document to include in all cgit pages.
93 Default value: "/cgit.css".
96 Flag which, when set to "1", will make cgit generate a html fragment
97 suitable for embedding in other html pages. Default value: none. See
100 enable-commit-graph::
101 Flag which, when set to "1", will make cgit print an ASCII-art commit
102 history graph to the left of the commit messages in the repository
103 log page. Default value: "0".
105 enable-filter-overrides::
106 Flag which, when set to "1", allows all filter settings to be
107 overridden in repository-specific cgitrc files. Default value: none.
109 enable-gitweb-owner::
110 If set to "1" and scan-path is enabled, we first check each repository
111 for the git config value "gitweb.owner" to determine the owner.
112 Default value: "1". See also: scan-path.
115 If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
116 If you use an alternate way of serving git repositories, you may wish
117 to disable this. Default value: "1".
120 Flag which, when set to "1", will make cgit generate extra links for
121 each repo in the repository index (specifically, to the "summary",
122 "commit" and "tree" pages). Default value: "0".
124 enable-log-filecount::
125 Flag which, when set to "1", will make cgit print the number of
126 modified files for each commit on the repository log page. Default
129 enable-log-linecount::
130 Flag which, when set to "1", will make cgit print the number of added
131 and removed lines for each commit on the repository log page. Default
134 enable-remote-branches::
135 Flag which, when set to "1", will make cgit display remote branches
136 in the summary and refs views. Default value: "0". See also:
137 "repo.enable-remote-branches".
139 enable-subject-links::
140 Flag which, when set to "1", will make cgit use the subject of the
141 parent commit as link text when generating links to parent commits
142 in commit view. Default value: "0". See also:
143 "repo.enable-subject-links".
145 enable-tree-linenumbers::
146 Flag which, when set to "1", will make cgit generate linenumber links
147 for plaintext blobs printed in the tree view. Default value: "1".
150 Url used as link to a shortcut icon for cgit. If specified, it is
151 suggested to use the value "/favicon.ico" since certain browsers will
152 ignore other values. Default value: none.
155 The content of the file specified with this option will be included
156 verbatim at the bottom of all pages (i.e. it replaces the standard
157 "generated by..." message. Default value: none.
160 The content of the file specified with this option will be included
161 verbatim in the html HEAD section on all pages. Default value: none.
164 The content of the file specified with this option will be included
165 verbatim at the top of all pages. Default value: none.
168 Name of a configfile to include before the rest of the current config-
169 file is parsed. Default value: none. See also: "MACRO EXPANSION".
172 The content of the file specified with this option will be included
173 verbatim above the repository index. This setting is deprecated, and
174 will not be supported by cgit-1.0 (use root-readme instead). Default
178 The content of the file specified with this option will be included
179 verbatim below the heading on the repository index page. This setting
180 is deprecated, and will not be supported by cgit-1.0 (use root-desc
181 instead). Default value: none.
184 Flag which, if set to "1", makes cgit print commit and tag times in the
185 servers timezone. Default value: "0".
188 Url which specifies the source of an image which will be used as a logo
189 on all cgit pages. Default value: "/cgit.png".
192 Url loaded when clicking on the cgit logo image. If unspecified the
193 calculated url of the repository index page will be used. Default
197 Specifies the number of items to display in atom feeds view. Default
201 Specifies the number of entries to list per page in "log" view. Default
205 Specifies the maximum number of commit message characters to display in
206 "log" view. Default value: "80".
209 Specifies the number of entries to list per page on the repository
210 index page. Default value: "50".
212 max-repodesc-length::
213 Specifies the maximum number of repo description characters to display
214 on the repository index page. Default value: "80".
217 Specifies the maximum size of a blob to display HTML for in KBytes.
218 Default value: "0" (limit disabled).
221 Set the default maximum statistics period. Valid values are "week",
222 "month", "quarter" and "year". If unspecified, statistics are
223 disabled. Default value: none. See also: "repo.max-stats".
226 Set the mimetype for the specified filename extension. This is used
227 by the `plain` command when returning blob content.
230 Specifies the file to use for automatic mimetype lookup. If specified
231 then this field is used as a fallback when no "mimetype.<ext>" match is
232 found. If unspecified then no such lookup is performed. The typical file
233 to use on a Linux system is /etc/mime.types. Default value: none. See
234 also: "mimetype.<ext>". The format of the file must comply to:
235 - a comment line is an empty line or a line starting with a hash (#),
236 optionally preceded by whitespace
237 - a non-comment line starts with the mimetype (like image/png), followed
238 by one or more file extensions (like jpg), all separated by whitespace
241 Text which will be used as the formatstring for a hyperlink when a
242 submodule is printed in a directory listing. The arguments for the
243 formatstring are the path and SHA1 of the submodule commit. Default
244 value: "./?repo=%s&page=commit&id=%s"
247 If set to the value "1" caching will be disabled. This settings is
248 deprecated, and will not be honored starting with cgit-1.0. Default
252 If set to "1" showing full author email adresses will be disabled.
256 Flag which, when set to "1", will make cgit omit the standard header
257 on all pages. Default value: none. See also: "embedded".
260 A list of subdirectories inside of scan-path, relative to it, that
261 should loaded as git repositories. This must be defined prior to
262 scan-path. Default value: none. See also: scan-path, "MACRO
266 Text which will be used as default value for "repo.readme". Default
270 If set to "1" and scan-path is enabled, if any repositories are found
271 with a suffix of ".git", this suffix will be removed for the url and
272 name. Default value: "0". See also: scan-path.
275 Maximum number of files to consider when detecting renames. The value
276 "-1" uses the compiletime value in git (for further info, look at
277 `man git-diff`). Default value: "-1".
280 Legacy alias for "section". This option is deprecated and will not be
281 supported in cgit-1.0.
284 Text used as content for the "robots" meta-tag. Default value:
288 Text printed below the heading on the repository index page. Default
289 value: "a fast webinterface for the git dscm".
292 The content of the file specified with this option will be included
293 verbatim below the "about" link on the repository index page. Default
297 Text printed as heading on the repository index page. Default value:
298 "Git Repository Browser".
301 If set to "1" and scan-path is enabled, scan-path will recurse into
302 directories whose name starts with a period ('.'). Otherwise,
303 scan-path will stay away from such directories (considered as
304 "hidden"). Note that this does not apply to the ".git" directory in
305 non-bare repos. This must be defined prior to scan-path.
306 Default value: 0. See also: scan-path.
309 A path which will be scanned for repositories. If caching is enabled,
310 the result will be cached as a cgitrc include-file in the cache
311 directory. If project-list has been defined prior to scan-path,
312 scan-path loads only the directories listed in the file pointed to by
313 project-list. Be advised that only the global settings taken
314 before the scan-path directive will be applied to each repository.
315 Default value: none. See also: cache-scanrc-ttl, project-list,
319 The name of the current repository section - all repositories defined
320 after this option will inherit the current section name. Default value:
324 A number which, if specified before scan-path, specifies how many
325 path elements from each repo path to use as a default section name.
326 If negative, cgit will discard the specified number of path elements
327 above the repo directory. Default value: 0.
330 If set to "1" shows side-by-side diffs instead of unidiffs per
331 default. Default value: "0".
334 Text which specifies the default set of snapshot formats generated by
335 cgit. The value is a space-separated list of zero or more of the
336 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
340 Specifies a command which will be invoked to format plaintext blobs
341 in the tree view. The command will get the blob content on its STDIN
342 and the name of the blob as its only command line argument. The STDOUT
343 from the command will be included verbatim as the blob contents, i.e.
344 this can be used to implement e.g. syntax highlighting. Default value:
345 none. See also: "FILTER API".
348 Specifies the number of branches to display in the repository "summary"
349 view. Default value: "10".
352 Specifies the number of log entries to display in the repository
353 "summary" view. Default value: "10".
356 Specifies the number of tags to display in the repository "summary"
357 view. Default value: "10".
360 Filename which, if specified, needs to be present within the repository
361 for cgit to allow access to that repository. This can be used to emulate
362 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
363 repositories to match those exported by git-daemon. This option MUST come
367 Url which, if specified, will be used as root for all cgit links. It
368 will also cause cgit to generate 'virtual urls', i.e. urls like
369 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
371 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
372 same kind of virtual urls, so this option will probably be deprecated.
377 Override the default about-filter. Default value: none. See also:
378 "enable-filter-overrides". See also: "FILTER API".
381 A list of space-separated urls which can be used to clone this repo.
382 Default value: none. See also: "MACRO EXPANSION".
385 Override the default commit-filter. Default value: none. See also:
386 "enable-filter-overrides". See also: "FILTER API".
389 The name of the default branch for this repository. If no such branch
390 exists in the repository, the first branch name (when sorted) is used
391 as default instead. Default value: "master".
394 The value to show as repository description. Default value: none.
396 repo.enable-commit-graph::
397 A flag which can be used to disable the global setting
398 `enable-commit-graph'. Default value: none.
400 repo.enable-log-filecount::
401 A flag which can be used to disable the global setting
402 `enable-log-filecount'. Default value: none.
404 repo.enable-log-linecount::
405 A flag which can be used to disable the global setting
406 `enable-log-linecount'. Default value: none.
408 repo.enable-remote-branches::
409 Flag which, when set to "1", will make cgit display remote branches
410 in the summary and refs views. Default value: <enable-remote-branches>.
412 repo.enable-subject-links::
413 A flag which can be used to override the global setting
414 `enable-subject-links'. Default value: none.
417 Url which specifies the source of an image which will be used as a logo
418 on this repo's pages. Default value: global logo.
421 Url loaded when clicking on the cgit logo image. If unspecified the
422 calculated url of the repository index page will be used. Default
423 value: global logo-link.
426 Text which will be used as the formatstring for a hyperlink when a
427 submodule is printed in a directory listing. The arguments for the
428 formatstring are the path and SHA1 of the submodule commit. Default
432 Override the default maximum statistics period. Valid values are equal
433 to the values specified for the global "max-stats" setting. Default
437 The value to show as repository name. Default value: <repo.url>.
440 A value used to identify the owner of the repository. Default value:
444 An absolute path to the repository directory. For non-bare repositories
445 this is the .git-directory. Default value: none.
448 A path (relative to <repo.path>) which specifies a file to include
449 verbatim as the "About" page for this repo. You may also specify a
450 git refspec by head or by hash by prepending the refspec followed by
451 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
454 A mask of allowed snapshot-formats for this repo, restricted by the
455 "snapshots" global setting. Default value: <snapshots>.
458 Override the current section name for this repository. Default value:
462 Override the default source-filter. Default value: none. See also:
463 "enable-filter-overrides". See also: "FILTER API".
466 The relative url used to access the repository. This must be the first
467 setting specified for each repo. Default value: none.
470 REPOSITORY-SPECIFIC CGITRC FILE
471 -------------------------------
472 When the option "scan-path" is used to auto-discover git repositories, cgit
473 will try to parse the file "cgitrc" within any found repository. Such a
474 repo-specific config file may contain any of the repo-specific options
475 described above, except "repo.url" and "repo.path". Additionally, the "filter"
476 options are only acknowledged in repo-specific config files when
477 "enable-filter-overrides" is set to "1".
479 Note: the "repo." prefix is dropped from the option names in repo-specific
480 config files, e.g. "repo.desc" becomes "desc".
486 This filter is given no arguments. The about text that is to be
487 filtered is available on standard input and the filtered text is
488 expected on standard output.
491 This filter is given no arguments. The commit message text that is to
492 be filtered is available on standard input and the filtered text is
493 expected on standard output.
496 This filter is given a single parameter: the filename of the source
497 file to filter. The filter can use the filename to determine (for
498 example) the syntax highlighting mode. The contents of the source
499 file that is to be filtered is available on standard input and the
500 filtered contents is expected on standard output.
502 Also, all filters are handed the following environment variables:
504 - CGIT_REPO_URL (from repo.url)
505 - CGIT_REPO_NAME (from repo.name)
506 - CGIT_REPO_PATH (from repo.path)
507 - CGIT_REPO_OWNER (from repo.owner)
508 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
509 - CGIT_REPO_SECTION (from repo.section)
510 - CGIT_REPO_CLONE_URL (from repo.clone-url)
512 If a setting is not defined for a repository and the corresponding global
513 setting is also not defined (if applicable), then the corresponding
514 environment variable will be an empty string.
519 The following cgitrc options supports a simple macro expansion feature,
520 where tokens prefixed with "$" are replaced with the value of a similary
521 named environment variable:
528 Macro expansion will also happen on the content of $CGIT_CONFIG, if
531 One usage of this feature is virtual hosting, which in its simplest form
532 can be accomplished by adding the following line to /etc/cgitrc:
534 include=/etc/cgitrc.d/$HTTP_HOST
536 The following options are expanded during request processing, and support
537 the environment variables defined in "FILTER API":
547 # Enable caching of up to 1000 output entriess
551 # Specify some default clone urls using macro expansion
552 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
554 # Specify the css url
558 # Show extra links for each repository on the index page
562 # Enable ASCII art commit history graph on the log pages
563 enable-commit-graph=1
566 # Show number of affected files per commit on the log pages
567 enable-log-filecount=1
570 # Show number of added/removed lines per commit on the log pages
571 enable-log-linecount=1
582 # Enable statistics per week, month and quarter
586 # Set the title and heading of the repository index page
587 root-title=example.com git repositories
590 # Set a subheading for the repository index page
591 root-desc=tracking the foobar development
594 # Include some more info about example.com on the index page
595 root-readme=/var/www/htdocs/about.html
598 # Allow download of tar.gz, tar.bz2 and zip-files
599 snapshots=tar.gz tar.bz2 zip
603 ## List of common mimetypes
606 mimetype.gif=image/gif
607 mimetype.html=text/html
608 mimetype.jpg=image/jpeg
609 mimetype.jpeg=image/jpeg
610 mimetype.pdf=application/pdf
611 mimetype.png=image/png
612 mimetype.svg=image/svg+xml
616 ## List of repositories.
617 ## PS: Any repositories listed when section is unset will not be
618 ## displayed under a section heading
619 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
620 ## and included like this:
621 ## include=/etc/cgitrepos
626 repo.path=/pub/git/foo.git
627 repo.desc=the master foo repository
628 repo.owner=fooman@example.com
629 repo.readme=info/web/about.html
633 repo.path=/pub/git/bar.git
634 repo.desc=the bars for your foo
635 repo.owner=barman@example.com
636 repo.readme=info/web/about.html
639 # The next repositories will be displayed under the 'extras' heading
644 repo.path=/pub/git/baz.git
645 repo.desc=a set of extensions for bar users
648 repo.path=/pub/git/wiz.git
649 repo.desc=the wizard of foo
652 # Add some mirrored repositories
657 repo.path=/pub/git/git.git
662 repo.path=/pub/git/linux.git
665 # Disable adhoc downloads of this repo
668 # Disable line-counts for this repo
669 repo.enable-log-linecount=0
671 # Restrict the max statistics period for this repo
678 Comments currently cannot appear on the same line as a setting; the comment
679 will be included as part of the value. E.g. this line:
681 robots=index # allow indexing
683 will generate the following html element:
685 <meta name='robots' content='index # allow indexing'/>
691 Lars Hjemli <hjemli@gmail.com>
692 Jason A. Donenfeld <Jason@zx2c4.com>