summaryrefslogtreecommitdiff
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt117
1 files changed, 108 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..c3698a6 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -90,11 +90,21 @@ 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
also: "noheader".
-
+
+enable-commit-graph::
+ Flag which, when set to "1", will make cgit print an ASCII-art commit
+ history graph to the left of the commit messages in the repository
+ log page. Default value: "0".
+
enable-filter-overrides::
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-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",
@@ -110,6 +120,17 @@ enable-log-linecount::
and removed lines for each commit on the repository log page. Default
value: "0".
+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:
+ "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".
+
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".
@@ -161,6 +182,10 @@ logo-link::
calculated url of the repository index page will be used. Default
value: none.
+max-atom-items::
+ Specifies the number of items to display in atom feeds view. Default
+ value: "10".
+
max-commit-count::
Specifies the number of entries to list per page in "log" view. Default
value: "50".
@@ -177,6 +202,10 @@ max-repodesc-length::
Specifies the maximum number of repo description characters to display
on the repository index page. Default value: "80".
+max-blob-size::
+ Specifies the maximum size of a blob to display HTML for in KBytes.
+ Default value: "0" (limit disabled).
+
max-stats::
Set the default maximum statistics period. Valid values are "week",
"month", "quarter" and "year". If unspecified, statistics are
@@ -205,6 +234,20 @@ noheader::
Flag which, when set to "1", will make cgit omit the standard header
on all pages. Default value: none. See also: "embedded".
+project-list::
+ A list of subdirectories inside of scan-path, relative to it, that
+ should loaded as git repositories. This must be defined prior to
+ scan-path. Default value: none. See also: scan-path.
+
+readme::
+ Text which will be used as default value for "repo.readme". Default
+ value: none.
+
+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.
+
renamelimit::
Maximum number of files to consider when detecting renames. The value
"-1" uses the compiletime value in git (for further info, look at
@@ -231,16 +274,37 @@ root-title::
Text printed as heading on the repository index page. Default value:
"Git Repository Browser".
+scan-hidden-path::
+ If set to "1" and scan-path is enabled, scan-path will recurse 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.
+
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. Default value: none. See also: cache-scanrc-ttl.
+ 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. Default value: none. See also: cache-scanrc-ttl,
+ project-list.
section::
The name of the current repository section - all repositories defined
after this option will inherit the current section name. Default value:
none.
+section-from-path::
+ A number which, if specified before 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.
+
+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
@@ -266,6 +330,13 @@ summary-tags::
Specifies the number of tags to display in the repository "summary"
view. Default value: "10".
+strict-export::
+ 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'.
+
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
@@ -296,6 +367,10 @@ repo.defbranch::
repo.desc::
The value to show as repository description. Default value: none.
+repo.enable-commit-graph::
+ A flag which can be used to disable the global setting
+ `enable-commit-graph'. Default value: none.
+
repo.enable-log-filecount::
A flag which can be used to disable the global setting
`enable-log-filecount'. Default value: none.
@@ -304,6 +379,23 @@ repo.enable-log-linecount::
A flag which can be used to disable the global setting
`enable-log-linecount'. Default value: none.
+repo.enable-remote-branches::
+ Flag which, when set to "1", will make cgit display remote branches
+ in the summary and refs views. Default value: <enable-remote-branches>.
+
+repo.enable-subject-links::
+ A flag which can be used to override the global setting
+ `enable-subject-links'. Default value: none.
+
+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.
+
+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: global logo-link.
+
repo.max-stats::
Override the default maximum statistics period. Valid values are equal
to the values specified for the global "max-stats" setting. Default
@@ -322,7 +414,9 @@ repo.path::
repo.readme::
A path (relative to <repo.path>) which specifies a file to include
- verbatim as the "About" page for this repo. Default value: none.
+ 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>.
repo.snapshots::
A mask of allowed snapshot-formats for this repo, restricted by the
@@ -363,7 +457,7 @@ cache-size=1000
# Specify some default clone prefixes
-clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
+clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
# Specify the css url
css=/css/cgit.css
@@ -373,6 +467,10 @@ css=/css/cgit.css
enable-index-links=1
+# Enable ASCII art commit history graph on the log pages
+enable-commit-graph=1
+
+
# Show number of affected files per commit on the log pages
enable-log-filecount=1
@@ -394,14 +492,14 @@ max-stats=quarter
# Set the title and heading of the repository index page
-root-title=foobar.com git repositories
+root-title=example.com git repositories
# Set a subheading for the repository index page
root-desc=tracking the foobar development
-# Include some more info about foobar.com on the index page
+# Include some more info about example.com on the index page
root-readme=/var/www/htdocs/about.html
@@ -413,7 +511,7 @@ snapshots=tar.gz tar.bz2 zip
## List of common mimetypes
##
-mimetype.git=image/git
+mimetype.gif=image/gif
mimetype.html=text/html
mimetype.jpg=image/jpeg
mimetype.jpeg=image/jpeg
@@ -435,14 +533,14 @@ mimetype.svg=image/svg+xml
repo.url=foo
repo.path=/pub/git/foo.git
repo.desc=the master foo repository
-repo.owner=fooman@foobar.com
+repo.owner=fooman@example.com
repo.readme=info/web/about.html
repo.url=bar
repo.path=/pub/git/bar.git
repo.desc=the bars for your foo
-repo.owner=barman@foobar.com
+repo.owner=barman@example.com
repo.readme=info/web/about.html
@@ -499,3 +597,4 @@ will generate the following html element:
AUTHOR
------
Lars Hjemli <hjemli@gmail.com>
+Jason A. Donenfeld <Jason@zx2c4.com>