diff options
| -rw-r--r-- | MANUAL.txt | 413 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | README.txt | 57 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | assets/cgit.css | 19 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/cgitrc | 272 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/extensions/about-render.lua | 80 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/extensions/auth-file.lua | 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/extensions/auth-inline.lua | 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rwxr-xr-x | custom/hooks/post-receive.cgit-age | 25 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rwxr-xr-x | custom/hooks/post-receive.cgit-cache | 35 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/servers/apache.conf | 9 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/servers/lighttpd.conf | 9 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rw-r--r-- | custom/servers/nginx.conf | 9 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rwxr-xr-x | tools/gen-version.sh | 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| -rwxr-xr-x | tools/release-build.sh | 7 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
14 files changed, 468 insertions, 472 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 "$( @@ -9,45 +9,40 @@ Installation ------------ Building cgit involves building a proper version of Git. How to do this depends -on how you obtained the cgit sources: +on how you obtained the cgit sources. -a) If you're working in a cloned cgit repository, you first need to initialize -and update the Git submodule: +In a cloned cgit repository, first initialize and update the Git submodule. $ git submodule init # register the Git submodule in .git/config $ $EDITOR .git/config # if you want to specify a different url for git $ git submodule update # clone/fetch and checkout correct git version -b) If you're building from a cgit tarball, you can download a proper git version -like this: +From a cgit tarball, download a proper git version instead. $ make get-git -When either a) or b) has been performed, you can build and install cgit like -this: +With the Git tree in place, build and install cgit. $ make $ sudo make install -This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You can -configure this location (and a few other things) by providing a `cgit.conf` file -(see the Makefile for details). +This installs cgit.cgi and cgit.css into /var/www/htdocs/cgit. The location and +a few other things can be changed by providing a cgit.conf file, see the +Makefile for details. The only required library is zlib. cgit builds without OpenSSL or libcurl, so no development packages for those are needed. -Lua is optional and only powers the lua: filter extensions (the filters in -custom/extensions/). A plain build auto-detects a Lua through pkg-config, -preferring LuaJIT, and falls back to a Lua-less binary when none is found. - -To pin an implementation: +Lua is optional and only powers the lua: filter extensions, the filters in +custom/extensions/. A plain build auto-detects a Lua through pkg-config, +preferring LuaJIT, and falls back to a Lua-less binary when none is found. To +pin an implementation, name its pkg-config module. $ make LUA_PKGCONFIG=lua5.4 Acceptable LUA_PKGCONFIG values include "luajit", "lua", "lua5.4", "lua5.3", -"lua5.2" and "lua5.1". - -To build without Lua, so the binary needs no Lua at runtime: +"lua5.2" and "lua5.1". To build without Lua, so the binary needs no Lua at +runtime, turn it off. $ make NO_LUA=1 @@ -56,32 +51,30 @@ Setup ----- cgit is a CGI program. Complete, commented configurations for nginx, Apache and -lighttpd live in `custom/servers/`, each explaining how that server routes +lighttpd live in custom/servers/, each explaining how that server routes requests to the binary and serves the static assets off disk. -At runtime cgit reads `/etc/cgitrc` for its options and for the list of +At runtime cgit reads /etc/cgitrc for its options and for the list of repositories to display. A fully commented starting point with every option at -its default is in `custom/cgitrc`, and `MANUAL.txt` documents each option in -full. +its default is in custom/cgitrc, and MANUAL.txt documents each option in full. Filter extensions ----------------- -The optional Lua filters in `custom/extensions/` mostly need extra Lua modules, +The optional Lua filters in custom/extensions/ mostly need extra Lua modules, and each script's header lists the exact install commands for its own. -* The auth filters (`auth-file.lua`, `auth-inline.lua`) need `luaossl` and - `luaposix`. -* The email filters (`email-gravatar.lua`, `email-libravatar.lua`) need - `luaossl`. -* The syntax highlighter (`syntax-highlight.lua`) needs `lpeg` and a Scintillua +* The auth filters, auth-file.lua and auth-inline.lua, need luaossl and + luaposix. +* The email filters, email-gravatar.lua and email-libravatar.lua, need luaossl. +* The syntax highlighter, syntax-highlight.lua, needs lpeg and a Scintillua lexer set. -* The about-page renderer (`about-render.lua`) needs `lpeg` for markdown and man +* The about-page renderer, about-render.lua, needs lpeg for markdown and man pages. Plain text needs only Lua. -* `link-commits.lua` and `link-trailers.lua` need nothing beyond Lua itself. +* link-commits.lua and link-trailers.lua need nothing beyond Lua itself. -`luaossl` has no Lua 5.5 build, so build cgit against 5.1 to 5.4 if you use the +luaossl has no Lua 5.5 build, so build cgit against 5.1 to 5.4 if you use the auth or email filters. @@ -115,7 +108,7 @@ one, where a value of all marks the few not tied to particular pages. | id2 | diff patch rawdiff | second object of a diff, paired with id | | ofs | index log refs stats | offset into a paged listing | | path | all | restrict the page to one path | -| q | log | the search term | +| q | log | the search term, matched literally | | qt | log | one of grep, author, committer or range | | s | index | sort key for the listing | | showmsg | log | show full commit messages | diff --git a/assets/cgit.css b/assets/cgit.css index 511c377..90fa074 100644 --- a/assets/cgit.css +++ b/assets/cgit.css @@ -8,7 +8,6 @@ div#cgit { color-scheme: light dark; - /* Palette: light-dark(light value, dark value) */ --bg: light-dark(#ffffff, #1b1b1b); --fg: light-dark(#333333, #d6d6d6); --muted: light-dark(#777777, #9a9a9a); @@ -30,7 +29,6 @@ div#cgit { --upd: light-dark(#0000cc, #6ea8fe); --hunk: light-dark(#000099, #7aa2f7); --accent: light-dark(#cc0000, #ff6b6b); - /* Faded wash over the fragment-targeted source line. */ --line-hl: light-dark(rgba(212, 167, 44, 0.18), rgba(224, 192, 80, 0.14)); --notes-bg: light-dark(#ffffdd, #33331a); @@ -78,9 +76,7 @@ div#cgit { --font-mono: ui-monospace, "SF Mono", SFMono-Regular, Menlo, Consolas, "Liberation Mono", "DejaVu Sans Mono", monospace; - /* Shared horizontal inset so every region lines up down the page. */ --gutter: 1.25rem; - /* Shared height so the dropdowns and fields all agree. */ --control-h: 2em; --radius: 5px; @@ -92,14 +88,12 @@ div#cgit { font-family: var(--font-sans); font-size: 13px; line-height: 1.4; - /* Hold the type size steady when a phone is turned to landscape. */ text-size-adjust: 100%; -webkit-text-size-adjust: 100%; color: var(--fg); background: var(--bg); } -/* Scoped so an embedding host page is left alone. */ html.cgit-standalone { color-scheme: light dark; background: light-dark(#ffffff, #1b1b1b); @@ -191,7 +185,6 @@ div#cgit #header { margin-bottom: 0; } -/* Reserved so the header holds still while the image loads. */ div#cgit #header .logo { grid-area: logo; align-self: start; @@ -236,7 +229,6 @@ div#cgit #header .sub { overflow-wrap: anywhere; } -/* The rule under the masthead, run out to the right edge. */ div#cgit #header::before { content: ""; grid-column: 2 / -1; @@ -453,7 +445,6 @@ div#cgit div#summary pre { overflow-x: auto; } -/* Wrapped rather than scrolled, prose is the common case. */ div#cgit pre.plaintext { white-space: pre-wrap; overflow-wrap: anywhere; @@ -666,20 +657,17 @@ div#cgit table.ssdiff td.lineno a:hover { color: var(--fg); } -/* Land a fragment-targeted line mid-viewport rather than at the top. */ div#cgit table.blob td.linenumbers a, div#cgit table.blame td.linenumbers a { scroll-margin-top: calc(50vh - 1em); } -/* Without scripting only the line number itself is tinted. */ div#cgit table.blob td.linenumbers a:target, div#cgit table.blame td.linenumbers a:target { background: var(--line-hl); color: var(--fg); } -/* Anchor box for the highlight bar cgit.js positions over the target. */ div#cgit table.blob, div#cgit table.blame { position: relative; @@ -693,7 +681,6 @@ div#cgit div.line-hl { pointer-events: none; } -/* Tokens produced by the syntax-highlight.lua source filter. */ div#cgit .hl-comment { color: light-dark(#6a737d, #8b949e); font-style: italic; @@ -951,7 +938,6 @@ div#cgit div.diffstat-summary { padding-top: 0.5em; } -/* A scroll box beside the options float would shrink to fit the gap. */ div#cgit div.diff-scroll { clear: right; overflow-x: auto; @@ -986,7 +972,6 @@ div#cgit table.diff td div.del { color: var(--del); } -/* Notice shown when a diff exceeds the configured limits. */ div#cgit div.truncated, div#cgit table.ssdiff td.truncated { color: var(--muted); @@ -1284,8 +1269,6 @@ div#cgit table.ssdiff td.space { height: 3em; } -/* The breakpoints only hide chrome or restack, sizes never change. */ - @media (max-width: 900px) { div#cgit .tabs .search { display: none; @@ -1313,7 +1296,6 @@ div#cgit table.ssdiff td.space { display: none; } - /* Keep any remaining long token from forcing a sideways page. */ div#cgit table.list td { overflow-wrap: anywhere; } @@ -1329,7 +1311,6 @@ div#cgit table.ssdiff td.space { width: auto; } - /* Fixed table layout would still reserve the hidden columns' width. */ div#cgit table.repolist { width: 100%; } diff --git a/custom/cgitrc b/custom/cgitrc index 18c973d..a594cb2 100644 --- a/custom/cgitrc +++ b/custom/cgitrc @@ -14,7 +14,7 @@ # bundled about-render.lua about-filter in the filter section below. Source # syntax highlighting is optional and ships as a source-filter there too. # -# One key=value pair per line. Lines starting with # are comments. +# One key=value pair per line. Lines starting with # or ; are comments. # Maximum number of entries in the cgit output cache. A value of 0 disables # caching. Value is an integer. Default is 0. @@ -24,7 +24,7 @@ cache-size=0 # may use macros. Default is /var/cache/cgit. The directory must be owned by the # account the web server runs cgit as, with mode 0700, since the cache holds # every rendered page and the URLs visitors asked for. -#cache-root=/var/cache/cgit +cache-root=/var/cache/cgit # Minutes to cache the repository index page. Value is an integer number of # minutes. Default is 5. @@ -38,12 +38,13 @@ cache-summary-ttl=5 # integer number of minutes. Default is 15. cache-scan-ttl=15 -# Minutes to cache repo pages requested with a fixed SHA1. A negative value -# keeps the page forever. Value is an integer number of minutes. Default is -1. +# Minutes to cache repository pages requested with a fixed object id. A negative +# value keeps the page forever. Value is an integer number of minutes. Default +# is -1. cache-static-ttl=-1 -# Minutes to cache repo pages requested without a fixed SHA1. Value is an -# integer number of minutes. Default is 5. +# Minutes to cache repository pages requested without a fixed object id. Value +# is an integer number of minutes. Default is 5. cache-dynamic-ttl=5 # Minutes to cache the repository about page. Value is an integer number of @@ -60,11 +61,11 @@ enable-cache-list=0 # Heading text on the repository index page. Value is any text. Default is Git # repository browser. -#root-title=Git repository browser +root-title=Git repository browser # Subheading text below the index page heading. Value is any text. Default is a # fast webinterface for the git dscm. -#root-desc=a fast webinterface for the git dscm +root-desc=a fast webinterface for the git dscm # File included verbatim below the about link on the index page. Value is a # filesystem path. Default is none. @@ -74,21 +75,22 @@ enable-cache-list=0 # is one or more [ref]path entries. Default is none. #readme=:README.md -# CSS document urls added to the head of every page. An empty value disables -# it. Value is one or more urls. Default is /cgit.css. -#css=/cgit.css +# CSS document urls added to the head of every page. An empty value disables it. +# Value is one or more urls. Default is /cgit.css. +css=/cgit.css # JavaScript document urls included on every page. An empty value disables it. # Value is one or more urls. Default is /cgit.js. -#js=/cgit.js +js=/cgit.js # Shortcut icon url for all pages. Value is a url. Default is /favicon.ico. -#favicon=/favicon.ico +favicon=/favicon.ico # Image url used as the logo on all pages. Value is a url. Default is /cgit.png. -#logo=/cgit.png +logo=/cgit.png -# Url loaded when clicking the logo. Value is a url. Default is the index url. +# Url loaded when clicking the logo. Value is a url. Default is the repository +# index url. #logo-link=/ # File included verbatim at the top of all pages. Value is a filesystem path. @@ -120,7 +122,7 @@ embedded=0 #virtual-root=/ # Link format string for submodules in directory listings. Value is a printf -# format string taking path and sha1. Default is none. +# format string taking path and object id. Default is none. #module-link=/%s/commit/?id=%s # Directory scanned for git repositories at parse time. Value is a filesystem @@ -135,34 +137,34 @@ scan-hidden-path=0 # scan-path. Value is an integer that may be negative. Default is 0. section-from-path=0 -# Strip the .git suffix from scanned repo url and name. Must precede scan-path. -# Values are 0 or 1. Default is 0. +# Strip the .git suffix from a scanned repository's url and name. Must precede +# scan-path. Values are 0 or 1. Default is 0. remove-suffix=0 # File listing subdirs of scan-path to load. Must precede scan-path. Value is a # filesystem path that may use macros. Default is none. #project-list=/var/lib/git/projects.list -# Serve a repo only if this file exists inside it. Emulates gitweb EXPORT_OK. -# The reverse needs no setting, a repo containing a file named "noweb" is always -# skipped by the scan. Must precede scan-path. Value is a filename. Default is -# none. +# Serve a repository only if this file exists inside it. Emulates gitweb +# EXPORT_OK. The reverse needs no setting, a repository containing a file named +# "noweb" is always skipped by the scan. Must precede scan-path. Value is a +# filename. Default is none. #strict-export=git-daemon-export-ok -# Section heading that subsequently-defined repos inherit. Value is any section -# heading text. Default is none. +# Section heading that subsequently defined repositories inherit. Value is any +# section heading text. Default is none. #section=main -# Sort sections and repos within them by name rather than file order. Values are -# 0 or 1. Default is 0. +# Sort sections and the repositories within them by name rather than file order. +# Values are 0 or 1. Default is 0. section-sort=0 # How repositories within a section are sorted. Values are name or age. Default # is name. repository-sort=name -# Let scanned repos set cgit settings via git config using gitweb.* or cgit.* -# keys. Values are 0 or 1. Default is 0. +# Let a scanned repository set cgit settings through its git config, using +# gitweb.* or cgit.* keys. Values are 0 or 1. Default is 0. enable-git-config=0 # Include another config file before continuing to parse this one. Value is a @@ -177,7 +179,7 @@ enable-blame=0 # Default is 0. enable-commit-graph=0 -# Allow following a file across renames in the log view. Values are 0 or 1. +# Allow following a file across renames in the log page. Values are 0 or 1. # Default is 0. enable-follow-links=0 @@ -185,12 +187,12 @@ enable-follow-links=0 # module-link template covers. Values are 0 or 1. Default is 0. enable-gitmodules-links=0 -# Generate extra summary, commit and tree links per repo on the index. Values -# are 0 or 1. Default is 0. +# Generate extra summary, commit and tree links per repository on the index. +# Values are 0 or 1. Default is 0. enable-index-links=0 -# Show the owner of each repo on the index page. Values are 0 or 1. Default is -# 1. +# Show the owner of each repository on the index page. Values are 0 or 1. +# Default is 1. enable-index-owner=1 # Show the number of modified files per commit in the log. Values are 0 or 1. @@ -202,43 +204,43 @@ enable-log-filecount=0 enable-log-linecount=0 # Apply the .mailmap at HEAD to every author, committer and tagger shown, so a -# person who changed name or address appears under one identity. Values are 0 -# or 1. Default is 1. +# person who changed name or address appears under one identity. Values are 0 or +# 1. Default is 1. enable-mailmap=1 # Show ages in the log, refs and index columns as an elapsed time such as "3 # days" rather than a calendar date. Values are 0 or 1. Default is 1. enable-relative-dates=1 -# Display remote branches in summary and refs views. Values are 0 or 1. Default -# is 0. +# Display remote branches in the summary and refs pages. Values are 0 or 1. +# Default is 0. enable-remote-branches=0 # Use the parent commit subject as link text for parent links. Values are 0 or # 1. Default is 0. enable-subject-links=0 -# Split the trailer block, the Signed-off-by lines and their kin, off the end -# of a commit message and show it as a table on the commit page. Values are 0 -# or 1. Default is 0. +# Split the trailer block, the Signed-off-by lines and their kin, off the end of +# a commit message and show it as a table on the commit page. Values are 0 or 1. +# Default is 0. enable-trailers=0 # Allow /plain to serve HTML mimetypes instead of downgrading to text/plain. # Values are 0 or 1. Default is 0. enable-html-serving=0 -# Generate line-number links for plaintext blobs in the tree view. Values are 0 +# Generate line-number links for plaintext blobs in the tree page. Values are 0 # or 1. Default is 1. enable-tree-linenumbers=1 -# List directories first, then files, in the tree view. Values are 0 or 1. +# List directories first, then files, in the tree page. Values are 0 or 1. # Default is 0. enable-tree-group-dirs=0 # Enable the statistics page, which counts commits per author, and set the # coarsest period it offers. Each value also offers the finer periods before it. -# Leaving this unset disables statistics. Values are week, month, quarter or -# year. Default is unset. +# Leaving it out disables statistics. Values are week, month, quarter or year. +# Default is none. #max-stats=year # Default set of snapshot archive formats to offer. Value is a space-separated @@ -249,7 +251,7 @@ enable-tree-group-dirs=0 # Act as a dumb HTTP endpoint for git clones. Values are 0 or 1. Default is 1. enable-http-clone=1 -# Prefixes combined with the repo url to build clone urls. Used only when +# Prefixes combined with the repository url to build clone urls. Used only when # repo.clone-url is unset. Value is space-separated url prefixes. Default is # none. #clone-prefix=https://example.com/git git://example.com @@ -292,7 +294,7 @@ trust-scan-config=0 # Value is a command optionally prefixed with exec or lua. Default is none. #trailer-filter=lua:/usr/local/lib/cgit/filters/link-trailers.lua -# Filter command used to format plaintext blobs in the tree view. The shipped +# Filter command used to format plaintext blobs in the tree page. The shipped # filter uses the Scintillua lexers and needs lpeg, and missing either means # plain uncolored text, not an error. Value is a command optionally prefixed # with exec or lua. Default is none. @@ -307,27 +309,27 @@ trust-scan-config=0 # Number of items to display in atom feeds. Value is an integer. Default is 10. max-atom-items=10 -# Max commit message characters shown in the log view. Value is an integer. +# Max commit message characters shown in the log page. Value is an integer. # Default is 80. max-message-length=80 -# Max repo description characters shown on the index page. Value is an integer. -# Default is 80. +# Max repository description characters shown on the index page. Value is an +# integer. Default is 80. max-repodesc-length=80 # Max blob size in KBytes read into memory for html, plain and blob output. A # value of 0 disables the limit. Value is an integer. Default is 10240. max-blob-size=10240 -# Number of repos listed per page on the index. Zero or a negative value shows -# all repos. Value is an integer. Default is 50. +# Number of repositories listed per page on the index. Zero or a negative value +# shows them all. Value is an integer. Default is 50. max-repo-count=50 -# Number of log entries listed per page in the log view. Value is an integer. +# Number of log entries listed per page in the log page. Value is an integer. # Default is 50. max-commit-count=50 -# Maximum number of commits the patch view emits as a series for an explicit +# Maximum number of commits the patch page emits as a series for an explicit # revision range. A single commit is unaffected. A value of 0 removes the limit. # Value is an integer. Default is 50. max-patch-count=50 @@ -338,7 +340,7 @@ max-patch-count=50 max-diff-files=200 # A file whose diff spans more lines than this is replaced by a link to its own -# diff page in whole-commit views. A value of 0 always renders it inline. Value +# diff page in whole-commit pages. A value of 0 always renders it inline. Value # is an integer. Default is 1000. max-diff-lines=1000 @@ -351,15 +353,15 @@ max-ref-count=200 # compile-time value. Value is an integer. Default is -1. rename-limit=-1 -# Number of log entries shown in the summary view. Value is an integer. Default +# Number of log entries shown in the summary page. Value is an integer. Default # is 10. summary-log=10 -# Number of branches shown in the summary view. Value is an integer. Default is +# Number of branches shown in the summary page. Value is an integer. Default is # 10. summary-branches=10 -# Number of tags shown in the summary view. Value is an integer. Default is 10. +# Number of tags shown in the summary page. Value is an integer. Default is 10. summary-tags=10 # Show side-by-side diffs instead of unidiffs by default. Values are 0 or 1. @@ -375,14 +377,15 @@ local-time=0 # carry a -local suffix, plus format:<strftime>. Default is short. date-format=short -# Ordering of commits in the log view. Leaving this unset uses the git log -# default. Values are date or topo. Default is unset. +# Ordering of commits in the log page. Leaving it out uses the git log default. +# Values are date or topo. Default is none. #commit-sort=date # Ordering of the branch ref list. Values are name or age. Default is name. branch-sort=name -# Sort items in the repo list case-sensitively. Values are 0 or 1. Default is 1. +# Sort items in the repository list case-sensitively. Values are 0 or 1. +# Default is 1. case-sensitive-sort=1 # Show full author email addresses beside names. Values are 0 or 1. Default is @@ -390,8 +393,8 @@ case-sensitive-sort=1 enable-plain-email=1 # File giving the timestamp of the youngest commit. Value is a path relative to -# the repo. Default is info/web/last-modified. -#age-file=info/web/last-modified +# the repository. Default is info/web/last-modified. +age-file=info/web/last-modified # Fallback mimetype lookup file for plain output. Value is a filesystem path. # Default is none. @@ -407,152 +410,155 @@ enable-plain-email=1 #mimetype.svg=image/svg+xml # Each repository is introduced by a repo.url line. All following repo.* -# settings apply to that repo until the next repo.url line. When repos are -# discovered via scan-path the repo. prefix is dropped inside each repo cgitrc -# and repo.url and repo.path are not allowed there. +# settings apply to that repository until the next repo.url line. When +# repositories are discovered via scan-path the repo. prefix is dropped inside +# each repository's cgitrc, and repo.url and repo.path are not allowed there. -# Relative url for a repo. Must be the first setting of each repo block. Value -# is a relative url path. Default is none. +# Relative url for a repository. Must be the first setting of each repository +# block. Value is a relative url path. Default is none. #repo.url=example -# Absolute path to the repository. For a non-bare repo this is the .git dir. -# Value is an absolute filesystem path. Default is none. +# Absolute path to the repository. For a non-bare repository this is the .git +# directory. Value is an absolute filesystem path. Default is none. #repo.path=/var/lib/git/example.git -# Display name of the repository. Value is any text. Default is the repo url. +# Display name of the repository. Value is any text. Default is the repository +# url. #repo.name=example -# Repository description. Value is any text. Default is none. +# Repository description. Value is any text. Default is "[no description]". #repo.desc=An example repository # Repository owner identifier. Value is any text. Default is none. #repo.owner=Jane Doe -# Urls used to clone this repo. Value is space-separated urls that may use +# Urls used to clone this repository. Value is space-separated urls that may use # macros. Default is none. #repo.clone-url=https://example.com/example.git git://example.com/example.git -# Default branch for the repo. Falls back to the first sorted branch. Value is a -# branch name. Default is the HEAD branch, or master. +# Default branch for the repository. Falls back to the first sorted branch. +# Value is a branch name. Default is the HEAD branch, or master. #repo.defbranch=master -# Override the current section name for this repo. Value is a section name. -# Default is none. +# Override the current section name for this repository. Value is a section +# name. Default is none. #repo.section=main -# Prefix for snapshot filenames instead of the repo basename. Value is a prefix -# string. Default is none. +# Prefix for snapshot filenames instead of the repository basename. Value is a +# prefix string. Default is none. #repo.snapshot-prefix=example -# Extra content added verbatim to the head of each page for this repo. Value is -# an HTML fragment. Default is none. +# Extra content added verbatim to the head of each page for this repository. +# Value is an HTML fragment. Default is none. #repo.head-content=<meta name="example" content="value"> -# File included verbatim as the repo About page. A colon-prefixed value uses the -# head or defbranch. Value is a [ref]path entry. Default is the global readme -# value. +# File included verbatim as the repository About page. A colon-prefixed value +# uses the head or defbranch. Value is a [ref]path entry. Default is the global +# readme value. #repo.readme=:README.md -# Per-repo logo image url. Value is a url. Default is the global logo value. +# Per-repository logo image url. Value is a url. Default is the global logo +# value. #repo.logo=/cgit.png -# Per-repo logo link target url. Value is a url. Default is the global logo-link -# value. +# Per-repository logo link target url. Value is a url. Default is the global +# logo-link value. #repo.logo-link=/ -# Per-repo submodule link format string. Value is a printf format string taking -# path and sha1. Default is the global module-link value. +# Per-repository submodule link format string. Value is a printf format string +# taking path and object id. Default is the global module-link value. #repo.module-link=/%s/commit/?id=%s # Submodule link format for a specific submodule path. Value is a printf format -# string taking sha1. Default is none. +# string taking an object id. Default is none. #repo.module-link.path/to/sub=https://example.com/sub/commit/?id=%s -# Snapshot formats offered for this repo, restricted by the global mask. A value -# of 0 disables snapshots. Value is snapshot formats. Default is the global -# snapshots value. +# Snapshot formats offered for this repository, restricted by the global mask. +# A value of 0 disables snapshots. Value is snapshot formats. Default is the +# global snapshots value. #repo.snapshots=tar.gz zip -# Hide the repo from the index but still allow direct access. Values are 0 or 1. -# Default is 0. +# Hide the repository from the index but still allow direct access. Values are +# 0 or 1. Default is 0. #repo.hide=0 -# Ignore the repo entirely so it is not indexed and not directly accessible. -# Values are 0 or 1. Default is 0. +# Ignore the repository entirely so it is not indexed and not directly +# accessible. Values are 0 or 1. Default is 0. #repo.ignore=0 -# Per-repo override of enable-blame. Values are 0 or 1. Default is the global -# enable-blame value. +# Per-repository override of enable-blame. Values are 0 or 1. Default is the +# global enable-blame value. #repo.enable-blame=0 -# Per-repo override of enable-commit-graph. Values are 0 or 1. Default is the -# global enable-commit-graph value. +# Per-repository override of enable-commit-graph. Values are 0 or 1. Default is +# the global enable-commit-graph value. #repo.enable-commit-graph=0 -# Per-repo override of enable-follow-links. Values are 0 or 1. Default is the -# global enable-follow-links value. +# Per-repository override of enable-follow-links. Values are 0 or 1. Default is +# the global enable-follow-links value. #repo.enable-follow-links=0 -# Per-repo override of enable-gitmodules-links. Values are 0 or 1. Default is -# the global enable-gitmodules-links value. +# Per-repository override of enable-gitmodules-links. Values are 0 or 1. +# Default is the global enable-gitmodules-links value. #repo.enable-gitmodules-links=0 -# Per-repo override of enable-log-filecount. Values are 0 or 1. Default is the -# global enable-log-filecount value. +# Per-repository override of enable-log-filecount. Values are 0 or 1. Default is +# the global enable-log-filecount value. #repo.enable-log-filecount=0 -# Per-repo override of enable-log-linecount. Values are 0 or 1. Default is the -# global enable-log-linecount value. +# Per-repository override of enable-log-linecount. Values are 0 or 1. Default is +# the global enable-log-linecount value. #repo.enable-log-linecount=0 -# Per-repo override of enable-mailmap. Values are 0 or 1. Default is the global -# enable-mailmap value. +# Per-repository override of enable-mailmap. Values are 0 or 1. Default is the +# global enable-mailmap value. #repo.enable-mailmap=1 -# Per-repo override of enable-remote-branches. Values are 0 or 1. Default is the -# global enable-remote-branches value. +# Per-repository override of enable-remote-branches. Values are 0 or 1. Default +# is the global enable-remote-branches value. #repo.enable-remote-branches=0 -# Per-repo override of enable-subject-links. Values are 0 or 1. Default is the -# global enable-subject-links value. +# Per-repository override of enable-subject-links. Values are 0 or 1. Default is +# the global enable-subject-links value. #repo.enable-subject-links=0 -# Per-repo override of enable-trailers. Values are 0 or 1. Default is the +# Per-repository override of enable-trailers. Values are 0 or 1. Default is the # global enable-trailers value. #repo.enable-trailers=0 -# Per-repo override of enable-html-serving. Values are 0 or 1. Default is the -# global enable-html-serving value. +# Per-repository override of enable-html-serving. Values are 0 or 1. Default is +# the global enable-html-serving value. #repo.enable-html-serving=0 -# Per-repo branch ref list ordering. Values are name or age. Default is name. +# Per-repository branch ref list ordering. Values are name or age. Default is +# name. #repo.branch-sort=name -# Per-repo commit log ordering. Leaving this unset uses the git log default. -# Values are date or topo. Default is unset. +# Per-repository commit log ordering. Leaving it out uses the git log default. +# Values are date or topo. Default is none. #repo.commit-sort=date -# Per-repo maximum statistics period. A value of 0 disables the statistics page -# for this repo. Values are week, month, quarter, year or 0. Default is the -# global max-stats value. +# Per-repository maximum statistics period. A value of 0 disables the statistics +# page for this repository. Values are week, month, quarter, year or 0. Default +# is the global max-stats value. #repo.max-stats=week -# Per-repo override of the about-filter. Value is a command. Default is the -# global about-filter value. +# Per-repository override of the about-filter. Value is a command. Default is +# the global about-filter value. #repo.about-filter=exec:/path/to/your-command -# Per-repo override of the commit-filter. Value is a command. Default is the -# global commit-filter value. +# Per-repository override of the commit-filter. Value is a command. Default is +# the global commit-filter value. #repo.commit-filter=lua:/usr/local/lib/cgit/filters/link-commits.lua -# Per-repo override of the source-filter. Value is a command. Default is the -# global source-filter value. +# Per-repository override of the source-filter. Value is a command. Default is +# the global source-filter value. #repo.source-filter=exec:/path/to/your-command -# Per-repo override of the email-filter. Value is a command. Default is the -# global email-filter value. +# Per-repository override of the email-filter. Value is a command. Default is +# the global email-filter value. #repo.email-filter=lua:/usr/local/lib/cgit/filters/email-gravatar.lua -# Per-repo override of the trailer-filter. Value is a command. Default is the -# global trailer-filter value. +# Per-repository override of the trailer-filter. Value is a command. Default is +# the global trailer-filter value. #repo.trailer-filter=lua:/usr/local/lib/cgit/filters/link-trailers.lua diff --git a/custom/extensions/about-render.lua b/custom/extensions/about-render.lua index 805265e..c833c00 100644 --- a/custom/extensions/about-render.lua +++ b/custom/extensions/about-render.lua @@ -115,8 +115,11 @@ emit_inline = function(list) elseif kind == "image" then local target = safe_url(node.url) if target then - html("<img src='"); html_attr(target) - html("' alt='"); html_attr(node.alt); html("'>") + html("<img src='") + html_attr(target) + html("' alt='") + html_attr(node.alt) + html("'>") else html_txt("![" .. node.alt .. "]") end @@ -138,9 +141,13 @@ emit_blocks = function(blocks) elseif kind == "code" then html("<pre><code") if block.lang and block.lang ~= "" then - html(" data-lang='"); html_attr(block.lang); html("'") + html(" data-lang='") + html_attr(block.lang) + html("'") end - html(">"); html_txt(block.text); html("</code></pre>") + html(">") + html_txt(block.text) + html("</code></pre>") elseif kind == "blockquote" then html("<blockquote>") emit_blocks(block.blocks) @@ -148,13 +155,17 @@ emit_blocks = function(blocks) elseif kind == "table" then html("<table><thead><tr>") for _, cell in ipairs(block.head) do - html("<th>"); emit_inline(cell); html("</th>") + html("<th>") + emit_inline(cell) + html("</th>") end html("</tr></thead><tbody>") for _, row in ipairs(block.rows) do html("<tr>") for _, cell in ipairs(row) do - html("<td>"); emit_inline(cell); html("</td>") + html("<td>") + emit_inline(cell) + html("</td>") end html("</tr>") end @@ -163,13 +174,17 @@ emit_blocks = function(blocks) local tag = block.ordered and "ol" or "ul" html("<" .. tag .. ">") for _, item in ipairs(block.items) do - html("<li>"); emit_inline(item); html("</li>") + html("<li>") + emit_inline(item) + html("</li>") end html("</" .. tag .. ">") elseif kind == "para" then html("<p>") for i, line in ipairs(block.lines) do - if i > 1 then html("<br>") end + if i > 1 then + html("<br>") + end emit_inline(line) end html("</p>") @@ -300,11 +315,14 @@ if has_lpeg then local code = {} i = i + 1 while i <= n and not close:match(lines[i]) do - code[#code + 1] = lines[i]; i = i + 1 + code[#code + 1] = lines[i] + i = i + 1 end i = i + 1 local body = table.concat(code, "\n") - if #code > 0 then body = body .. "\n" end + if #code > 0 then + body = body .. "\n" + end blocks[#blocks + 1] = { kind = "code", lang = lang, @@ -453,9 +471,14 @@ if has_lpeg then local tokens = man_inline_grammar:match(text) or {} local nodes, parts, font = {}, {}, "R" local function flush() - if #parts == 0 then return end - local run = table.concat(parts); parts = {} - if run == "" then return end + if #parts == 0 then + return + end + local run = table.concat(parts) + parts = {} + if run == "" then + return + end if font == "B" then nodes[#nodes + 1] = { kind = "strong", @@ -474,7 +497,8 @@ if has_lpeg then if token.kind == "text" then parts[#parts + 1] = token.text elseif token.kind == "font" then - flush(); font = token.font + flush() + font = token.font end end flush() @@ -494,7 +518,9 @@ if has_lpeg then local function flush_nofill() if nofill_lines then local body = table.concat(nofill_lines, "\n") - if #nofill_lines > 0 then body = body .. "\n" end + if #nofill_lines > 0 then + body = body .. "\n" + end blocks[#blocks + 1] = { kind = "code", text = body } nofill_lines = nil end @@ -505,10 +531,13 @@ if has_lpeg then end for _, line in ipairs(lines) do local macro, rest = macro_line:match(line) - if rest then rest = (rest:gsub('^"(.*)"$', "%1")) end + if rest then + rest = (rest:gsub('^"(.*)"$', "%1")) + end if nofill then if macro == "fi" then - nofill = false; flush_nofill() + nofill = false + flush_nofill() else nofill_lines[#nofill_lines + 1] = line end @@ -524,7 +553,9 @@ if has_lpeg then kids = man_inline(rest), } elseif macro == "nf" then - flush_paragraph(); nofill = true; nofill_lines = {} + flush_paragraph() + nofill = true + nofill_lines = {} elseif macro == "fi" then flush_nofill() elseif macro == "B" or macro == "BR" or macro == "RB" or macro == "BI" or macro == "IB" then @@ -532,17 +563,20 @@ if has_lpeg then elseif macro == "I" or macro == "IR" or macro == "RI" then add_line({ { kind = "em", kids = man_inline(rest) } }) elseif macro == "TH" or macro == "PP" or macro == "LP" - or macro == "P" or macro == "TP" or macro == "IP" - or macro == "HP" or macro == "RS" or macro == "RE" - or macro == "sp" or macro == "br" then + or macro == "P" or macro == "TP" or macro == "IP" + or macro == "HP" or macro == "RS" or macro == "RE" + or macro == "sp" or macro == "br" then flush_paragraph() elseif macro then - if rest ~= "" then add_line(man_inline(rest)) end + if rest ~= "" then + add_line(man_inline(rest)) + end else add_line(man_inline(line)) end end - flush_paragraph(); flush_nofill() + flush_paragraph() + flush_nofill() return blocks end diff --git a/custom/extensions/auth-file.lua b/custom/extensions/auth-file.lua index 230aa6d..3d426e9 100644 --- a/custom/extensions/auth-file.lua +++ b/custom/extensions/auth-file.lua @@ -405,7 +405,7 @@ function set_cookie(cookie, value) end function redirect_to(url) - html("Status: 302 Redirect\n") + html("Status: 302 Found\n") html("Cache-Control: no-cache, no-store\n") html("Location: " .. strip_controls(url) .. "\n") end diff --git a/custom/extensions/auth-inline.lua b/custom/extensions/auth-inline.lua index 0ae2cb8..5363a38 100644 --- a/custom/extensions/auth-inline.lua +++ b/custom/extensions/auth-inline.lua @@ -366,7 +366,7 @@ function set_cookie(cookie, value) end function redirect_to(url) - html("Status: 302 Redirect\n") + html("Status: 302 Found\n") html("Cache-Control: no-cache, no-store\n") html("Location: " .. strip_controls(url) .. "\n") end diff --git a/custom/hooks/post-receive.cgit-age b/custom/hooks/post-receive.cgit-age index 48b17fc..0567e08 100755 --- a/custom/hooks/post-receive.cgit-age +++ b/custom/hooks/post-receive.cgit-age @@ -1,14 +1,9 @@ #!/bin/sh -# -# Example hook that updates the "age-file" cgit reads for the idle column. -# -# This hook assumes that you are using the default age-file location of -# "info/web/last-modified". If you change the value in your cgitrc then you -# must also change it here. -# -# To install the hook, copy (or link) it to the file "hooks/post-receive" in -# each of your repositories. -# + +# Updates the age-file cgit reads for the idle column. The path below is the +# default age-file, so a cgitrc that changes the setting needs the same change +# here. To install the hook, copy or link it to hooks/post-receive in each +# repository. set -eu @@ -19,14 +14,14 @@ umask 022 agefile="$(git rev-parse --git-dir)"/info/web/last-modified # Committer dates rather than author dates, so a push of rebased or imported -# history still counts as recent activity. Branch tips only, since an -# annotated tag carries no committer date of its own and would sort in as an -# empty line. -date="$(git for-each-ref --sort=-committerdate --count=1 --format='%(committerdate:iso8601)' refs/heads/)" +# history still counts as recent activity. Branch tips only, since an annotated +# tag carries no committer date of its own and would sort in as an empty line. +date="$(git for-each-ref --sort=-committerdate --count=1 \ + --format='%(committerdate:iso8601)' refs/heads/)" # A repository with no branches keeps whatever cgit already had, rather than # being handed an empty file. -[ -n "$date" ] || exit 0 +test -n "$date" || exit 0 mkdir -p "$(dirname "$agefile")" diff --git a/custom/hooks/post-receive.cgit-cache b/custom/hooks/post-receive.cgit-cache index 21550a9..148a3f3 100755 --- a/custom/hooks/post-receive.cgit-cache +++ b/custom/hooks/post-receive.cgit-cache @@ -1,36 +1,33 @@ #!/bin/sh -# -# Example hook that drops cgit's output cache after a push, so new commits -# show up right away instead of once the cache-*-ttl minutes have passed. -# -# This only matters when cache-size in your cgitrc is above 0, which turns -# the cache on. + +# Drops cgit's output cache after a push, so new commits show up right away +# instead of once the cache-*-ttl minutes have passed. It only matters when +# cache-size in cgitrc is above 0, which turns the cache on. # # cgit names each cache slot after a hash of the request url, so there is no # way to expire one repository's pages on their own and this clears the lot. -# cgit refills a slot the next time something asks for it. The cached +# cgit refills a slot the next time something asks for it. The cached # repository scan goes too, which is what makes a brand new repository appear # without waiting out cache-scan-ttl. # -# This hook assumes the default cache-root of "/var/cache/cgit". If you -# change the value in your cgitrc then you must also change it here. -# -# The web server owns the cache root, so the pushing user needs write access -# to it. Nothing here exits nonzero when that access is missing, so the -# pusher is not shown an error over a stale page. -# -# To install the hook, copy (or link) it to the file "hooks/post-receive" in -# each of your repositories. Git runs one post-receive per repository, so -# fold this together with the agefile hook if you want both. +# The path below is the default cache-root, so a cgitrc that changes the +# setting needs the same change here. The web server owns the cache root, so +# the pushing user needs write access to it. Nothing here exits nonzero when +# that access is missing, so the pusher is not shown an error over a stale +# page. # +# To install the hook, copy or link it to hooks/post-receive in each +# repository. Git runs one post-receive per repository, so fold this together +# with the age-file hook to have both. set -eu cache_root=/var/cache/cgit -[ -d "$cache_root" ] || exit 0 +test -d "$cache_root" || exit 0 # Everything directly under the cache root is a cache file, so the only thing # worth keeping is the lock files, which belong to writers still working. # The "! -name . -prune" pair is how POSIX find stays out of subdirectories. -find "$cache_root"/. ! -name . -prune ! -name '*.lock' -type f -exec rm -f {} + || exit 0 +find "$cache_root"/. ! -name . -prune ! -name '*.lock' -type f \ + -exec rm -f {} + || exit 0 diff --git a/custom/servers/apache.conf b/custom/servers/apache.conf index bbd3e75..f25c444 100644 --- a/custom/servers/apache.conf +++ b/custom/servers/apache.conf @@ -205,11 +205,10 @@ AddType text/plain .txt # assets Apache serves. cgit itself sends only the headers the proxy # cannot supply. Those are Status, Content-Type, Content-Length and # Content-Disposition on downloads, Location on redirects, a no-store - # Cache-Control on unauthenticated responses, the auth filter's - # Set-Cookie, and on raw - # repository bytes a nosniff of its own next to the stricter policy - # "default-src 'none'". Everything else, this policy included, is the - # proxy's job. + # Cache-Control on unauthenticated responses, the auth filter's Set-Cookie, + # and on raw repository bytes a nosniff of its own next to the stricter + # policy "default-src 'none'". Everything else, this policy included, is + # the proxy's job. # # The word setifempty is load bearing on the two headers cgit can also # emit. "Header always set" replaces a same-named header even when the diff --git a/custom/servers/lighttpd.conf b/custom/servers/lighttpd.conf index 27c325d..c2a478f 100644 --- a/custom/servers/lighttpd.conf +++ b/custom/servers/lighttpd.conf @@ -76,11 +76,10 @@ $HTTP["host"] == "git.example.org" { # assets lighttpd serves. cgit itself sends only the headers the server # cannot supply. Those are Status, Content-Type, Content-Length and # Content-Disposition on downloads, Location on redirects, a no-store - # Cache-Control on unauthenticated responses, the auth filter's - # Set-Cookie, and on raw - # repository bytes a nosniff of its own next to the stricter policy - # "default-src 'none'". Everything else, this policy included, is the - # server's job. + # Cache-Control on unauthenticated responses, the auth filter's Set-Cookie, + # and on raw repository bytes a nosniff of its own next to the stricter + # policy "default-src 'none'". Everything else, this policy included, is + # the server's job. # # The add in add-response-header is load bearing. It appends a second # copy next to what cgit emitted, so a raw page carries both policies and diff --git a/custom/servers/nginx.conf b/custom/servers/nginx.conf index 3ffa2ba..7049368 100644 --- a/custom/servers/nginx.conf +++ b/custom/servers/nginx.conf @@ -154,11 +154,10 @@ http { # static assets nginx serves directly. cgit itself sends only the # headers the proxy cannot supply. Those are Status, Content-Type, # Content-Length and Content-Disposition on downloads, Location on - # redirects, a no-store Cache-Control on unauthenticated responses, - # the auth filter's - # Set-Cookie, and on raw repository bytes a nosniff of its own next to - # the stricter policy "default-src 'none'". Everything else, this - # policy included, is the proxy's job. + # redirects, a no-store Cache-Control on unauthenticated responses, the + # auth filter's Set-Cookie, and on raw repository bytes a nosniff of its + # own next to the stricter policy "default-src 'none'". Everything else, + # this policy included, is the proxy's job. # # add_header appends and never replaces what cgit sent, so a raw page # carries both policies and the browser enforces the stricter one, diff --git a/tools/gen-version.sh b/tools/gen-version.sh index b28e987..ca8ea65 100755 --- a/tools/gen-version.sh +++ b/tools/gen-version.sh @@ -1,4 +1,5 @@ #!/bin/sh + # Writes a "CGIT_VERSION = ..." line into the output file, which the build # then includes. Run it from the project root, as gen-version.sh <fallback> # [output], so that git describe reports cgit rather than the bundled git diff --git a/tools/release-build.sh b/tools/release-build.sh index babf008..a22b70e 100755 --- a/tools/release-build.sh +++ b/tools/release-build.sh @@ -1,4 +1,5 @@ #!/bin/sh + # Build cgit for a release with Linux hardening flags, which are ELF and GCC or # Clang specific. The flags add a stack protector, fortified libc calls, a # position independent executable, and full RELRO. By default Lua is pinned off @@ -8,7 +9,8 @@ set -eu -if [ "$#" -gt 1 ]; then +if test "$#" -gt 1 +then echo "usage: $0 [lua]" >&2 exit 2 fi @@ -71,4 +73,5 @@ CGIT_EXTRA_CFLAGS="-Wformat -Wformat-security -Werror=format-security" # flags, and cleanall rather than clean because only cleanall descends into # vendor/git. make cleanall -exec make "$@" CFLAGS="$CFLAGS" LDFLAGS="$LDFLAGS" CGIT_EXTRA_CFLAGS="$CGIT_EXTRA_CFLAGS" +exec make "$@" CFLAGS="$CFLAGS" LDFLAGS="$LDFLAGS" \ + CGIT_EXTRA_CFLAGS="$CGIT_EXTRA_CFLAGS" |