cgitrc.5.txt: describe where/how cgit will locate cgitrc

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d8e4b97b18f80e4ef50fff0b551b2257e8773eb7..3c35b02ad5b6eb8983e3144a8796db6591e2b50a 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -14,6 +14,13 @@ repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
+LOCATION
+--------
+The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
+runtime, cgit will consult the environment variable CGIT_CONFIG and, if
+defined, use its value instead.
+
+
 GLOBAL SETTINGS
 ---------------
 about-filter::
@@ -132,7 +139,7 @@ local-time::
 
 logo::
        Url which specifies the source of an image which will be used as a logo
-       on all cgit pages.
+       on all cgit pages. Default value: "/cgit.png".
 
 logo-link::
        Url loaded when clicking on the cgit logo image. If unspecified the
@@ -160,6 +167,10 @@ max-stats::
        "month", "quarter" and "year". If unspecified, statistics are
        disabled. Default value: none. See also: "repo.max-stats".
 
+mimetype.<ext>::
+       Set the mimetype for the specified filename extension. This is used
+       by the `plain` command when returning blob content.
+
 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
@@ -171,6 +182,10 @@ nocache::
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 
+noplainemail::
+       If set to "1" showing full author email adresses will be disabled.
+       Default value: "0".
+
 noheader::
        Flag which, when set to "1", will make cgit omit the standard header
        on all pages. Default value: none. See also: "embedded".
@@ -354,6 +369,19 @@ root-readme=/var/www/htdocs/about.html
 snapshots=tar.gz tar.bz2 zip
 
 
+##
+## List of common mimetypes
+##
+
+mimetype.git=image/git
+mimetype.html=text/html
+mimetype.jpg=image/jpeg
+mimetype.jpeg=image/jpeg
+mimetype.pdf=application/pdf
+mimetype.png=image/png
+mimetype.svg=image/svg+xml
+
+
 ##
 ## List of repositories.
 ## PS: Any repositories listed when repo.group is unset will not be