summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d74d9e7..fcd4308 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,515 +1,525 @@
1:man source: cgit 1:man source: cgit
2:man manual: cgit 2:man manual: cgit
3 3
4CGITRC(5) 4CGITRC(5)
5======== 5========
6 6
7 7
8NAME 8NAME
9---- 9----
10cgitrc - runtime configuration for cgit 10cgitrc - runtime configuration for cgit
11 11
12 12
13SYNOPSIS 13SYNOPSIS
14-------- 14--------
15Cgitrc contains all runtime settings for cgit, including the list of git 15Cgitrc contains all runtime settings for cgit, including the list of git
16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
17lines, and lines starting with '#', are ignored. 17lines, and lines starting with '#', are ignored.
18 18
19 19
20LOCATION 20LOCATION
21-------- 21--------
22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At 22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
23runtime, cgit will consult the environment variable CGIT_CONFIG and, if 23runtime, cgit will consult the environment variable CGIT_CONFIG and, if
24defined, use its value instead. 24defined, use its value instead.
25 25
26 26
27GLOBAL SETTINGS 27GLOBAL SETTINGS
28--------------- 28---------------
29about-filter:: 29about-filter::
30 Specifies a command which will be invoked to format the content of 30 Specifies a command which will be invoked to format the content of
31 about pages (both top-level and for each repository). The command will 31 about pages (both top-level and for each repository). The command will
32 get the content of the about-file on its STDIN, and the STDOUT from the 32 get the content of the about-file on its STDIN, and the STDOUT from the
33 command will be included verbatim on the about page. Default value: 33 command will be included verbatim on the about page. Default value:
34 none. 34 none.
35 35
36agefile:: 36agefile::
37 Specifies a path, relative to each repository path, which can be used 37 Specifies a path, relative to each repository path, which can be used
38 to specify the date and time of the youngest commit in the repository. 38 to specify the date and time of the youngest commit in the repository.
39 The first line in the file is used as input to the "parse_date" 39 The first line in the file is used as input to the "parse_date"
40 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 40 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
41 hh:mm:ss". Default value: "info/web/last-modified". 41 hh:mm:ss". Default value: "info/web/last-modified".
42 42
43cache-root:: 43cache-root::
44 Path used to store the cgit cache entries. Default value: 44 Path used to store the cgit cache entries. Default value:
45 "/var/cache/cgit". 45 "/var/cache/cgit".
46 46
47cache-dynamic-ttl:: 47cache-dynamic-ttl::
48 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed without a fixed SHA1. Default 49 version of repository pages accessed without a fixed SHA1. Default
50 value: "5". 50 value: "5".
51 51
52cache-repo-ttl:: 52cache-repo-ttl::
53 Number which specifies the time-to-live, in minutes, for the cached 53 Number which specifies the time-to-live, in minutes, for the cached
54 version of the repository summary page. Default value: "5". 54 version of the repository summary page. Default value: "5".
55 55
56cache-root-ttl:: 56cache-root-ttl::
57 Number which specifies the time-to-live, in minutes, for the cached 57 Number which specifies the time-to-live, in minutes, for the cached
58 version of the repository index page. Default value: "5". 58 version of the repository index page. Default value: "5".
59 59
60cache-scanrc-ttl:: 60cache-scanrc-ttl::
61 Number which specifies the time-to-live, in minutes, for the result 61 Number which specifies the time-to-live, in minutes, for the result
62 of scanning a path for git repositories. Default value: "15". 62 of scanning a path for git repositories. Default value: "15".
63 63
64cache-size:: 64cache-size::
65 The maximum number of entries in the cgit cache. Default value: "0" 65 The maximum number of entries in the cgit cache. Default value: "0"
66 (i.e. caching is disabled). 66 (i.e. caching is disabled).
67 67
68cache-static-ttl:: 68cache-static-ttl::
69 Number which specifies the time-to-live, in minutes, for the cached 69 Number which specifies the time-to-live, in minutes, for the cached
70 version of repository pages accessed with a fixed SHA1. Default value: 70 version of repository pages accessed with a fixed SHA1. Default value:
71 "5". 71 "5".
72 72
73clone-prefix:: 73clone-prefix::
74 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
76 setting is only used if `repo.clone-url` is unspecified. Default value: 76 setting is only used if `repo.clone-url` is unspecified. Default value:
77 none. 77 none.
78 78
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
82 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-filter-overrides:: 94enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-index-links:: 98enable-index-links::
99 Flag which, when set to "1", will make cgit generate extra links for 99 Flag which, when set to "1", will make cgit generate extra links for
100 each repo in the repository index (specifically, to the "summary", 100 each repo in the repository index (specifically, to the "summary",
101 "commit" and "tree" pages). Default value: "0". 101 "commit" and "tree" pages). Default value: "0".
102 102
103enable-log-filecount:: 103enable-log-filecount::
104 Flag which, when set to "1", will make cgit print the number of 104 Flag which, when set to "1", will make cgit print the number of
105 modified files for each commit on the repository log page. Default 105 modified files for each commit on the repository log page. Default
106 value: "0". 106 value: "0".
107 107
108enable-log-linecount:: 108enable-log-linecount::
109 Flag which, when set to "1", will make cgit print the number of added 109 Flag which, when set to "1", will make cgit print the number of added
110 and removed lines for each commit on the repository log page. Default 110 and removed lines for each commit on the repository log page. Default
111 value: "0". 111 value: "0".
112 112
113enable-remote-branches:: 113enable-remote-branches::
114 Flag which, when set to "1", will make cgit display remote branches 114 Flag which, when set to "1", will make cgit display remote branches
115 in the summary and refs views. Default value: "0". See also: 115 in the summary and refs views. Default value: "0". See also:
116 "repo.enable-remote-branches". 116 "repo.enable-remote-branches".
117 117
118enable-subject-links::
119 Flag which, when set to "1", will make cgit use the subject of the
120 parent commit as link text when generating links to parent commits
121 in commit view. Default value: "0". See also:
122 "repo.enable-subject-links".
123
118enable-tree-linenumbers:: 124enable-tree-linenumbers::
119 Flag which, when set to "1", will make cgit generate linenumber links 125 Flag which, when set to "1", will make cgit generate linenumber links
120 for plaintext blobs printed in the tree view. Default value: "1". 126 for plaintext blobs printed in the tree view. Default value: "1".
121 127
122favicon:: 128favicon::
123 Url used as link to a shortcut icon for cgit. If specified, it is 129 Url used as link to a shortcut icon for cgit. If specified, it is
124 suggested to use the value "/favicon.ico" since certain browsers will 130 suggested to use the value "/favicon.ico" since certain browsers will
125 ignore other values. Default value: none. 131 ignore other values. Default value: none.
126 132
127footer:: 133footer::
128 The content of the file specified with this option will be included 134 The content of the file specified with this option will be included
129 verbatim at the bottom of all pages (i.e. it replaces the standard 135 verbatim at the bottom of all pages (i.e. it replaces the standard
130 "generated by..." message. Default value: none. 136 "generated by..." message. Default value: none.
131 137
132head-include:: 138head-include::
133 The content of the file specified with this option will be included 139 The content of the file specified with this option will be included
134 verbatim in the html HEAD section on all pages. Default value: none. 140 verbatim in the html HEAD section on all pages. Default value: none.
135 141
136header:: 142header::
137 The content of the file specified with this option will be included 143 The content of the file specified with this option will be included
138 verbatim at the top of all pages. Default value: none. 144 verbatim at the top of all pages. Default value: none.
139 145
140include:: 146include::
141 Name of a configfile to include before the rest of the current config- 147 Name of a configfile to include before the rest of the current config-
142 file is parsed. Default value: none. 148 file is parsed. Default value: none.
143 149
144index-header:: 150index-header::
145 The content of the file specified with this option will be included 151 The content of the file specified with this option will be included
146 verbatim above the repository index. This setting is deprecated, and 152 verbatim above the repository index. This setting is deprecated, and
147 will not be supported by cgit-1.0 (use root-readme instead). Default 153 will not be supported by cgit-1.0 (use root-readme instead). Default
148 value: none. 154 value: none.
149 155
150index-info:: 156index-info::
151 The content of the file specified with this option will be included 157 The content of the file specified with this option will be included
152 verbatim below the heading on the repository index page. This setting 158 verbatim below the heading on the repository index page. This setting
153 is deprecated, and will not be supported by cgit-1.0 (use root-desc 159 is deprecated, and will not be supported by cgit-1.0 (use root-desc
154 instead). Default value: none. 160 instead). Default value: none.
155 161
156local-time:: 162local-time::
157 Flag which, if set to "1", makes cgit print commit and tag times in the 163 Flag which, if set to "1", makes cgit print commit and tag times in the
158 servers timezone. Default value: "0". 164 servers timezone. Default value: "0".
159 165
160logo:: 166logo::
161 Url which specifies the source of an image which will be used as a logo 167 Url which specifies the source of an image which will be used as a logo
162 on all cgit pages. Default value: "/cgit.png". 168 on all cgit pages. Default value: "/cgit.png".
163 169
164logo-link:: 170logo-link::
165 Url loaded when clicking on the cgit logo image. If unspecified the 171 Url loaded when clicking on the cgit logo image. If unspecified the
166 calculated url of the repository index page will be used. Default 172 calculated url of the repository index page will be used. Default
167 value: none. 173 value: none.
168 174
169max-commit-count:: 175max-commit-count::
170 Specifies the number of entries to list per page in "log" view. Default 176 Specifies the number of entries to list per page in "log" view. Default
171 value: "50". 177 value: "50".
172 178
173max-message-length:: 179max-message-length::
174 Specifies the maximum number of commit message characters to display in 180 Specifies the maximum number of commit message characters to display in
175 "log" view. Default value: "80". 181 "log" view. Default value: "80".
176 182
177max-repo-count:: 183max-repo-count::
178 Specifies the number of entries to list per page on therepository 184 Specifies the number of entries to list per page on therepository
179 index page. Default value: "50". 185 index page. Default value: "50".
180 186
181max-repodesc-length:: 187max-repodesc-length::
182 Specifies the maximum number of repo description characters to display 188 Specifies the maximum number of repo description characters to display
183 on the repository index page. Default value: "80". 189 on the repository index page. Default value: "80".
184 190
185max-blob-size:: 191max-blob-size::
186 Specifies the maximum size of a blob to display HTML for in KBytes. 192 Specifies the maximum size of a blob to display HTML for in KBytes.
187 Default value: "0" (limit disabled). 193 Default value: "0" (limit disabled).
188 194
189max-stats:: 195max-stats::
190 Set the default maximum statistics period. Valid values are "week", 196 Set the default maximum statistics period. Valid values are "week",
191 "month", "quarter" and "year". If unspecified, statistics are 197 "month", "quarter" and "year". If unspecified, statistics are
192 disabled. Default value: none. See also: "repo.max-stats". 198 disabled. Default value: none. See also: "repo.max-stats".
193 199
194mimetype.<ext>:: 200mimetype.<ext>::
195 Set the mimetype for the specified filename extension. This is used 201 Set the mimetype for the specified filename extension. This is used
196 by the `plain` command when returning blob content. 202 by the `plain` command when returning blob content.
197 203
198module-link:: 204module-link::
199 Text which will be used as the formatstring for a hyperlink when a 205 Text which will be used as the formatstring for a hyperlink when a
200 submodule is printed in a directory listing. The arguments for the 206 submodule is printed in a directory listing. The arguments for the
201 formatstring are the path and SHA1 of the submodule commit. Default 207 formatstring are the path and SHA1 of the submodule commit. Default
202 value: "./?repo=%s&page=commit&id=%s" 208 value: "./?repo=%s&page=commit&id=%s"
203 209
204nocache:: 210nocache::
205 If set to the value "1" caching will be disabled. This settings is 211 If set to the value "1" caching will be disabled. This settings is
206 deprecated, and will not be honored starting with cgit-1.0. Default 212 deprecated, and will not be honored starting with cgit-1.0. Default
207 value: "0". 213 value: "0".
208 214
209noplainemail:: 215noplainemail::
210 If set to "1" showing full author email adresses will be disabled. 216 If set to "1" showing full author email adresses will be disabled.
211 Default value: "0". 217 Default value: "0".
212 218
213noheader:: 219noheader::
214 Flag which, when set to "1", will make cgit omit the standard header 220 Flag which, when set to "1", will make cgit omit the standard header
215 on all pages. Default value: none. See also: "embedded". 221 on all pages. Default value: none. See also: "embedded".
216 222
217renamelimit:: 223renamelimit::
218 Maximum number of files to consider when detecting renames. The value 224 Maximum number of files to consider when detecting renames. The value
219 "-1" uses the compiletime value in git (for further info, look at 225 "-1" uses the compiletime value in git (for further info, look at
220 `man git-diff`). Default value: "-1". 226 `man git-diff`). Default value: "-1".
221 227
222repo.group:: 228repo.group::
223 Legacy alias for "section". This option is deprecated and will not be 229 Legacy alias for "section". This option is deprecated and will not be
224 supported in cgit-1.0. 230 supported in cgit-1.0.
225 231
226robots:: 232robots::
227 Text used as content for the "robots" meta-tag. Default value: 233 Text used as content for the "robots" meta-tag. Default value:
228 "index, nofollow". 234 "index, nofollow".
229 235
230root-desc:: 236root-desc::
231 Text printed below the heading on the repository index page. Default 237 Text printed below the heading on the repository index page. Default
232 value: "a fast webinterface for the git dscm". 238 value: "a fast webinterface for the git dscm".
233 239
234root-readme:: 240root-readme::
235 The content of the file specified with this option will be included 241 The content of the file specified with this option will be included
236 verbatim below the "about" link on the repository index page. Default 242 verbatim below the "about" link on the repository index page. Default
237 value: none. 243 value: none.
238 244
239root-title:: 245root-title::
240 Text printed as heading on the repository index page. Default value: 246 Text printed as heading on the repository index page. Default value:
241 "Git Repository Browser". 247 "Git Repository Browser".
242 248
243scan-path:: 249scan-path::
244 A path which will be scanned for repositories. If caching is enabled, 250 A path which will be scanned for repositories. If caching is enabled,
245 the result will be cached as a cgitrc include-file in the cache 251 the result will be cached as a cgitrc include-file in the cache
246 directory. Default value: none. See also: cache-scanrc-ttl. 252 directory. Default value: none. See also: cache-scanrc-ttl.
247 253
248section:: 254section::
249 The name of the current repository section - all repositories defined 255 The name of the current repository section - all repositories defined
250 after this option will inherit the current section name. Default value: 256 after this option will inherit the current section name. Default value:
251 none. 257 none.
252 258
253side-by-side-diffs:: 259side-by-side-diffs::
254 If set to "1" shows side-by-side diffs instead of unidiffs per 260 If set to "1" shows side-by-side diffs instead of unidiffs per
255 default. Default value: "0". 261 default. Default value: "0".
256 262
257snapshots:: 263snapshots::
258 Text which specifies the default set of snapshot formats generated by 264 Text which specifies the default set of snapshot formats generated by
259 cgit. The value is a space-separated list of zero or more of the 265 cgit. The value is a space-separated list of zero or more of the
260 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 266 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
261 267
262source-filter:: 268source-filter::
263 Specifies a command which will be invoked to format plaintext blobs 269 Specifies a command which will be invoked to format plaintext blobs
264 in the tree view. The command will get the blob content on its STDIN 270 in the tree view. The command will get the blob content on its STDIN
265 and the name of the blob as its only command line argument. The STDOUT 271 and the name of the blob as its only command line argument. The STDOUT
266 from the command will be included verbatim as the blob contents, i.e. 272 from the command will be included verbatim as the blob contents, i.e.
267 this can be used to implement e.g. syntax highlighting. Default value: 273 this can be used to implement e.g. syntax highlighting. Default value:
268 none. 274 none.
269 275
270summary-branches:: 276summary-branches::
271 Specifies the number of branches to display in the repository "summary" 277 Specifies the number of branches to display in the repository "summary"
272 view. Default value: "10". 278 view. Default value: "10".
273 279
274summary-log:: 280summary-log::
275 Specifies the number of log entries to display in the repository 281 Specifies the number of log entries to display in the repository
276 "summary" view. Default value: "10". 282 "summary" view. Default value: "10".
277 283
278summary-tags:: 284summary-tags::
279 Specifies the number of tags to display in the repository "summary" 285 Specifies the number of tags to display in the repository "summary"
280 view. Default value: "10". 286 view. Default value: "10".
281 287
282virtual-root:: 288virtual-root::
283 Url which, if specified, will be used as root for all cgit links. It 289 Url which, if specified, will be used as root for all cgit links. It
284 will also cause cgit to generate 'virtual urls', i.e. urls like 290 will also cause cgit to generate 'virtual urls', i.e. urls like
285 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 291 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
286 value: none. 292 value: none.
287 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 293 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
288 same kind of virtual urls, so this option will probably be deprecated. 294 same kind of virtual urls, so this option will probably be deprecated.
289 295
290REPOSITORY SETTINGS 296REPOSITORY SETTINGS
291------------------- 297-------------------
292repo.about-filter:: 298repo.about-filter::
293 Override the default about-filter. Default value: none. See also: 299 Override the default about-filter. Default value: none. See also:
294 "enable-filter-overrides". 300 "enable-filter-overrides".
295 301
296repo.clone-url:: 302repo.clone-url::
297 A list of space-separated urls which can be used to clone this repo. 303 A list of space-separated urls which can be used to clone this repo.
298 Default value: none. 304 Default value: none.
299 305
300repo.commit-filter:: 306repo.commit-filter::
301 Override the default commit-filter. Default value: none. See also: 307 Override the default commit-filter. Default value: none. See also:
302 "enable-filter-overrides". 308 "enable-filter-overrides".
303 309
304repo.defbranch:: 310repo.defbranch::
305 The name of the default branch for this repository. If no such branch 311 The name of the default branch for this repository. If no such branch
306 exists in the repository, the first branch name (when sorted) is used 312 exists in the repository, the first branch name (when sorted) is used
307 as default instead. Default value: "master". 313 as default instead. Default value: "master".
308 314
309repo.desc:: 315repo.desc::
310 The value to show as repository description. Default value: none. 316 The value to show as repository description. Default value: none.
311 317
312repo.enable-log-filecount:: 318repo.enable-log-filecount::
313 A flag which can be used to disable the global setting 319 A flag which can be used to disable the global setting
314 `enable-log-filecount'. Default value: none. 320 `enable-log-filecount'. Default value: none.
315 321
316repo.enable-log-linecount:: 322repo.enable-log-linecount::
317 A flag which can be used to disable the global setting 323 A flag which can be used to disable the global setting
318 `enable-log-linecount'. Default value: none. 324 `enable-log-linecount'. Default value: none.
319 325
320repo.enable-remote-branches:: 326repo.enable-remote-branches::
321 Flag which, when set to "1", will make cgit display remote branches 327 Flag which, when set to "1", will make cgit display remote branches
322 in the summary and refs views. Default value: <enable-remote-branches>. 328 in the summary and refs views. Default value: <enable-remote-branches>.
323 329
330repo.enable-subject-links::
331 A flag which can be used to override the global setting
332 `enable-subject-links'. Default value: none.
333
324repo.max-stats:: 334repo.max-stats::
325 Override the default maximum statistics period. Valid values are equal 335 Override the default maximum statistics period. Valid values are equal
326 to the values specified for the global "max-stats" setting. Default 336 to the values specified for the global "max-stats" setting. Default
327 value: none. 337 value: none.
328 338
329repo.name:: 339repo.name::
330 The value to show as repository name. Default value: <repo.url>. 340 The value to show as repository name. Default value: <repo.url>.
331 341
332repo.owner:: 342repo.owner::
333 A value used to identify the owner of the repository. Default value: 343 A value used to identify the owner of the repository. Default value:
334 none. 344 none.
335 345
336repo.path:: 346repo.path::
337 An absolute path to the repository directory. For non-bare repositories 347 An absolute path to the repository directory. For non-bare repositories
338 this is the .git-directory. Default value: none. 348 this is the .git-directory. Default value: none.
339 349
340repo.readme:: 350repo.readme::
341 A path (relative to <repo.path>) which specifies a file to include 351 A path (relative to <repo.path>) which specifies a file to include
342 verbatim as the "About" page for this repo. Default value: none. 352 verbatim as the "About" page for this repo. Default value: none.
343 353
344repo.snapshots:: 354repo.snapshots::
345 A mask of allowed snapshot-formats for this repo, restricted by the 355 A mask of allowed snapshot-formats for this repo, restricted by the
346 "snapshots" global setting. Default value: <snapshots>. 356 "snapshots" global setting. Default value: <snapshots>.
347 357
348repo.section:: 358repo.section::
349 Override the current section name for this repository. Default value: 359 Override the current section name for this repository. Default value:
350 none. 360 none.
351 361
352repo.source-filter:: 362repo.source-filter::
353 Override the default source-filter. Default value: none. See also: 363 Override the default source-filter. Default value: none. See also:
354 "enable-filter-overrides". 364 "enable-filter-overrides".
355 365
356repo.url:: 366repo.url::
357 The relative url used to access the repository. This must be the first 367 The relative url used to access the repository. This must be the first
358 setting specified for each repo. Default value: none. 368 setting specified for each repo. Default value: none.
359 369
360 370
361REPOSITORY-SPECIFIC CGITRC FILE 371REPOSITORY-SPECIFIC CGITRC FILE
362------------------------------- 372-------------------------------
363When the option "scan-path" is used to auto-discover git repositories, cgit 373When the option "scan-path" is used to auto-discover git repositories, cgit
364will try to parse the file "cgitrc" within any found repository. Such a 374will try to parse the file "cgitrc" within any found repository. Such a
365repo-specific config file may contain any of the repo-specific options 375repo-specific config file may contain any of the repo-specific options
366described above, except "repo.url" and "repo.path". Additionally, the "filter" 376described above, except "repo.url" and "repo.path". Additionally, the "filter"
367options are only acknowledged in repo-specific config files when 377options are only acknowledged in repo-specific config files when
368"enable-filter-overrides" is set to "1". 378"enable-filter-overrides" is set to "1".
369 379
370Note: the "repo." prefix is dropped from the option names in repo-specific 380Note: the "repo." prefix is dropped from the option names in repo-specific
371config files, e.g. "repo.desc" becomes "desc". 381config files, e.g. "repo.desc" becomes "desc".
372 382
373 383
374EXAMPLE CGITRC FILE 384EXAMPLE CGITRC FILE
375------------------- 385-------------------
376 386
377.... 387....
378# Enable caching of up to 1000 output entriess 388# Enable caching of up to 1000 output entriess
379cache-size=1000 389cache-size=1000
380 390
381 391
382# Specify some default clone prefixes 392# Specify some default clone prefixes
383clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 393clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
384 394
385# Specify the css url 395# Specify the css url
386css=/css/cgit.css 396css=/css/cgit.css
387 397
388 398
389# Show extra links for each repository on the index page 399# Show extra links for each repository on the index page
390enable-index-links=1 400enable-index-links=1
391 401
392 402
393# Show number of affected files per commit on the log pages 403# Show number of affected files per commit on the log pages
394enable-log-filecount=1 404enable-log-filecount=1
395 405
396 406
397# Show number of added/removed lines per commit on the log pages 407# Show number of added/removed lines per commit on the log pages
398enable-log-linecount=1 408enable-log-linecount=1
399 409
400 410
401# Add a cgit favicon 411# Add a cgit favicon
402favicon=/favicon.ico 412favicon=/favicon.ico
403 413
404 414
405# Use a custom logo 415# Use a custom logo
406logo=/img/mylogo.png 416logo=/img/mylogo.png
407 417
408 418
409# Enable statistics per week, month and quarter 419# Enable statistics per week, month and quarter
410max-stats=quarter 420max-stats=quarter
411 421
412 422
413# Set the title and heading of the repository index page 423# Set the title and heading of the repository index page
414root-title=foobar.com git repositories 424root-title=foobar.com git repositories
415 425
416 426
417# Set a subheading for the repository index page 427# Set a subheading for the repository index page
418root-desc=tracking the foobar development 428root-desc=tracking the foobar development
419 429
420 430
421# Include some more info about foobar.com on the index page 431# Include some more info about foobar.com on the index page
422root-readme=/var/www/htdocs/about.html 432root-readme=/var/www/htdocs/about.html
423 433
424 434
425# Allow download of tar.gz, tar.bz2 and zip-files 435# Allow download of tar.gz, tar.bz2 and zip-files
426snapshots=tar.gz tar.bz2 zip 436snapshots=tar.gz tar.bz2 zip
427 437
428 438
429## 439##
430## List of common mimetypes 440## List of common mimetypes
431## 441##
432 442
433mimetype.git=image/git 443mimetype.git=image/git
434mimetype.html=text/html 444mimetype.html=text/html
435mimetype.jpg=image/jpeg 445mimetype.jpg=image/jpeg
436mimetype.jpeg=image/jpeg 446mimetype.jpeg=image/jpeg
437mimetype.pdf=application/pdf 447mimetype.pdf=application/pdf
438mimetype.png=image/png 448mimetype.png=image/png
439mimetype.svg=image/svg+xml 449mimetype.svg=image/svg+xml
440 450
441 451
442## 452##
443## List of repositories. 453## List of repositories.
444## PS: Any repositories listed when section is unset will not be 454## PS: Any repositories listed when section is unset will not be
445## displayed under a section heading 455## displayed under a section heading
446## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 456## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
447## and included like this: 457## and included like this:
448## include=/etc/cgitrepos 458## include=/etc/cgitrepos
449## 459##
450 460
451 461
452repo.url=foo 462repo.url=foo
453repo.path=/pub/git/foo.git 463repo.path=/pub/git/foo.git
454repo.desc=the master foo repository 464repo.desc=the master foo repository
455repo.owner=fooman@foobar.com 465repo.owner=fooman@foobar.com
456repo.readme=info/web/about.html 466repo.readme=info/web/about.html
457 467
458 468
459repo.url=bar 469repo.url=bar
460repo.path=/pub/git/bar.git 470repo.path=/pub/git/bar.git
461repo.desc=the bars for your foo 471repo.desc=the bars for your foo
462repo.owner=barman@foobar.com 472repo.owner=barman@foobar.com
463repo.readme=info/web/about.html 473repo.readme=info/web/about.html
464 474
465 475
466# The next repositories will be displayed under the 'extras' heading 476# The next repositories will be displayed under the 'extras' heading
467section=extras 477section=extras
468 478
469 479
470repo.url=baz 480repo.url=baz
471repo.path=/pub/git/baz.git 481repo.path=/pub/git/baz.git
472repo.desc=a set of extensions for bar users 482repo.desc=a set of extensions for bar users
473 483
474repo.url=wiz 484repo.url=wiz
475repo.path=/pub/git/wiz.git 485repo.path=/pub/git/wiz.git
476repo.desc=the wizard of foo 486repo.desc=the wizard of foo
477 487
478 488
479# Add some mirrored repositories 489# Add some mirrored repositories
480section=mirrors 490section=mirrors
481 491
482 492
483repo.url=git 493repo.url=git
484repo.path=/pub/git/git.git 494repo.path=/pub/git/git.git
485repo.desc=the dscm 495repo.desc=the dscm
486 496
487 497
488repo.url=linux 498repo.url=linux
489repo.path=/pub/git/linux.git 499repo.path=/pub/git/linux.git
490repo.desc=the kernel 500repo.desc=the kernel
491 501
492# Disable adhoc downloads of this repo 502# Disable adhoc downloads of this repo
493repo.snapshots=0 503repo.snapshots=0
494 504
495# Disable line-counts for this repo 505# Disable line-counts for this repo
496repo.enable-log-linecount=0 506repo.enable-log-linecount=0
497 507
498# Restrict the max statistics period for this repo 508# Restrict the max statistics period for this repo
499repo.max-stats=month 509repo.max-stats=month
500.... 510....
501 511
502 512
503BUGS 513BUGS
504---- 514----
505Comments currently cannot appear on the same line as a setting; the comment 515Comments currently cannot appear on the same line as a setting; the comment
506will be included as part of the value. E.g. this line: 516will be included as part of the value. E.g. this line:
507 517
508 robots=index # allow indexing 518 robots=index # allow indexing
509 519
510will generate the following html element: 520will generate the following html element:
511 521
512 <meta name='robots' content='index # allow indexing'/> 522 <meta name='robots' content='index # allow indexing'/>
513 523
514 524
515 525