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".
branch-sort::
Flag which, when set to "age", enables date ordering in the branch ref
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. Negative
+ values have infinite ttl. 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. Negative
+ values have infinite ttl. 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. Negative values have infinite
+ ttl. 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. Negative values have infinite
+ ttl. 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. Negative values have infinite
+ ttl. Default value: "15".
+
+cache-about-ttl::
+ Number which specifies the time-to-live, in minutes, for the cached
+ version of the repository about page. Negative values have infinite
+ ttl. Default value: "15".
cache-size::
The maximum number of entries in the cgit cache. Default value: "0"
(i.e. caching is disabled).
-cache-static-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".
-
case-sensitive-sort::
Sort items in the repo list case sensitively. Default value: "1".
See also: repository-sort, section-sort.
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
"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,
- respectivly. All git config keys that begin with "cgit." will be mapped
+ 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
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::
readme::
Text which will be used as default value for "repo.readme". Multiple
- files may be specified, separated by a space, and cgit will use the
- first found file in this list. Default value: none.
+ 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
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
-------------------
....
-# 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