cgitrc - runtime configuration for cgit ======================================= Cgitrc contains all runtime settings for cgit, including the list of git repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank lines, and lines starting with '#' or ';', are ignored, and so is a line carrying no '='. A comment cannot share a line with a setting, since everything after the '=' belongs to the value. A NAME cgit does not recognise is ignored with a warning on stderr, which the web server collects in its error log. 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, the name of the file as the first argument, and the STDOUT from the command will be included verbatim on the about page. Default value: none. When no about-filter is set, the readme is escaped and served as plain text. A bundled Lua filter, about-render.lua, renders markdown, man pages and plain text when about-filter points at it. See also: "Filter API". age-file:: 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. The first line in the file is used as input to the "parse_date" function in libgit. Recommended timestamp-format is "yyyy-mm-dd hh:mm:ss". You may want to generate this file from a post-receive hook. Default value: "info/web/last-modified". auth-filter:: Specifies a command that will be invoked for authenticating repository access. Receives 12 arguments, with request data on stdin and its answer on stdout, as described under "Filter API". If no auth-filter is specified, no authentication is performed. Default value: none. branch-sort:: Flag which, when set to "age", enables date ordering in the branch ref list, and when set to "name" enables ordering by branch name. Default value: "name". cache-about-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of the repository about page. See also: "The cache". Default value: "15". cache-dynamic-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed without a fixed SHA1. See also: "The cache". Default value: "5". cache-index-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of the repository index page. See also: "The cache". Default value: "5". cache-root:: Path used to store the cgit cache entries. Default value: "/var/cache/cgit". See also: "Macro expansion" and the note on ownership under "The cache". cache-scan-ttl:: Number which specifies the time-to-live, in minutes, for the result of scanning a path for git repositories. See also: "The cache". Default value: "15". cache-size:: The maximum number of entries in the cgit cache. When set to "0", caching is disabled. See also: "The cache". Default value: "0". cache-snapshot-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of snapshots. A snapshot requested with a fixed object id uses "cache-static-ttl" instead, since its content can never change. See also: "The cache". Default value: "5". cache-static-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of repository pages accessed with a fixed SHA1. See also: "The cache". Default value: "-1". cache-summary-ttl:: Number which specifies the time-to-live, in minutes, for the cached version of the repository summary page. See also: "The cache". Default value: "5". case-sensitive-sort:: Sort items in the repo list case sensitively. Default value: "1". See also: repository-sort, section-sort. clone-prefix:: Space-separated list of common prefixes which, when combined with a repository url, generates valid clone urls for the repository. This setting is only used if `repo.clone-url` is unspecified. Default value: none. clone-url:: Space-separated list of clone-url templates. This setting is only used if `repo.clone-url` is unspecified. Default value: none. See also: "Macro expansion", "Filter API". 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. See also: "Filter API". commit-sort:: Flag which, when set to "date", enables strict date ordering in the commit log, and when set to "topo" enables strict topological ordering. If unset, the default ordering of "git log" is used. Default value: unset. css:: Url which specifies the css document to include in all cgit pages. Default value: "/cgit.css". May be given multiple times, each css URL path is added in the head section of the document in turn. Setting this to an empty string will disable generation of the link to this file in the head section. date-format:: Format used for the calendar dates in the age columns of the log, refs and index pages, both when "enable-relative-dates" is off and when a log entry is too old to be shown as an age. Accepts the same names as git's --date option: "default", "human", "iso" (or "iso8601"), "iso-strict" (or "iso8601-strict"), "raw", "relative", "rfc" (or "rfc2822"), "short" and "unix", each of which may carry a "-local" suffix, plus "format:" for an arbitrary layout. An unrecognised value is ignored. Dates elsewhere, such as the author and committer lines on the commit page, are always ISO 8601 and are not affected, nor are the exact timestamps shown on hover. Default value: "short". See also: "local-time". email-filter:: Specifies a command which will be invoked to format names and email address of committers, authors, and taggers, as represented in various places throughout the cgit interface. This command will receive an email address and an origin page string as its command line arguments, and the text to format on STDIN. It is to write the formatted text back out onto STDOUT. Default value: none. See also: "Filter API". embedded:: Flag which, when set to "1", will make cgit generate a html fragment suitable for embedding in other html pages. Default value: "0". See also: "enable-header". enable-blame:: Flag which, when set to "1", will allow cgit to provide a "blame" page for files, and will make it generate links to that page in appropriate places. Default value: "0". enable-cache-list:: Flag which, when set to "1", exposes the "ls_cache" page. That page lists the cache directory path and the URLs of requests other visitors made, so it is disabled by default and should stay off on any instance where that disclosure matters. Default value: "0". enable-commit-graph:: Flag which, when set to "1", will make cgit print an ASCII-art commit history graph to the left of the commit messages in the repository log page. Default value: "0". enable-follow-links:: Flag which, when set to "1", allows users to follow a file in the log view. Default value: "0". enable-git-config:: Flag which, when set to "1", will allow cgit to use git config to set any repo specific settings. This option is used in conjunction with "scan-path", and must be defined prior, to augment repo-specific settings. The keys gitweb.owner, gitweb.category, and gitweb.description will map to the cgit keys repo.owner, repo.section, and repo.desc respectively. All git config keys that begin with "cgit." will be mapped to the corresponding "repo." key in cgit, subject to "trust-scan-config" the way a repository's cgitrc is. Default value: "0". See also: scan-path, section-from-path, trust-scan-config. enable-gitmodules-links:: Flag which, when set to "1", makes submodule listings derive a link from the url recorded in the .gitmodules file at the shown revision, for submodules that no module-link template covers. The url is first matched, by its trailing path components, against the repositories served by this cgit instance, so ssh, file and relative urls still get a link when their target is hosted here, and the commit hash then links to the target repository's commit page. Otherwise a plain http or https url is linked as it is, an ssh url to a well-known public host is rewritten to its https form, and any other url is left unlinked and shown as a tooltip instead. Default value: "0". See also: "repo.enable-gitmodules-links". enable-header:: Flag which, when set to "0", makes cgit omit the standard header on all pages. Default value: "1". See also: "embedded". enable-html-serving:: Flag which, when set to "1", will allow the /plain handler to serve mimetype headers that result in the file being treated as HTML by the browser. When set to "0", such file types are returned instead as text/plain or application/octet-stream. Default value: "0". See also: "repo.enable-html-serving". enable-http-clone:: If set to "1", cgit will act as a dumb HTTP endpoint for git clones. You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url to expose this feature. If you use an alternate way of serving git repositories, you may wish to disable this. Default value: "1". 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", "commit" and "tree" pages). Default value: "0". enable-index-owner:: Flag which, when set to "1", will make cgit display the owner of each repo in the repository index. Default value: "1". enable-log-filecount:: Flag which, when set to "1", will make cgit print the number of modified files for each commit on the repository log page. Default value: "0". enable-log-linecount:: Flag which, when set to "1", will make cgit print the number of added and removed lines for each commit on the repository log page. Default value: "0". enable-mailmap:: Flag which, when set to "1", applies the repository's mailmap to every author, committer and tagger shown, so a person who changed name or address appears under one identity in the log, commit, tag, blame and statistics pages, the atom feed and the author search. Only the .mailmap blob at HEAD is read, as git does for a bare repository, and the mailmap.file and mailmap.blob settings are ignored. Default value: "1". See also: "repo.enable-mailmap". enable-plain-email:: Flag which, when set to "0", hides the full author, committer and tagger email addresses wherever they would be shown beside the name. Default value: "1". enable-relative-dates:: Flag which, when set to "1", shows the age columns of the log, refs and index pages as an elapsed time such as "3 days" rather than a calendar date. When set to "0" those columns always show a date, formatted according to "date-format". Default value: "1". enable-remote-branches:: Flag which, when set to "1", will make cgit display remote branches in the summary and refs views. Default value: "0". See also: "repo.enable-remote-branches". enable-subject-links:: Flag which, when set to "1", will make cgit use the subject of the parent commit as link text when generating links to parent commits in commit view. Default value: "0". See also: "repo.enable-subject-links". enable-trailers:: Flag which, when set to "1", makes the commit page split the trailer block, the Signed-off-by lines and their kin, off the end of the commit message and show it as a table under the message. The block is found the way git finds it for "git interpret-trailers": the last paragraph is taken when every line in it is a trailer, or when it holds a Signed-off-by and at least a quarter of its lines are trailers. Default value: "0". See also: "trailer-filter", "repo.enable-trailers". enable-tree-group-dirs:: Flag which, when set to "1", makes the tree view list all directories first, sorted, followed by the files. When set to "0", entries appear in git's own order, with directories and files intermixed by name. 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 the icon for cgit. Any path works, but keeping the value "/favicon.ico" is still worthwhile, since clients that do not parse the page head probe that path directly. Default value: "/favicon.ico". footer:: The content of the file specified with this option will be included verbatim at the bottom of all pages (it replaces the standard "generated by..." message). Default value: none. head-include:: The content of the file specified with this option will be included verbatim in the html HEAD section on all pages. Default value: none. header:: The content of the file specified with this option will be included verbatim at the top of all pages. Default value: none. include:: Name of a configfile to include before the rest of the current configfile is parsed. Includes may nest eight levels deep, and anything deeper is ignored. Default value: none. See also: "Macro expansion". js:: Url which specifies the javascript script document to include in all cgit pages. Default value: "/cgit.js". Setting this to an empty string will disable generation of the link to this file in the head section. local-time:: Flag which, if set to "1", makes cgit print commit and tag times in the servers timezone. Default value: "0". See also: "date-format". logo:: Url which specifies the source of an image which will be used as a logo on all cgit pages. Default value: "/cgit.png". logo-link:: Url loaded when clicking on the cgit logo image. If unspecified the calculated url of the repository index page will be used. Default value: none. max-atom-items:: Specifies the number of items to display in atom feeds view. Default value: "10". max-blob-size:: Specifies the maximum size in KBytes of a blob that cgit will read into memory to serve. It caps both the HTML blob view and the raw "plain" and "blob" output, and a larger object is refused rather than loaded whole. Default value: "10240" (10 MB). Set to "0" to disable the limit. max-commit-count:: Specifies the number of entries to list per page in "log" view. Default value: "50". max-diff-files:: If a commit changes more files than this, the "commit" and "diff" views show only the diffstat, where each file links to its own diff page. The "rawdiff" and "patch" views are never limited. Default value: "200". Set to "0" to always render every file inline. max-diff-lines:: If a single file's diff spans more lines than this, the whole-commit views print a note in its place linking to the file's own diff page, which always renders in full. Default value: "1000". Set to "0" to always render oversized files inline. max-message-length:: Specifies the maximum number of commit message characters to display in "log" view. Default value: "80". max-patch-count:: Specifies the maximum number of commits emitted as a series by the "patch" view when an explicit revision range is requested. A single commit is unaffected. Default value: "50". Set to "0" for no limit. max-ref-count:: Specifies the number of branches and tags to list per section on the "refs" view, and per page on the dedicated branch and tag pages that its overflow links lead to. Default value: "200". Set to "0" to list every ref on one page. max-repo-count:: Specifies the number of entries to list per page on the repository index page. A value of "0" or less shows all repositories without limitation. Default value: "50". max-repodesc-length:: Specifies the maximum number of repo description characters to display on the repository index page. Default value: "80". max-stats:: Enable the statistics page, which holds the commits-per-author table, and set the coarsest period it offers. Valid values are "week", "month", "quarter" and "year", each of which also offers the finer periods before it. If unspecified, statistics are disabled. Default value: none. See also: "repo.max-stats". mimetype-file:: Specifies the file to use for automatic mimetype lookup. If specified then this field is used as a fallback when no "mimetype." match is found. If unspecified then no such lookup is performed. The typical file to use on a Linux system is /etc/mime.types. The format of the file must comply to: - a comment line is an empty line or a line starting with a hash (#), optionally preceded by whitespace - a non-comment line starts with the mimetype (like image/png), followed by one or more file extensions (like jpg), all separated by whitespace Default value: none. See also: "mimetype.". mimetype.:: 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 formatstring are the name of the submodule directory and the SHA1 of the submodule commit. Default value: none. project-list:: A list of subdirectories inside of scan-path, relative to it, that should be loaded as git repositories. This must be defined prior to scan-path. Default value: none. See also: scan-path, "Macro expansion". readme:: Text which will be used as default value for "repo.readme". Multiple config keys may be specified, and cgit will use the first found file in this list. This is useful in conjunction with scan-path. Default value: none. See also: scan-path, repo.readme. remove-suffix:: If set to "1" and scan-path is enabled, if any repositories are found with a suffix of ".git", this suffix will be removed for the url and name. This must be defined prior to scan-path. Default value: "0". See also: scan-path. rename-limit:: 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". repository-sort:: The way in which repositories in each section are sorted. Valid values are "name" for sorting by the repo name or "age" for sorting by the most recently updated repository. Default value: "name". See also: section, case-sensitive-sort, section-sort. robots:: Text used as content for the "robots" meta-tag. Default value: "index, nofollow". root-desc:: Text printed below the heading on the repository index page. Default value: "a fast webinterface for the git dscm". root-readme:: The content of the file specified with this option will be included verbatim below the "about" link on the repository index page. Default value: none. root-title:: Text printed as heading on the repository index page. Default value: "Git repository browser". scan-hidden-path:: If set to "1" and scan-path is enabled, scan-path will recurse into directories whose name starts with a period ('.'). Otherwise, scan-path will stay away from such directories (considered as "hidden"). Note that this does not apply to the ".git" directory in non-bare repos. This must be defined prior to scan-path. Default value: "0". See also: scan-path. 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. If project-list has been defined prior to scan-path, scan-path loads only the directories listed in the file pointed to by project-list. A repository containing a file named "noweb" is skipped, the reverse of what "strict-export" checks. Be advised that only the global settings taken before the scan-path directive will be applied to each repository. That holds for every setting a repository inherits, among them section, snapshots, readme, the filters and the enable flags, not only the entries that say so explicitly. Default value: none. See also: cache-scan-ttl, project-list, strict-export, "Macro expansion". section:: The name of the current repository section. All repositories defined after this option will inherit the current section name. Default value: none. section-from-path:: A number which, if defined prior to scan-path, specifies how many path elements from each repo path to use as a default section name. If negative, cgit will discard the specified number of path elements above the repo directory. Default value: "0". section-sort:: Flag which, when set to "1", will sort the sections on the repository listing by name, along with the repositories within each section. Set this flag to "0" to preserve the order in the cgitrc file. Default value: "0". See also: section, case-sensitive-sort, repository-sort. side-by-side-diffs:: If set to "1" shows side-by-side diffs instead of unidiffs by default. Default value: "0". snapshots:: Text which specifies the default set of snapshot formats that cgit generates links for. The value is a space-separated list of zero or more of the values "tar", "tar.gz", "tar.bz2", "tar.lz", "tar.xz", "tar.zst" and "zip". The special value "all" enables all snapshot formats. Default value: none. All compressors use default settings. Some settings can be influenced with environment variables, for example set ZSTD_CLEVEL=10 in web server environment for higher (but slower) zstd compression. 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. When no source-filter is configured, cgit serves the text plain. A ready syntax highlighter using the Scintillua lexer collection ships as custom/extensions/syntax-highlight.lua, see the comments in that file for its dependencies. Default value: none. See also: "Filter API". strict-export:: Filename which, if specified, needs to be present within the repository for cgit to allow access to that repository. This can be used to emulate gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's repositories to match those exported by git-daemon. This option must be defined prior to scan-path. Default value: none. See also: scan-path. summary-branches:: Specifies the number of branches to display in the repository "summary" view. Default value: "10". summary-log:: Specifies the number of log entries to display in the repository "summary" view. Default value: "10". summary-tags:: Specifies the number of tags to display in the repository "summary" view. Default value: "10". trailer-filter:: Specifies a command which will be invoked to format the value of a commit trailer when "enable-trailers" is set. The command will get the trailer key and an origin page string as its command line arguments and the value on its STDIN, and the STDOUT from the command will be included verbatim as the value. Trailers whose value is a name and email address, such as Signed-off-by, go through the email-filter instead, and when no trailer-filter is configured the remaining values go through the commit-filter. A ready filter linking Fixes, Closes and URL values ships as custom/extensions/link-trailers.lua. Default value: none. See also: "Filter API". trust-scan-config:: Flag which, when set to "1", honours every setting in a repository's own cgitrc file and git config found by "scan-path". Those files belong to whoever can push to the repository, so without it the settings that run a command, put raw markup on the page, place a link or read a file off the disk are ignored with a warning. Those are the filters, head-content, module-link, logo, logo-link, clone-url and a readme that names a file rather than a git object. Settings in the main cgitrc, the "repo.