Diff options
| author | Bryce Kwon <bryce@brycekwon.com> | |
|---|---|---|
| committer | Bryce Kwon <bryce@brycekwon.com> | |
| commit | ||
| parent | ||
| tree | ||
| download | ||
Unify the docs, samples and extensions
Diffstat (limited to 'MANUAL.txt')
| -rw-r--r-- | MANUAL.txt | 413 |
1 file changed, 201 insertions, 212 deletions
@@ -1,7 +1,7 @@ cgitrc - runtime configuration for cgit ======================================= -Cgitrc contains all runtime settings for cgit, including the list of git +cgitrc holds 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 @@ -19,8 +19,8 @@ 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 + 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 @@ -29,15 +29,14 @@ about-filter:: 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". + first line in the file is read by git's date parser, and the recommended + form is "yyyy-mm-dd hh:mm:ss". A post-receive hook can write this file. + 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 + 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:: @@ -52,8 +51,8 @@ cache-about-ttl:: 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". + version of repository pages accessed without a fixed object id. See + also: "The cache". Default value: "5". cache-index-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -82,8 +81,8 @@ cache-snapshot-ttl:: 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". + version of repository pages accessed with a fixed object id. See also: + "The cache". Default value: "-1". cache-summary-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -91,32 +90,31 @@ cache-summary-ttl:: value: "5". case-sensitive-sort:: - Sort items in the repo list case sensitively. Default value: "1". See - also: repository-sort, section-sort. + Sort items in the repository 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: + 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: + 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". + command will get the message on its stdin, and the stdout from the + command will be included verbatim as the commit message, which is one + way to link a bug tracker. 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. + none. css:: Url which specifies the css document to include in all cgit pages. @@ -143,18 +141,18 @@ email-filter:: 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". + 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 + Flag which, when set to "1", makes 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". + Flag which, when set to "1", lets cgit provide a "blame" page for files + and makes 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 @@ -163,24 +161,23 @@ enable-cache-list:: where that disclosure matters. Default value: "0". enable-commit-graph:: - Flag which, when set to "1", will make cgit print an ASCII-art commit + Flag which, when set to "1", makes 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". + page. 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. + Flag which, when set to "1", lets cgit read repository settings from git + config. This option is used in conjunction with "scan-path", and must be + defined prior, to augment repository settings. The keys gitweb.owner, + gitweb.category, and gitweb.description map to the cgit keys repo.owner, + repo.section, and repo.desc respectively. All git config keys that begin + with "cgit." are 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 @@ -200,44 +197,44 @@ enable-header:: 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: + Flag which, when set to "1", lets the /plain handler 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". + If set to "1", cgit acts as a dumb HTTP endpoint for git clones. Adding + "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url exposes it. + A site that serves git repositories another way can turn this off. + 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". + Flag which, when set to "1", makes cgit generate extra links for each + repository in the index, 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". + Flag which, when set to "1", makes cgit display the owner of each + repository in the index. Default value: "1". enable-log-filecount:: - Flag which, when set to "1", will make cgit print the number of modified + Flag which, when set to "1", makes 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". + Flag which, when set to "1", makes 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". + 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 @@ -251,34 +248,33 @@ enable-relative-dates:: 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: + Flag which, when set to "1", makes cgit display remote branches in the + summary and refs pages. 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". + Flag which, when set to "1", makes cgit use the subject of the parent + commit as link text when generating links to parent commits in the + commit page. 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". + message and show it as a table under the message. The block is found the + way git finds it for "git interpret-trailers", so 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 + Flag which, when set to "1", makes the tree page 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". + Flag which, when set to "1", makes cgit generate linenumber links for + plaintext blobs printed in the tree page. Default value: "1". favicon:: Url used as link to the icon for cgit. Any path works, but keeping the @@ -311,55 +307,54 @@ js:: 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". + server's 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. + Url loaded when clicking on the cgit logo image. Default value: the url + of the repository index page. max-atom-items:: - Specifies the number of items to display in atom feeds view. Default + Specifies the number of items to display in the atom feed. 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 + memory to serve. It caps both the HTML blob page 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 + Specifies the number of entries to list per page in "log" page. Default value: "50". max-diff-files:: - If a commit changes more files than this, the "commit" and "diff" views + If a commit changes more files than this, the "commit" and "diff" pages 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 + "rawdiff" and "patch" pages 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, + pages 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". + the "log" page. 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 + "patch" page 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 + "refs" page, 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. @@ -369,8 +364,8 @@ max-repo-count:: Default value: "50". max-repodesc-length:: - Specifies the maximum number of repo description characters to display - on the repository index page. Default value: "80". + Specifies the maximum number of repository 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, @@ -383,23 +378,22 @@ mimetype-file:: Specifies the file to use for automatic mimetype lookup. If specified then this field is used as a fallback when no "mimetype.<ext>" 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.<ext>". + to use on a Linux system is /etc/mime.types. Each line in the file holds + a mimetype, like image/png, followed by one or more file extensions, + like jpg, separated by whitespace. Empty lines and lines whose first + non-blank character is a hash are ignored. Default value: none. See + also: "mimetype.<ext>". mimetype.<ext>:: - Set the mimetype for the specified filename extension. This is used by - the `plain` command when returning blob content. + Set the mimetype for the specified filename extension. The "plain" page + uses it when returning blob content. Default value: none. See also: + "mimetype-file". 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. + formatstring are the name of the submodule directory and the object id + of the submodule commit. Default value: none. project-list:: A list of subdirectories inside of scan-path, relative to it, that @@ -420,14 +414,14 @@ remove-suffix:: 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". + "-1" uses the compiletime value in git, see git-diff(1). 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. + are "name" for sorting by the repository 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, @@ -447,24 +441,24 @@ root-title:: "Git repository browser". scan-hidden-path:: - If set to "1" and scan-path is enabled, scan-path will recurse into + If set to "1" and scan-path is enabled, scan-path recurses 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. + skips such directories as hidden. The ".git" directory of a non-bare + repository is still found. 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". + A path which is scanned for repositories. If caching is enabled, the + result is 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. Only the global settings taken before the + scan-path directive apply 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 @@ -473,12 +467,12 @@ section:: 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". + elements from each repository path to use as a default section name. If + negative, cgit discards the specified number of path elements above the + repository directory. Default value: "0". section-sort:: - Flag which, when set to "1", will sort the sections on the repository + Flag which, when set to "1", sorts 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. @@ -498,14 +492,14 @@ snapshots:: 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". + the tree page. 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, which is how + syntax highlighting is done. 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 @@ -516,44 +510,43 @@ strict-export:: summary-branches:: Specifies the number of branches to display in the repository "summary" - view. Default value: "10". + page. Default value: "10". summary-log:: Specifies the number of log entries to display in the repository - "summary" view. Default value: "10". + "summary" page. Default value: "10". summary-tags:: Specifies the number of tags to display in the repository "summary" - view. Default value: "10". + page. 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". + 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, + 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.<option>" form included, never need this. Default value: "0". See also: "scan-path", "enable-git-config". virtual-root:: - Url which, if specified, will be used as root for all cgit links. It - will also cause cgit to generate 'virtual urls', i.e. urls like - '/cgit/tree/README' as opposed to '?url=cgit/tree/README'. Default - value: none. + Url which, if specified, is used as root for all cgit links. cgit then + generates virtual urls such as "/cgit/tree/README" in place of + "?url=cgit/tree/README". Default value: none. Repository settings @@ -569,8 +562,8 @@ repo.branch-sort:: value: <branch-sort>. repo.clone-url:: - A list of space-separated urls which can be used to clone this repo. - Default value: <clone-url>. See also: "Macro expansion". + A list of space-separated urls which can be used to clone this + repository. Default value: <clone-url>. See also: "Macro expansion". repo.commit-filter:: Override the default commit-filter. Default value: <commit-filter>. See @@ -644,7 +637,8 @@ repo.enable-trailers:: repo.head-content:: This value will be added verbatim to the html HEAD section of each page - displayed for this repo. Default value: none. See also: "head-include". + displayed for this repository. Default value: none. See also: + "head-include". repo.hide:: Flag which, when set to "1", hides the repository from the repository @@ -658,11 +652,10 @@ repo.ignore:: repo.logo:: Url which specifies the source of an image which will be used as a logo - on this repo's pages. Default value: <logo>. + on this repository's pages. Default value: <logo>. repo.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: + Url loaded when clicking on the cgit logo image. Default value: <logo-link>. repo.max-stats:: @@ -674,13 +667,13 @@ repo.max-stats:: repo.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: <module-link>. + formatstring are the name of the submodule directory and the object id + of the submodule commit. Default value: <module-link>. repo.module-link.<path>:: Text which will be used as the formatstring for a hyperlink when a submodule with the specified subdirectory path is printed in a directory - listing. The only argument for the formatstring is the SHA1 of the + listing. The only argument for the formatstring is the object id of the submodule commit. Default value: none. repo.name:: @@ -698,14 +691,14 @@ repo.path:: repo.readme:: A path (relative to <repo.path>) which specifies a file to include - verbatim as the "About" page for this repo. You may also specify a git - refspec by head or by hash by prepending the refspec followed by a - colon. For example, "master:docs/readme.mkd". If the value begins with a - colon, i.e. ":docs/readme.rst", the head given in the query or the - default branch of the repository will be used. Sharing any file will - expose that entire directory tree to the "/about/PATH" endpoints, so be - sure that there are no non-public files located in the same directory as - the readme file. Default value: <readme>. + verbatim as the "About" page for this repository. A git refspec by head + or by hash may be prepended, followed by a colon, as in + "master:docs/readme.mkd". If the value begins with a colon, as in + ":docs/readme.rst", the head given in the query or the default branch of + the repository is used. Sharing any file exposes that entire directory + tree to the "/about/PATH" endpoints, so be sure that there are no + non-public files located in the same directory as the readme file. + Default value: <readme>. repo.section:: Override the current section name for this repository. Default value: @@ -715,41 +708,37 @@ repo.snapshot-prefix:: Prefix to use for snapshot links instead of the repository basename. For example, the "linux-stable" repository may wish to set this to "linux" so that snapshots are in the format "linux-3.15.4" instead of - "linux-stable-3.15.4". Default value: <empty> meaning to use the - repository basename. + "linux-stable-3.15.4". Default value: the repository basename. repo.snapshots:: - A mask of snapshot formats for this repo that cgit generates links for. - It is intersected with the global "snapshots" setting, so a repository - can withhold formats but never offer one the global setting does not. - Default value: <snapshots>. + A mask of snapshot formats for this repository that cgit generates links + for. It is intersected with the global "snapshots" setting, so a + repository can withhold formats but never offer one the global setting + does not. Default value: <snapshots>. repo.source-filter:: Override the default source-filter. Default value: <source-filter>. See also: "Filter API", "trust-scan-config". repo.trailer-filter:: - Override the default trailer-filter. Default value: <trailer-filter>. See - also: "Filter API", "trust-scan-config". + Override the default trailer-filter. Default value: <trailer-filter>. + See also: "Filter API", "trust-scan-config". repo.url:: The relative url used to access the repository. This must be the first - setting specified for each repo. Default value: none. + setting specified for each repository. 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". The options that run a command, put raw markup on -the page, place a link or read a file off the disk are only honoured when -"trust-scan-config" is set to "1", since the file belongs to whoever can push -to the repository. - -Note: the "repo." prefix is dropped from the option names in repo-specific -config files, e.g. "repo.desc" becomes "desc". +When the option "scan-path" is used to auto-discover git repositories, cgit +tries to parse the file "cgitrc" within any found repository. Such a file may +contain any of the repository settings described above, except "repo.url" and +"repo.path", with the "repo." prefix dropped, so "repo.desc" becomes "desc". The +options that run a command, put raw markup on the page, place a link or read a +file off the disk are only honoured when "trust-scan-config" is set to "1", +since the file belongs to whoever can push to the repository. Filter API @@ -757,7 +746,7 @@ Filter API By default, filters are separate processes that are executed each time they are needed. Alternative technologies may be used by prefixing the filter -specification with the relevant string. The available values are: +specification with one of these strings. 'exec:':: The default "one process per filter" mode. @@ -778,7 +767,7 @@ specification with the relevant string. The available values are: completed. It must return an integer value. Usually 0 indicates success. - Additionally, cgit exposes to the Lua the following built-in functions: + cgit also exposes these built-in functions to the Lua script. 'html(str)':: Writes 'str' to the webpage. @@ -797,14 +786,14 @@ specification with the relevant string. The available values are: Parameters are provided to filters as follows. about filter:: - This filter is given a single parameter: the filename of the source file + This filter is given a single parameter, the filename of the source file to filter. The filter can use the filename to determine (for example) the type of syntax to follow when formatting the readme file. The about text that is to be filtered is available on standard input and the filtered text is expected on standard output. auth filter:: - The authentication filter receives 12 parameters: + The authentication filter receives 12 parameters, in this order. - filter action, explained below, which specifies which action the filter is called for - http cookie @@ -822,15 +811,15 @@ auth filter:: HTML for displaying the login form, which POSTs to the login url. When the filter action is "authenticate-cookie", this filter must validate the http cookie and return a 0 if it is invalid or 1 if it is valid, in - the exit code / close function. If the filter action is - "authenticate-post", this filter receives POST'd parameters on standard - input, and should write a complete CGI response, preferably with a 302 - redirect, and write to output one or more "Set-Cookie" HTTP headers, - each followed by a newline. + the exit code or the close function. If the filter action is + "authenticate-post", this filter receives the posted parameters on + standard input, and should write a complete CGI response, preferably + with a 302 redirect, and write to output one or more "Set-Cookie" HTTP + headers, each followed by a newline. - See `custom/extensions/auth-inline.lua` for a ready to modify example - that keeps its user list inline, or `custom/extensions/auth-file.lua` - for the same filter reading its users from files on disk. + See custom/extensions/auth-inline.lua for a ready to modify example that + keeps its user list inline, or custom/extensions/auth-file.lua for the + same filter reading its users from files on disk. commit filter:: This filter is given no arguments. The commit message text that is to be @@ -838,28 +827,28 @@ commit filter:: expected on standard output. email filter:: - This filter is given two parameters: the email address of the relevant + This filter is given two parameters, the email address of the relevant author and a string indicating the originating page. The filter will then receive the text string to format on standard input and is expected to write to standard output the formatted text to be included in the page. source filter:: - This filter is given a single parameter: the filename of the source file + This filter is given a single parameter, the filename of the source file to filter. The filter can use the filename to determine (for example) the syntax highlighting mode. The contents of the source file that is to be filtered is available on standard input and the filtered contents is expected on standard output. trailer filter:: - This filter is given two parameters: the key of the trailer being + This filter is given two parameters, the key of the trailer being formatted, such as "Fixes", and a string indicating the originating page. The filter will then receive the trailer value, already HTML escaped, on standard input and is expected to write to standard output the formatted value to be included in the page. -All filters are handed the following environment variables: +All filters are handed these environment variables. - CGIT_REPO_URL (from repo.url) - CGIT_REPO_NAME (from repo.name) @@ -879,7 +868,7 @@ Macro expansion The following cgitrc options support a simple macro expansion feature, where tokens prefixed with "$" are replaced with the value of a similarly named -environment variable: +environment variable. - cache-root - include @@ -894,17 +883,17 @@ server hands the cgit process, so any variable the server sets can be used. A CGI server provides the standard request variables, among them $HTTP_HOST, $HTTPS, $PATH_INFO, $QUERY_STRING, $REQUEST_METHOD, $SCRIPT_NAME, $SERVER_NAME and $SERVER_PORT, and server directives such as SetEnv (Apache), fastcgi_param -(nginx) or setenv.add-environment (lighttpd) can add anything else. Note that -cgit unsets $HOME and $XDG_CONFIG_HOME before reading its configuration, so -those two never expand. +(nginx) or setenv.add-environment (lighttpd) can add anything else. cgit unsets +$HOME and $XDG_CONFIG_HOME before reading its configuration, so those two never +expand. One usage of this feature is virtual hosting, which in its simplest form can be -accomplished by adding the following line to /etc/cgitrc: +accomplished by adding a line like this one to /etc/cgitrc. include=/etc/cgitrc.d/$HTTP_HOST The following options are expanded later, during request processing, and -additionally support the seven CGIT_REPO_* variables defined in "Filter API": +additionally support the seven CGIT_REPO_* variables defined in "Filter API". - clone-url - repo.clone-url @@ -931,9 +920,9 @@ asked for. Signatures ---------- -Cgit can host .asc signatures corresponding to various snapshot formats, through +cgit can host .asc signatures corresponding to various snapshot formats, through use of git notes. For example, the following command may be used to add a -signature to a .tar.xz archive: +signature to a .tar.xz archive. git notes --ref=refs/notes/signatures/tar.xz add -C "$( gpg --output - --armor --detach-sign cgit-1.1.tar.xz | @@ -943,7 +932,7 @@ signature to a .tar.xz archive: If it is instead desirable to attach a signature of the underlying .tar, this will be linked, as a special case, beside a .tar.* link that does not have its own signature. For example, a signature of a tarball of the latest tag might be -added with a similar command: +added with a similar command. tag="$(git describe --abbrev=0)" git notes --ref=refs/notes/signatures/tar add -C "$( |