+:man source: cgit
+:man manual: cgit
+
CGITRC(5)
========
lines, and lines starting with '#', are ignored.
+LOCATION
+--------
+The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
+runtime, cgit will consult the environment variable CGIT_CONFIG and, if
+defined, use its value instead.
+
+
GLOBAL SETTINGS
---------------
+about-filter::
+ Specifies a command which will be invoked to format the content of
+ about pages (both top-level and for each repository). The command will
+ get the content of the about-file on its STDIN, and the STDOUT from the
+ command will be included verbatim on the about page. Default value:
+ none.
+
agefile::
Specifies a path, relative to each repository path, which can be used
to specify the date and time of the youngest commit in the repository.
Number which specifies the time-to-live, in minutes, for the cached
version of the repository index page. Default value: "5".
+cache-scanrc-ttl::
+ Number which specifies the time-to-live, in minutes, for the result
+ of scanning a path for git repositories. Default value: "15".
+
cache-size::
The maximum number of entries in the cgit cache. Default value: "0"
(i.e. caching is disabled).
setting is only used if `repo.clone-url` is unspecified. Default value:
none.
+commit-filter::
+ Specifies a command which will be invoked to format commit messages.
+ The command will get the message on its STDIN, and the STDOUT from the
+ command will be included verbatim as the commit message, i.e. this can
+ be used to implement bugtracker integration. Default value: none.
+
css::
Url which specifies the css document to include in all cgit pages.
Default value: "/cgit.css".
+embedded::
+ Flag which, when set to "1", will make cgit generate a html fragment
+ suitable for embedding in other html pages. Default value: none. See
+ also: "noheader".
+
+enable-filter-overrides::
+ Flag which, when set to "1", allows all filter settings to be
+ overridden in repository-specific cgitrc files. Default value: none.
+
enable-index-links::
Flag which, when set to "1", will make cgit generate extra links for
each repo in the repository index (specifically, to the "summary",
and removed lines for each commit on the repository log page. Default
value: "0".
+enable-tree-linenumbers::
+ Flag which, when set to "1", will make cgit generate linenumber links
+ for plaintext blobs printed in the tree view. Default value: "1".
+
favicon::
Url used as link to a shortcut icon for cgit. If specified, it is
suggested to use the value "/favicon.ico" since certain browsers will
logo::
Url which specifies the source of an image which will be used as a logo
- on all cgit pages.
+ on all cgit pages. Default value: "/cgit.png".
logo-link::
Url loaded when clicking on the cgit logo image. If unspecified the
"month", "quarter" and "year". If unspecified, statistics are
disabled. Default value: none. See also: "repo.max-stats".
+mimetype.<ext>::
+ Set the mimetype for the specified filename extension. This is used
+ by the `plain` command when returning blob content.
+
module-link::
Text which will be used as the formatstring for a hyperlink when a
submodule is printed in a directory listing. The arguments for the
deprecated, and will not be honored starting with cgit-1.0. Default
value: "0".
+noplainemail::
+ If set to "1" showing full author email adresses will be disabled.
+ Default value: "0".
+
+noheader::
+ Flag which, when set to "1", will make cgit omit the standard header
+ on all pages. Default value: none. See also: "embedded".
+
renamelimit::
Maximum number of files to consider when detecting renames. The value
"-1" uses the compiletime value in git (for further info, look at
`man git-diff`). Default value: "-1".
repo.group::
- A value for the current repository group, which all repositories
- specified after this setting will inherit. Default value: none.
+ Legacy alias for "section". This option is deprecated and will not be
+ supported in cgit-1.0.
robots::
Text used as content for the "robots" meta-tag. Default value:
Text printed as heading on the repository index page. Default value:
"Git Repository Browser".
+scan-path::
+ A path which will be scanned for repositories. If caching is enabled,
+ the result will be cached as a cgitrc include-file in the cache
+ directory. Default value: none. See also: cache-scanrc-ttl.
+
+section::
+ The name of the current repository section - all repositories defined
+ after this option will inherit the current section name. Default value:
+ none.
+
snapshots::
- Text which specifies the default (and allowed) set of snapshot formats
- supported by cgit. The value is a space-separated list of zero or more
- of the following values:
- "tar" uncompressed tar-file
- "tar.gz" gzip-compressed tar-file
- "tar.bz2" bzip-compressed tar-file
- "zip" zip-file
- Default value: none.
+ Text which specifies the default set of snapshot formats generated by
+ cgit. The value is a space-separated list of zero or more of the
+ values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
+
+source-filter::
+ Specifies a command which will be invoked to format plaintext blobs
+ in the tree view. The command will get the blob content on its STDIN
+ and the name of the blob as its only command line argument. The STDOUT
+ from the command will be included verbatim as the blob contents, i.e.
+ this can be used to implement e.g. syntax highlighting. Default value:
+ none.
summary-branches::
Specifies the number of branches to display in the repository "summary"
REPOSITORY SETTINGS
-------------------
+repo.about-filter::
+ Override the default about-filter. Default value: none. See also:
+ "enable-filter-overrides".
+
repo.clone-url::
A list of space-separated urls which can be used to clone this repo.
Default value: none.
+repo.commit-filter::
+ Override the default commit-filter. Default value: none. See also:
+ "enable-filter-overrides".
+
repo.defbranch::
The name of the default branch for this repository. If no such branch
exists in the repository, the first branch name (when sorted) is used
A mask of allowed snapshot-formats for this repo, restricted by the
"snapshots" global setting. Default value: <snapshots>.
+repo.section::
+ Override the current section name for this repository. Default value:
+ none.
+
+repo.source-filter::
+ Override the default source-filter. Default value: none. See also:
+ "enable-filter-overrides".
+
repo.url::
The relative url used to access the repository. This must be the first
setting specified for each repo. Default value: none.
+REPOSITORY-SPECIFIC CGITRC FILE
+-------------------------------
+When the option "scan-path" is used to auto-discover git repositories, cgit
+will try to parse the file "cgitrc" within any found repository. Such a
+repo-specific config file may contain any of the repo-specific options
+described above, except "repo.url" and "repo.path". Additionally, the "filter"
+options are only acknowledged in repo-specific config files when
+"enable-filter-overrides" is set to "1".
+
+Note: the "repo." prefix is dropped from the option names in repo-specific
+config files, e.g. "repo.desc" becomes "desc".
+
+
EXAMPLE CGITRC FILE
-------------------
snapshots=tar.gz tar.bz2 zip
+##
+## List of common mimetypes
+##
+
+mimetype.git=image/git
+mimetype.html=text/html
+mimetype.jpg=image/jpeg
+mimetype.jpeg=image/jpeg
+mimetype.pdf=application/pdf
+mimetype.png=image/png
+mimetype.svg=image/svg+xml
+
+
##
## List of repositories.
-## PS: Any repositories listed when repo.group is unset will not be
-## displayed under a group heading
+## PS: Any repositories listed when section is unset will not be
+## displayed under a section heading
## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
## and included like this:
## include=/etc/cgitrepos
# The next repositories will be displayed under the 'extras' heading
-repo.group=extras
+section=extras
repo.url=baz
# Add some mirrored repositories
-repo.group=mirrors
+section=mirrors
repo.url=git
git.ckatri.com / cgit.git / blobdiff