summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0d18290..68ae2ed 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,120 +1,124 @@
1CGITRC(5) 1CGITRC(5)
2======== 2========
3 3
4 4
5NAME 5NAME
6---- 6----
7cgitrc - runtime configuration for cgit 7cgitrc - runtime configuration for cgit
8 8
9 9
10SYNOPSIS 10SYNOPSIS
11-------- 11--------
12Cgitrc contains all runtime settings for cgit, including the list of git 12Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored. 14lines, and lines starting with '#', are ignored.
15 15
16 16
17LOCATION 17LOCATION
18-------- 18--------
19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At 19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
20runtime, cgit will consult the environment variable CGIT_CONFIG and, if 20runtime, cgit will consult the environment variable CGIT_CONFIG and, if
21defined, use its value instead. 21defined, use its value instead.
22 22
23 23
24GLOBAL SETTINGS 24GLOBAL SETTINGS
25--------------- 25---------------
26about-filter:: 26about-filter::
27 Specifies a command which will be invoked to format the content of 27 Specifies a command which will be invoked to format the content of
28 about pages (both top-level and for each repository). The command will 28 about pages (both top-level and for each repository). The command will
29 get the content of the about-file on its STDIN, and the STDOUT from the 29 get the content of the about-file on its STDIN, and the STDOUT from the
30 command will be included verbatim on the about page. Default value: 30 command will be included verbatim on the about page. Default value:
31 none. 31 none.
32 32
33agefile:: 33agefile::
34 Specifies a path, relative to each repository path, which can be used 34 Specifies a path, relative to each repository path, which can be used
35 to specify the date and time of the youngest commit in the repository. 35 to specify the date and time of the youngest commit in the repository.
36 The first line in the file is used as input to the "parse_date" 36 The first line in the file is used as input to the "parse_date"
37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
38 hh:mm:ss". Default value: "info/web/last-modified". 38 hh:mm:ss". Default value: "info/web/last-modified".
39 39
40cache-root:: 40cache-root::
41 Path used to store the cgit cache entries. Default value: 41 Path used to store the cgit cache entries. Default value:
42 "/var/cache/cgit". 42 "/var/cache/cgit".
43 43
44cache-dynamic-ttl:: 44cache-dynamic-ttl::
45 Number which specifies the time-to-live, in minutes, for the cached 45 Number which specifies the time-to-live, in minutes, for the cached
46 version of repository pages accessed without a fixed SHA1. Default 46 version of repository pages accessed without a fixed SHA1. Default
47 value: "5". 47 value: "5".
48 48
49cache-repo-ttl:: 49cache-repo-ttl::
50 Number which specifies the time-to-live, in minutes, for the cached 50 Number which specifies the time-to-live, in minutes, for the cached
51 version of the repository summary page. Default value: "5". 51 version of the repository summary page. Default value: "5".
52 52
53cache-root-ttl:: 53cache-root-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached 54 Number which specifies the time-to-live, in minutes, for the cached
55 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
56 56
57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15".
60
57cache-size:: 61cache-size::
58 The maximum number of entries in the cgit cache. Default value: "0" 62 The maximum number of entries in the cgit cache. Default value: "0"
59 (i.e. caching is disabled). 63 (i.e. caching is disabled).
60 64
61cache-static-ttl:: 65cache-static-ttl::
62 Number which specifies the time-to-live, in minutes, for the cached 66 Number which specifies the time-to-live, in minutes, for the cached
63 version of repository pages accessed with a fixed SHA1. Default value: 67 version of repository pages accessed with a fixed SHA1. Default value:
64 "5". 68 "5".
65 69
66clone-prefix:: 70clone-prefix::
67 Space-separated list of common prefixes which, when combined with a 71 Space-separated list of common prefixes which, when combined with a
68 repository url, generates valid clone urls for the repository. This 72 repository url, generates valid clone urls for the repository. This
69 setting is only used if `repo.clone-url` is unspecified. Default value: 73 setting is only used if `repo.clone-url` is unspecified. Default value:
70 none. 74 none.
71 75
72commit-filter:: 76commit-filter::
73 Specifies a command which will be invoked to format commit messages. 77 Specifies a command which will be invoked to format commit messages.
74 The command will get the message on its STDIN, and the STDOUT from the 78 The command will get the message on its STDIN, and the STDOUT from the
75 command will be included verbatim as the commit message, i.e. this can 79 command will be included verbatim as the commit message, i.e. this can
76 be used to implement bugtracker integration. Default value: none. 80 be used to implement bugtracker integration. Default value: none.
77 81
78css:: 82css::
79 Url which specifies the css document to include in all cgit pages. 83 Url which specifies the css document to include in all cgit pages.
80 Default value: "/cgit.css". 84 Default value: "/cgit.css".
81 85
82embedded:: 86embedded::
83 Flag which, when set to "1", will make cgit generate a html fragment 87 Flag which, when set to "1", will make cgit generate a html fragment
84 suitable for embedding in other html pages. Default value: none. See 88 suitable for embedding in other html pages. Default value: none. See
85 also: "noheader". 89 also: "noheader".
86 90
87enable-index-links:: 91enable-index-links::
88 Flag which, when set to "1", will make cgit generate extra links for 92 Flag which, when set to "1", will make cgit generate extra links for
89 each repo in the repository index (specifically, to the "summary", 93 each repo in the repository index (specifically, to the "summary",
90 "commit" and "tree" pages). Default value: "0". 94 "commit" and "tree" pages). Default value: "0".
91 95
92enable-log-filecount:: 96enable-log-filecount::
93 Flag which, when set to "1", will make cgit print the number of 97 Flag which, when set to "1", will make cgit print the number of
94 modified files for each commit on the repository log page. Default 98 modified files for each commit on the repository log page. Default
95 value: "0". 99 value: "0".
96 100
97enable-log-linecount:: 101enable-log-linecount::
98 Flag which, when set to "1", will make cgit print the number of added 102 Flag which, when set to "1", will make cgit print the number of added
99 and removed lines for each commit on the repository log page. Default 103 and removed lines for each commit on the repository log page. Default
100 value: "0". 104 value: "0".
101 105
102favicon:: 106favicon::
103 Url used as link to a shortcut icon for cgit. If specified, it is 107 Url used as link to a shortcut icon for cgit. If specified, it is
104 suggested to use the value "/favicon.ico" since certain browsers will 108 suggested to use the value "/favicon.ico" since certain browsers will
105 ignore other values. Default value: none. 109 ignore other values. Default value: none.
106 110
107footer:: 111footer::
108 The content of the file specified with this option will be included 112 The content of the file specified with this option will be included
109 verbatim at the bottom of all pages (i.e. it replaces the standard 113 verbatim at the bottom of all pages (i.e. it replaces the standard
110 "generated by..." message. Default value: none. 114 "generated by..." message. Default value: none.
111 115
112head-include:: 116head-include::
113 The content of the file specified with this option will be included 117 The content of the file specified with this option will be included
114 verbatim in the html HEAD section on all pages. Default value: none. 118 verbatim in the html HEAD section on all pages. Default value: none.
115 119
116header:: 120header::
117 The content of the file specified with this option will be included 121 The content of the file specified with this option will be included
118 verbatim at the top of all pages. Default value: none. 122 verbatim at the top of all pages. Default value: none.
119 123
120include:: 124include::
@@ -138,128 +142,133 @@ local-time::
138 servers timezone. Default value: "0". 142 servers timezone. Default value: "0".
139 143
140logo:: 144logo::
141 Url which specifies the source of an image which will be used as a logo 145 Url which specifies the source of an image which will be used as a logo
142 on all cgit pages. Default value: "/cgit.png". 146 on all cgit pages. Default value: "/cgit.png".
143 147
144logo-link:: 148logo-link::
145 Url loaded when clicking on the cgit logo image. If unspecified the 149 Url loaded when clicking on the cgit logo image. If unspecified the
146 calculated url of the repository index page will be used. Default 150 calculated url of the repository index page will be used. Default
147 value: none. 151 value: none.
148 152
149max-commit-count:: 153max-commit-count::
150 Specifies the number of entries to list per page in "log" view. Default 154 Specifies the number of entries to list per page in "log" view. Default
151 value: "50". 155 value: "50".
152 156
153max-message-length:: 157max-message-length::
154 Specifies the maximum number of commit message characters to display in 158 Specifies the maximum number of commit message characters to display in
155 "log" view. Default value: "80". 159 "log" view. Default value: "80".
156 160
157max-repo-count:: 161max-repo-count::
158 Specifies the number of entries to list per page on therepository 162 Specifies the number of entries to list per page on therepository
159 index page. Default value: "50". 163 index page. Default value: "50".
160 164
161max-repodesc-length:: 165max-repodesc-length::
162 Specifies the maximum number of repo description characters to display 166 Specifies the maximum number of repo description characters to display
163 on the repository index page. Default value: "80". 167 on the repository index page. Default value: "80".
164 168
165max-stats:: 169max-stats::
166 Set the default maximum statistics period. Valid values are "week", 170 Set the default maximum statistics period. Valid values are "week",
167 "month", "quarter" and "year". If unspecified, statistics are 171 "month", "quarter" and "year". If unspecified, statistics are
168 disabled. Default value: none. See also: "repo.max-stats". 172 disabled. Default value: none. See also: "repo.max-stats".
169 173
170mimetype.<ext>:: 174mimetype.<ext>::
171 Set the mimetype for the specified filename extension. This is used 175 Set the mimetype for the specified filename extension. This is used
172 by the `plain` command when returning blob content. 176 by the `plain` command when returning blob content.
173 177
174module-link:: 178module-link::
175 Text which will be used as the formatstring for a hyperlink when a 179 Text which will be used as the formatstring for a hyperlink when a
176 submodule is printed in a directory listing. The arguments for the 180 submodule is printed in a directory listing. The arguments for the
177 formatstring are the path and SHA1 of the submodule commit. Default 181 formatstring are the path and SHA1 of the submodule commit. Default
178 value: "./?repo=%s&page=commit&id=%s" 182 value: "./?repo=%s&page=commit&id=%s"
179 183
180nocache:: 184nocache::
181 If set to the value "1" caching will be disabled. This settings is 185 If set to the value "1" caching will be disabled. This settings is
182 deprecated, and will not be honored starting with cgit-1.0. Default 186 deprecated, and will not be honored starting with cgit-1.0. Default
183 value: "0". 187 value: "0".
184 188
185noplainemail:: 189noplainemail::
186 If set to "1" showing full author email adresses will be disabled. 190 If set to "1" showing full author email adresses will be disabled.
187 Default value: "0". 191 Default value: "0".
188 192
189noheader:: 193noheader::
190 Flag which, when set to "1", will make cgit omit the standard header 194 Flag which, when set to "1", will make cgit omit the standard header
191 on all pages. Default value: none. See also: "embedded". 195 on all pages. Default value: none. See also: "embedded".
192 196
193renamelimit:: 197renamelimit::
194 Maximum number of files to consider when detecting renames. The value 198 Maximum number of files to consider when detecting renames. The value
195 "-1" uses the compiletime value in git (for further info, look at 199 "-1" uses the compiletime value in git (for further info, look at
196 `man git-diff`). Default value: "-1". 200 `man git-diff`). Default value: "-1".
197 201
198repo.group:: 202repo.group::
199 A value for the current repository group, which all repositories 203 A value for the current repository group, which all repositories
200 specified after this setting will inherit. Default value: none. 204 specified after this setting will inherit. Default value: none.
201 205
206repo.scan::
207 A path which will be scanned for repositories. If caching is enabled,
208 the result will be cached as a cgitrc include-file in the cache
209 directory. Default value: none. See also: cache-scanrc-ttl.
210
202robots:: 211robots::
203 Text used as content for the "robots" meta-tag. Default value: 212 Text used as content for the "robots" meta-tag. Default value:
204 "index, nofollow". 213 "index, nofollow".
205 214
206root-desc:: 215root-desc::
207 Text printed below the heading on the repository index page. Default 216 Text printed below the heading on the repository index page. Default
208 value: "a fast webinterface for the git dscm". 217 value: "a fast webinterface for the git dscm".
209 218
210root-readme:: 219root-readme::
211 The content of the file specified with this option will be included 220 The content of the file specified with this option will be included
212 verbatim below the "about" link on the repository index page. Default 221 verbatim below the "about" link on the repository index page. Default
213 value: none. 222 value: none.
214 223
215root-title:: 224root-title::
216 Text printed as heading on the repository index page. Default value: 225 Text printed as heading on the repository index page. Default value:
217 "Git Repository Browser". 226 "Git Repository Browser".
218 227
219snapshots:: 228snapshots::
220 Text which specifies the default set of snapshot formats generated by 229 Text which specifies the default set of snapshot formats generated by
221 cgit. The value is a space-separated list of zero or more of the 230 cgit. The value is a space-separated list of zero or more of the
222 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 231 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
223 232
224source-filter:: 233source-filter::
225 Specifies a command which will be invoked to format plaintext blobs 234 Specifies a command which will be invoked to format plaintext blobs
226 in the tree view. The command will get the blob content on its STDIN 235 in the tree view. The command will get the blob content on its STDIN
227 and the name of the blob as its only command line argument. The STDOUT 236 and the name of the blob as its only command line argument. The STDOUT
228 from the command will be included verbatim as the blob contents, i.e. 237 from the command will be included verbatim as the blob contents, i.e.
229 this can be used to implement e.g. syntax highlighting. Default value: 238 this can be used to implement e.g. syntax highlighting. Default value:
230 none. 239 none.
231 240
232summary-branches:: 241summary-branches::
233 Specifies the number of branches to display in the repository "summary" 242 Specifies the number of branches to display in the repository "summary"
234 view. Default value: "10". 243 view. Default value: "10".
235 244
236summary-log:: 245summary-log::
237 Specifies the number of log entries to display in the repository 246 Specifies the number of log entries to display in the repository
238 "summary" view. Default value: "10". 247 "summary" view. Default value: "10".
239 248
240summary-tags:: 249summary-tags::
241 Specifies the number of tags to display in the repository "summary" 250 Specifies the number of tags to display in the repository "summary"
242 view. Default value: "10". 251 view. Default value: "10".
243 252
244virtual-root:: 253virtual-root::
245 Url which, if specified, will be used as root for all cgit links. It 254 Url which, if specified, will be used as root for all cgit links. It
246 will also cause cgit to generate 'virtual urls', i.e. urls like 255 will also cause cgit to generate 'virtual urls', i.e. urls like
247 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 256 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
248 value: none. 257 value: none.
249 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 258 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
250 same kind of virtual urls, so this option will probably be deprecated. 259 same kind of virtual urls, so this option will probably be deprecated.
251 260
252REPOSITORY SETTINGS 261REPOSITORY SETTINGS
253------------------- 262-------------------
254repo.about-filter:: 263repo.about-filter::
255 Override the default about-filter. Default value: <about-filter>. 264 Override the default about-filter. Default value: <about-filter>.
256 265
257repo.clone-url:: 266repo.clone-url::
258 A list of space-separated urls which can be used to clone this repo. 267 A list of space-separated urls which can be used to clone this repo.
259 Default value: none. 268 Default value: none.
260 269
261repo.commit-filter:: 270repo.commit-filter::
262 Override the default commit-filter. Default value: <commit-filter>. 271 Override the default commit-filter. Default value: <commit-filter>.
263 272
264repo.defbranch:: 273repo.defbranch::
265 The name of the default branch for this repository. If no such branch 274 The name of the default branch for this repository. If no such branch