Diff options
Diffstat (limited to '')
| -rw-r--r-- | custom/cgitrc | 103 |
1 file changed, 45 insertions, 58 deletions
diff --git a/custom/cgitrc b/custom/cgitrc index 86f00aa..c1a5b68 100644 --- a/custom/cgitrc +++ b/custom/cgitrc @@ -10,10 +10,6 @@ # list repositories by hand in the per-repository section at the end of this # file. # -# About pages (markdown, man and plain-text readmes) can render through the -# 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 # or ; are comments. # Maximum number of entries in the cgit output cache. A value of 0 disables @@ -23,36 +19,33 @@ cache-size=0 # Directory used to store cgit cache entries. Value is a filesystem path that # 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. +# every rendered page and the urls visitors asked for. cache-root=/var/cache/cgit -# Minutes to cache the repository index page. Value is an integer number of -# minutes. Default is 5. +# Minutes to cache the repository index page. Value is an integer. Default is 5. cache-index-ttl=5 -# Minutes to cache the repository summary page. Value is an integer number of -# minutes. Default is 5. +# Minutes to cache the repository summary page. Value is an integer. Default is +# 5. cache-summary-ttl=5 # Minutes to cache the result of scanning a path for repositories. Value is an -# integer number of minutes. Default is 15. +# integer. Default is 15. cache-scan-ttl=15 # 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. +# value keeps the page forever. Value is an integer. Default is -1. cache-static-ttl=-1 # Minutes to cache repository pages requested without a fixed object id. Value -# is an integer number of minutes. Default is 5. +# is an integer. Default is 5. cache-dynamic-ttl=5 -# Minutes to cache the repository about page. Value is an integer number of -# minutes. Default is 15. +# Minutes to cache the repository about page. Value is an integer. Default is +# 15. cache-about-ttl=15 -# Minutes to cache snapshots. Value is an integer number of minutes. Default is -# 5. +# Minutes to cache snapshots. Value is an integer. Default is 5. cache-snapshot-ttl=5 # Largest response, in kilobytes, that a cache slot keeps. A larger one is @@ -82,12 +75,12 @@ root-desc=a fast webinterface for the git dscm #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. +# Value is a url, and each css line adds one. Default is /cgit.css. css=/cgit.css # JavaScript document urls included on every page, loaded with defer in the -# order given. An empty value disables it. Value is one or more urls. Default -# is /cgit.js. +# order given. An empty value disables it. Value is a url, and each js line +# adds one. Default is /cgit.js. js=/cgit.js # Shortcut icon url for all pages. Value is a url. Default is /favicon.ico. @@ -124,8 +117,8 @@ enable-header=1 # or 1. Default is 0. embedded=0 -# Root url for all cgit links, enabling virtual urls. Value is a url path. -# Default is none. +# Root url for all cgit links. Value is a url path. Default is SCRIPT_NAME +# followed by a slash. #virtual-root=/ # Link format string for submodules in directory listings. Value is a format @@ -133,24 +126,21 @@ embedded=0 # Default is none. #module-link=/%s/commit/?id=%s -# Directory scanned for git repositories at parse time. Value is a filesystem -# path that may use macros. Default is none. -#scan-path=/var/lib/git - # When scanning, recurse into dot-directories. Must precede scan-path. Values # are 0 or 1. Default is 0. scan-hidden-path=0 -# Derive default section names from N leading path elements. Must precede -# scan-path. Value is an integer that may be negative. Default is 0. +# Derive default section names from the first N path elements, or from all +# but the last -N when N is negative. Must precede scan-path. Value is an +# integer. Default is 0. section-from-path=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. +# File listing subdirectories 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 repository only if this file exists inside it. Emulates gitweb @@ -233,18 +223,17 @@ enable-remote-branches=0 # 1. Default is 0. enable-subject-links=0 -# Allow /plain to serve HTML mimetypes instead of downgrading to text/plain. -# Values are 0 or 1. Default is 0. +# Allow /plain to serve HTML mimetypes instead of downgrading to text/plain or +# application/octet-stream. Values are 0 or 1. Default is 0. enable-html-serving=0 # Generate line-number links for plaintext blobs in the tree and blame pages. # Values are 0 or 1. Default is 1. enable-tree-linenumbers=1 -# Name the cgit and git versions in the page footer, the generator tag and -# the signature of patches. Exact versions help someone match a site against -# advisories, so they stay out unless asked for. Values are 0 or 1. Default -# is 0. +# Name the cgit version in the page footer, the generator tag and patch +# signatures, and the git version in the footer. Values are 0 or 1. +# Default is 0. enable-version-info=0 # List directories first, then files, in the tree page. Values are 0 or 1. @@ -281,44 +270,38 @@ enable-http-clone=1 # repository ships under custom/extensions/. The ones written as # /path/to/your-command mark where your own command goes. -# Honour every setting in a repository's own cgitrc and git config found by -# scan-path. Those files belong to whoever can push, so without this the -# settings that run a command, put raw markup on the page, serve a file as -# markup, place a link or read a file off the disk are ignored. The repo.* lines -# below never need it. Values are 0 or 1. Default is 0. +# Honour every setting in a scanned repository's own cgitrc and git config, +# including those that run a command or put markup on the page. Those files +# belong to whoever can push. The repo.* lines below never need it. Values are +# 0 or 1. Default is 0. trust-scan-config=0 # Filter command used to format about-page content. The bundled about-render.lua -# renders markdown, man pages and plain text. Value is a command optionally -# prefixed with exec or lua. Default is none. +# renders markdown, man pages and plain text. Value is a command. Default is +# none. #about-filter=lua:/usr/local/lib/cgit/filters/about-render.lua # Filter command used to format commit messages, for example to turn object -# names and issue numbers into links. Value is a command optionally prefixed -# with exec or lua. Default is none. +# names and issue numbers into links. Value is a command. Default is none. #commit-filter=lua:/usr/local/lib/cgit/filters/link-commits.lua # Filter command used to format author and committer emails, for example to add -# avatar images. Value is a command optionally prefixed with exec or lua. -# Default is none. +# avatar images. Value is a command. Default is none. #email-filter=lua:/usr/local/lib/cgit/filters/email-gravatar.lua # Filter command used to format the value of a commit trailer when # enable-commit-trailers is 1. The shipped filter links Fixes, Reverts, Closes, -# Bug and URL values. Value is a command optionally prefixed with exec or lua. -# Default is none. +# Bug and URL values. Value is a command. Default is none. #trailer-filter=lua:/usr/local/lib/cgit/filters/link-trailers.lua # Filter command used to format plaintext blobs in the tree and blame pages. 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. +# comments in custom/extensions/syntax-highlight.lua list what the shipped +# filter needs. Value is a command. Default is none. #source-filter=lua:/usr/local/lib/cgit/filters/syntax-highlight.lua # Filter command invoked to authenticate access, gating repositories behind a # login. See custom/extensions/auth-inline.lua and -# custom/extensions/auth-file.lua. Value is a command optionally prefixed with -# exec or lua. Default is none. +# custom/extensions/auth-file.lua. Value is a command. Default is none. #auth-filter=lua:/usr/local/lib/cgit/filters/auth-inline.lua # Number of items to display in atom feeds. Value is an integer. Default is 10. @@ -332,7 +315,7 @@ max-message-length=80 # integer. Default is 80. max-repodesc-length=80 -# Max blob size in KBytes read into memory for html, plain and blob output. A +# 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 @@ -361,8 +344,7 @@ max-diff-lines=1000 # Branches and tags listed per section on the refs page, and per page on the # dedicated branch and tag pages. A value of 0 or less lists everything on one -# page. -# Value is an integer. Default is 200. +# page. Value is an integer. Default is 200. max-ref-count=200 # Max files considered when detecting renames. A value of -1 uses the git @@ -426,6 +408,11 @@ age-file=info/web/last-modified #mimetype.png=image/png #mimetype.svg=image/svg+xml +# Directory scanned for git repositories at parse time. Each repository found +# inherits the global settings above this line, so it comes after them all. +# Value is a filesystem path that may use macros. Default is none. +#scan-path=/var/lib/git + # Each repository is introduced by a repo.url line. All following repo.* # settings apply to that repository until the next repo.url line. When # repositories are discovered via scan-path the repo. prefix is dropped inside @@ -462,7 +449,7 @@ age-file=info/web/last-modified #repo.section=main # Prefix for snapshot filenames instead of the repository basename. Value is a -# prefix string. Default is none. +# prefix string. Default is the repository basename. #repo.snapshot-prefix=example # Extra content added verbatim to the head of each page for this repository. |