about-filter::
Specifies a command which will be invoked to format the content of
about pages (both top-level and for each repository). The command will
- get the content of the about-file on its STDIN, and the STDOUT from the
- command will be included verbatim on the about page. Default value:
- none. See also: "FILTER API".
+ get the content of the about-file on its STDIN, the name of the file
+ as the first argument, and the STDOUT from the command will be
+ included verbatim on the about page. Default value: none. See
+ also: "FILTER API".
agefile::
Specifies a path, relative to each repository path, which can be used
to specify the date and time of the youngest commit in the repository.
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". Default value: "info/web/last-modified".
+ hh:mm:ss". You may want to generate this file from a post-receive
+ hook. Default value: "info/web/last-modified".
+
+auth-filter::
+ Specifies a command that will be invoked for authenticating repository
+ access. Receives quite a few arguments, and data on both stdin and
+ stdout for authentication processing. Details follow later in this
+ document. If no auth-filter is specified, no authentication is
+ performed. Default value: none. See also: "FILTER API".
+
+branch-sort::
+ Flag which, when set to "age", enables date ordering in the branch ref
+ list, and when set to "name" enables ordering by branch name. Default
+ value: "name".
cache-root::
Path used to store the cgit cache entries. Default value:
"/var/cache/cgit". See also: "MACRO EXPANSION".
+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:
+ "CACHE". Default value: -1".
+
cache-dynamic-ttl::
Number which specifies the time-to-live, in minutes, for the cached
- version of repository pages accessed without a fixed SHA1. Default
- value: "5".
+ version of repository pages accessed without a fixed SHA1. See also:
+ "CACHE". Default value: "5".
cache-repo-ttl::
Number which specifies the time-to-live, in minutes, for the cached
- version of the repository summary page. Default value: "5".
+ version of the repository summary page. See also: "CACHE". Default
+ value: "5".
cache-root-ttl::
Number which specifies the time-to-live, in minutes, for the cached
- version of the repository index page. Default value: "5".
+ version of the repository index page. See also: "CACHE". Default
+ value: "5".
cache-scanrc-ttl::
Number which specifies the time-to-live, in minutes, for the result
- of scanning a path for git repositories. Default value: "15".
+ of scanning a path for git repositories. See also: "CACHE". Default
+ value: "15".
-cache-size::
- The maximum number of entries in the cgit cache. Default value: "0"
- (i.e. caching is disabled).
+cache-about-ttl::
+ Number which specifies the time-to-live, in minutes, for the cached
+ version of the repository about page. See also: "CACHE". Default
+ value: "15".
-cache-static-ttl::
+cache-snapshot-ttl::
Number which specifies the time-to-live, in minutes, for the cached
- version of repository pages accessed with a fixed SHA1. Default value:
- "5".
+ version of snapshots. See also: "CACHE". Default value: "5".
+
+cache-size::
+ The maximum number of entries in the cgit cache. When set to "0",
+ caching is disabled. See also: "CACHE". Default value: "0"
+
+case-sensitive-sort::
+ Sort items in the repo list case sensitively. Default value: "1".
+ See also: repository-sort, section-sort.
clone-prefix::
Space-separated list of common prefixes which, when combined with a
be used to implement bugtracker integration. Default value: none.
See also: "FILTER API".
+commit-sort::
+ Flag which, when set to "date", enables strict date ordering in the
+ commit log, and when set to "topo" enables strict topological
+ ordering. If unset, the default ordering of "git log" is used. Default
+ value: unset.
+
css::
Url which specifies the css document to include in all cgit pages.
Default value: "/cgit.css".
+email-filter::
+ Specifies a command which will be invoked to format names and email
+ address of committers, authors, and taggers, as represented in various
+ places throughout the cgit interface. This command will receive an
+ email address and an origin page string as its command line arguments,
+ and the text to format on STDIN. It is to write the formatted text back
+ out onto STDOUT. Default value: none. See also: "FILTER API".
+
embedded::
Flag which, when set to "1", will make cgit generate a html fragment
suitable for embedding in other html pages. Default value: none. See
Flag which, when set to "1", allows all filter settings to be
overridden in repository-specific cgitrc files. Default value: none.
-enable-gitweb-owner::
- If set to "1" and scan-path is enabled, we first check each repository
- for the git config value "gitweb.owner" to determine the owner.
- Default value: "1". See also: scan-path.
+enable-follow-links::
+ Flag which, when set to "1", allows users to follow a file in the log
+ view. Default value: "0".
enable-http-clone::
If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
- If you use an alternate way of serving git repositories, you may wish
- to disable this. Default value: "1".
+ You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url
+ to expose this feature. If you use an alternate way of serving git
+ repositories, you may wish to disable this. Default value: "1".
enable-index-links::
Flag which, when set to "1", will make cgit generate extra links for
each repo in the repository index (specifically, to the "summary",
"commit" and "tree" pages). Default value: "0".
+enable-index-owner::
+ Flag which, when set to "1", will make cgit display the owner of
+ each repo in the repository index. Default value: "1".
+
enable-log-filecount::
Flag which, when set to "1", will make cgit print the number of
modified files for each commit on the repository log page. Default
in commit view. Default value: "0". See also:
"repo.enable-subject-links".
+enable-html-serving::
+ Flag which, when set to "1", will allow the /plain handler to serve
+ mimetype headers that result in the file being treated as HTML by the
+ browser. When set to "0", such file types are returned instead as
+ text/plain or application/octet-stream. Default value: "0". See also:
+ "repo.enable-html-serving".
+
enable-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".
+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, gitweb.description,
+ and gitweb.homepage will map to the cgit keys repo.owner, repo.section,
+ repo.desc, and repo.homepage respectively. All git config keys that begin
+ with "cgit." will be mapped to the corresponding "repo." key in cgit.
+ Default value: "0". See also: scan-path, section-from-path.
+
favicon::
- Url used as link to a shortcut icon for cgit. If specified, it is
- suggested to use the value "/favicon.ico" since certain browsers will
- ignore other values. Default value: none.
+ Url used as link to a shortcut icon for cgit. It is suggested to use
+ the value "/favicon.ico" since certain browsers will ignore other
+ values. Default value: "/favicon.ico".
footer::
The content of the file specified with this option will be included
calculated url of the repository index page will be used. Default
value: none.
+owner-filter::
+ Specifies a command which will be invoked to format the Owner
+ column of the main page. The command will get the owner on STDIN,
+ and the STDOUT from the command will be included verbatim in the
+ table. This can be used to link to additional context such as an
+ owners home page. When active this filter is used instead of the
+ default owner query url. Default value: none.
+ See also: "FILTER API".
+
max-atom-items::
Specifies the number of items to display in atom feeds view. Default
value: "10".
Set the mimetype for the specified filename extension. This is used
by the `plain` command when returning blob content.
+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>".
+
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
value: "0".
noplainemail::
- If set to "1" showing full author email adresses will be disabled.
+ If set to "1" showing full author email addresses will be disabled.
Default value: "0".
noheader::
EXPANSION".
readme::
- Text which will be used as default value for "repo.readme". Default
- value: none.
+ Text which will be used as default value for "repo.readme". Multiple
+ config keys may be specified, and cgit will use the first found file
+ in this list. This is useful in conjunction with scan-path. Default
+ value: none. See also: scan-path, repo.readme.
remove-suffix::
If set to "1" and scan-path is enabled, if any repositories are found
with a suffix of ".git", this suffix will be removed for the url and
- name. Default value: "0". See also: scan-path.
+ name. This must be defined prior to scan-path. Default value: "0".
+ See also: scan-path.
renamelimit::
Maximum number of files to consider when detecting renames. The value
Legacy alias for "section". This option is deprecated and will not be
supported in cgit-1.0.
+repository-sort::
+ The way in which repositories in each section are sorted. Valid values
+ are "name" for sorting by the repo name or "age" for sorting by the
+ most recently updated repository. Default value: "name". See also:
+ section, case-sensitive-sort, section-sort.
+
robots::
Text used as content for the "robots" meta-tag. Default value:
"index, nofollow".
after this option will inherit the current section name. Default value:
none.
+section-sort::
+ Flag which, when set to "1", will sort the sections on the repository
+ listing by name. Set this flag to "0" if the order in the cgitrc file should
+ be preserved. Default value: "1". See also: section,
+ case-sensitive-sort, repository-sort.
+
section-from-path::
- A number which, if specified before scan-path, specifies how many
+ 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.
+ above the repo directory. Default value: "0".
side-by-side-diffs::
If set to "1" shows side-by-side diffs instead of unidiffs per
default. Default value: "0".
snapshots::
- Text which specifies the default set of snapshot formats generated by
- cgit. The value is a space-separated list of zero or more of the
- values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
- none.
+ Text which specifies the default set of snapshot formats that cgit
+ generates links for. The value is a space-separated list of zero or
+ more of the values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip".
+ Default value: none.
source-filter::
Specifies a command which will be invoked to format plaintext blobs
Filename which, if specified, needs to be present within the repository
for cgit to allow access to that repository. This can be used to emulate
gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
- repositories to match those exported by git-daemon. This option MUST come
- before 'scan-path'.
+ repositories to match those exported by git-daemon. This option must
+ be defined prior to scan-path.
virtual-root::
Url which, if specified, will be used as root for all cgit links. It
NOTE: cgit has recently learned how to use PATH_INFO to achieve the
same kind of virtual urls, so this option will probably be deprecated.
+
REPOSITORY SETTINGS
-------------------
repo.about-filter::
Override the default about-filter. Default value: none. See also:
"enable-filter-overrides". See also: "FILTER API".
+repo.branch-sort::
+ Flag which, when set to "age", enables date ordering in the branch ref
+ list, and when set to "name" enables ordering by branch name. Default
+ value: "name".
+
repo.clone-url::
A list of space-separated urls which can be used to clone this repo.
Default value: none. See also: "MACRO EXPANSION".
Override the default commit-filter. Default value: none. See also:
"enable-filter-overrides". See also: "FILTER API".
+repo.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.
+
repo.defbranch::
The name of the default branch for this repository. If no such branch
exists in the repository, the first branch name (when sorted) is used
- as default instead. Default value: "master".
+ as default instead. Default value: branch pointed to by HEAD, or
+ "master" if there is no suitable HEAD.
repo.desc::
The value to show as repository description. Default value: none.
+repo.homepage::
+ The value to show as repository homepage. Default value: none.
+
+repo.email-filter::
+ Override the default email-filter. Default value: none. See also:
+ "enable-filter-overrides". See also: "FILTER API".
+
repo.enable-commit-graph::
A flag which can be used to disable the global setting
`enable-commit-graph'. Default value: none.
A flag which can be used to override the global setting
`enable-subject-links'. Default value: none.
+enable-html-serving::
+ A flag which can be used to override the global setting
+ `enable-html-serving`. Default value: none.
+
+repo.hide::
+ Flag which, when set to "1", hides the repository from the repository
+ index. The repository can still be accessed by providing a direct path.
+ Default value: "0". See also: "repo.ignore".
+
+repo.ignore::
+ Flag which, when set to "1", ignores the repository. The repository
+ is not shown in the index and cannot be accessed by providing a direct
+ path. Default value: "0". See also: "repo.hide".
+
repo.logo::
Url which specifies the source of an image which will be used as a logo
on this repo's pages. Default value: global logo.
calculated url of the repository index page will be used. Default
value: global logo-link.
+repo.owner-filter::
+ Override the default owner-filter. Default value: none. See also:
+ "enable-filter-overrides". See also: "FILTER API".
+
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
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" Default value: <readme>.
+ a colon. For example, "master:docs/readme.mkd". If the value begins
+ with a colon, i.e. ":docs/readme.rst", 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>.
repo.snapshots::
- A mask of allowed snapshot-formats for this repo, restricted by the
- "snapshots" global setting. Default value: <snapshots>.
+ A mask of snapshot formats for this repo that cgit generates links for,
+ restricted by the global "snapshots" setting. Default value:
+ <snapshots>.
repo.section::
Override the current section name for this repository. Default value:
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; available values are:
+
+'exec:'::
+ The default "one process per filter" mode.
+
+'lua:'::
+ Executes the script using a built-in Lua interpreter. The script is
+ loaded once per execution of cgit, and may be called multiple times
+ during cgit's lifetime, making it a good choice for repeated filters
+ such as the 'email filter'. It responds to three functions:
+
+ 'filter_open(argument1, argument2, argument3, ...)'::
+ This is called upon activation of the filter for a particular
+ set of data.
+ 'filter_write(buffer)'::
+ This is called whenever cgit writes data to the webpage.
+ 'filter_close()'::
+ This is called when the current filtering operation is
+ completed. It must return an integer value. Usually 0
+ indicates success.
+
+ Additionally, cgit exposes to the Lua the following built-in functions:
+
+ 'html(str)'::
+ Writes 'str' to the webpage.
+ 'html_txt(str)'::
+ HTML escapes and writes 'str' to the webpage.
+ 'html_attr(str)'::
+ HTML escapes for an attribute and writes "str' to the webpage.
+ 'html_url_path(str)'::
+ URL escapes for a path and writes 'str' to the webpage.
+ 'html_url_arg(str)'::
+ URL escapes for an argument and writes 'str' to the webpage.
+ 'html_include(file)'::
+ Includes 'file' in webpage.
+
+
+Parameters are provided to filters as follows.
+
about filter::
- This filter is given no arguments. The about text that is to be
- filtered is available on standard input and the filtered text is
- expected on standard output.
+ 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.
commit filter::
This filter is given no arguments. The commit message text that is to
be filtered is available on standard input and the filtered text is
expected on standard output.
+email filter::
+ This filter is given two parameters: the email address of the relevent
+ 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.
+
+owner filter::
+ This filter is given no arguments. The owner text is avilable on
+ standard input and the filter is expected to write to standard
+ output. The output is included in the Owner column.
+
source filter::
This filter is given a single parameter: the filename of the source
file to filter. The filter can use the filename to determine (for
file that is to be filtered is available on standard input and the
filtered contents is expected on standard output.
-Also, all filters are handed the following environment variables:
+auth filter::
+ The authentication filter receives 12 parameters:
+ - filter action, explained below, which specifies which action the
+ filter is called for
+ - http cookie
+ - http method
+ - http referer
+ - http path
+ - http https flag
+ - cgit repo
+ - cgit page
+ - cgit url
+ - cgit login url
+ When the filter action is "body", this filter must write to output the
+ 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 invalid,
+ 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.
+
+ Please see `filters/simple-authentication.lua` for a clear example
+ script that may be modified.
+
+
+All filters are handed the following environment variables:
- CGIT_REPO_URL (from repo.url)
- CGIT_REPO_NAME (from repo.name)
MACRO EXPANSION
---------------
-The following cgitrc options supports a simple macro expansion feature,
-where tokens prefixed with "$" are replaced with the value of a similary
+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:
- cache-root
- repo.clone-url
+CACHE
+------
+
+All cache ttl values are in minutes. Negative ttl values indicate that a page
+type will never expire, and thus the first time a URL is accessed, the result
+will be cached indefinitely, even if the underlying git repository changes.
+Conversely, when a ttl value is zero, the cache is disabled for that
+particular page type, and the page type is never cached.
+
+
EXAMPLE CGITRC FILE
-------------------
....
-# Enable caching of up to 1000 output entriess
+# Enable caching of up to 1000 output entries
cache-size=1000
css=/css/cgit.css
+# Show owner on index page
+enable-index-owner=1
+
+
+# Allow http transport git clone
+enable-http-clone=1
+
+
# Show extra links for each repository on the index page
enable-index-links=1
enable-log-linecount=1
+# Sort branches by date
+branch-sort=age
+
+
# Add a cgit favicon
favicon=/favicon.ico
mimetype.svg=image/svg+xml
+# Highlight source code with python pygments-based highlighter
+source-filter=/var/www/cgit/filters/syntax-highlighting.py
+
+# Format markdown, restructuredtext, manpages, text files, and html files
+# through the right converters
+about-filter=/var/www/cgit/filters/about-formatting.sh
+
+##
+## Search for these files in the root of the default branch of repositories
+## for coming up with the about page:
+##
+readme=:README.md
+readme=:readme.md
+readme=:README.mkd
+readme=:readme.mkd
+readme=:README.rst
+readme=:readme.rst
+readme=:README.html
+readme=:readme.html
+readme=:README.htm
+readme=:readme.htm
+readme=:README.txt
+readme=:readme.txt
+readme=:README
+readme=:readme
+readme=:INSTALL.md
+readme=:install.md
+readme=:INSTALL.mkd
+readme=:install.mkd
+readme=:INSTALL.rst
+readme=:install.rst
+readme=:INSTALL.html
+readme=:install.html
+readme=:INSTALL.htm
+readme=:install.htm
+readme=:INSTALL.txt
+readme=:install.txt
+readme=:INSTALL
+readme=:install
+
+
##
## List of repositories.
## PS: Any repositories listed when section is unset will not be
git.ckatri.com / cgit.git / blobdiff