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 Sort items in the repo list case sensitively. Default value: "1".
75 See also: repository-sort, section-sort.
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:
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".
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".
96 Url which specifies the css document to include in all cgit pages.
97 Default value: "/cgit.css".
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
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".
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.
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".
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".
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
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
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".
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".
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".
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.
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.
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.
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.
172 The content of the file specified with this option will be included
173 verbatim at the top of all pages. Default value: none.
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".
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
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.
192 Flag which, if set to "1", makes cgit print commit and tag times in the
193 servers timezone. Default value: "0".
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
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".
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
211 Specifies the number of items to display in atom feeds view. Default
215 Specifies the number of entries to list per page in "log" view. Default
219 Specifies the maximum number of commit message characters to display in
220 "log" view. Default value: "80".
223 Specifies the number of entries to list per page on the repository
224 index page. Default value: "50".
226 max-repodesc-length::
227 Specifies the maximum number of repo description characters to display
228 on the repository index page. Default value: "80".
231 Specifies the maximum size of a blob to display HTML for in KBytes.
232 Default value: "0" (limit disabled).
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".
240 Set the mimetype for the specified filename extension. This is used
241 by the `plain` command when returning blob content.
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>".
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
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
267 If set to "1" showing full author email adresses will be disabled.
271 Flag which, when set to "1", will make cgit omit the standard header
272 on all pages. Default value: none. See also: "embedded".
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
281 Text which will be used as default value for "repo.readme". Default
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.
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".
295 Legacy alias for "section". This option is deprecated and will not be
296 supported in cgit-1.0.
299 Text used as content for the "robots" meta-tag. Default value:
303 Text printed below the heading on the repository index page. Default
304 value: "a fast webinterface for the git dscm".
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
312 Text printed as heading on the repository index page. Default value:
313 "Git Repository Browser".
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.
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,
334 The name of the current repository section - all repositories defined
335 after this option will inherit the current section name. Default value:
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.
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.
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".
357 If set to "1" shows side-by-side diffs instead of unidiffs per
358 default. Default value: "0".
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:
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".
375 Specifies the number of branches to display in the repository "summary"
376 view. Default value: "10".
379 Specifies the number of log entries to display in the repository
380 "summary" view. Default value: "10".
383 Specifies the number of tags to display in the repository "summary"
384 view. Default value: "10".
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
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
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.
405 Override the default about-filter. Default value: none. See also:
406 "enable-filter-overrides". See also: "FILTER API".
409 A list of space-separated urls which can be used to clone this repo.
410 Default value: none. See also: "MACRO EXPANSION".
413 Override the default commit-filter. Default value: none. See also:
414 "enable-filter-overrides". See also: "FILTER API".
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.
423 The value to show as repository description. Default value: none.
425 repo.enable-commit-graph::
426 A flag which can be used to disable the global setting
427 `enable-commit-graph'. Default value: none.
429 repo.enable-log-filecount::
430 A flag which can be used to disable the global setting
431 `enable-log-filecount'. Default value: none.
433 repo.enable-log-linecount::
434 A flag which can be used to disable the global setting
435 `enable-log-linecount'. Default value: none.
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>.
441 repo.enable-subject-links::
442 A flag which can be used to override the global setting
443 `enable-subject-links'. Default value: none.
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
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.
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.
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
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.
473 Override the default maximum statistics period. Valid values are equal
474 to the values specified for the global "max-stats" setting. Default
478 The value to show as repository name. Default value: <repo.url>.
481 A value used to identify the owner of the repository. Default value:
485 An absolute path to the repository directory. For non-bare repositories
486 this is the .git-directory. Default value: none.
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>.
495 A mask of allowed snapshot-formats for this repo, restricted by the
496 "snapshots" global setting. Default value: <snapshots>.
499 Override the current section name for this repository. Default value:
503 Override the default source-filter. Default value: none. See also:
504 "enable-filter-overrides". See also: "FILTER API".
507 The relative url used to access the repository. This must be the first
508 setting specified for each repo. Default value: none.
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".
520 Note: the "repo." prefix is dropped from the option names in repo-specific
521 config files, e.g. "repo.desc" becomes "desc".
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.
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.
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.
543 Also, all filters are handed the following environment variables:
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)
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.
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:
569 Macro expansion will also happen on the content of $CGIT_CONFIG, if
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:
575 include=/etc/cgitrc.d/$HTTP_HOST
577 The following options are expanded during request processing, and support
578 the environment variables defined in "FILTER API":
588 # Enable caching of up to 1000 output entriess
592 # Specify some default clone urls using macro expansion
593 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
595 # Specify the css url
599 # Show extra links for each repository on the index page
603 # Enable ASCII art commit history graph on the log pages
604 enable-commit-graph=1
607 # Show number of affected files per commit on the log pages
608 enable-log-filecount=1
611 # Show number of added/removed lines per commit on the log pages
612 enable-log-linecount=1
623 # Enable statistics per week, month and quarter
627 # Set the title and heading of the repository index page
628 root-title=example.com git repositories
631 # Set a subheading for the repository index page
632 root-desc=tracking the foobar development
635 # Include some more info about example.com on the index page
636 root-readme=/var/www/htdocs/about.html
639 # Allow download of tar.gz, tar.bz2 and zip-files
640 snapshots=tar.gz tar.bz2 zip
644 ## List of common mimetypes
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
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
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
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
680 # The next repositories will be displayed under the 'extras' heading
685 repo.path=/pub/git/baz.git
686 repo.desc=a set of extensions for bar users
689 repo.path=/pub/git/wiz.git
690 repo.desc=the wizard of foo
693 # Add some mirrored repositories
698 repo.path=/pub/git/git.git
703 repo.path=/pub/git/linux.git
706 # Disable adhoc downloads of this repo
709 # Disable line-counts for this repo
710 repo.enable-log-linecount=0
712 # Restrict the max statistics period for this repo
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:
722 robots=index # allow indexing
724 will generate the following html element:
726 <meta name='robots' content='index # allow indexing'/>
732 Lars Hjemli <hjemli@gmail.com>
733 Jason A. Donenfeld <Jason@zx2c4.com>