summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 4dc383d..252d546 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -49,384 +49,388 @@ cache-dynamic-ttl::
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:: 57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result 58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15". 59 of scanning a path for git repositories. Default value: "15".
60 60
61cache-size:: 61cache-size::
62 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"
63 (i.e. caching is disabled). 63 (i.e. caching is disabled).
64 64
65cache-static-ttl:: 65cache-static-ttl::
66 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
67 version of repository pages accessed with a fixed SHA1. Default value: 67 version of repository pages accessed with a fixed SHA1. Default value:
68 "5". 68 "5".
69 69
70clone-prefix:: 70clone-prefix::
71 Space-separated list of common prefixes which, when combined with a 71 Space-separated list of common prefixes which, when combined with a
72 repository url, generates valid clone urls for the repository. This 72 repository url, generates valid clone urls for the repository. This
73 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:
74 none. 74 none.
75 75
76commit-filter:: 76commit-filter::
77 Specifies a command which will be invoked to format commit messages. 77 Specifies a command which will be invoked to format commit messages.
78 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
79 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
80 be used to implement bugtracker integration. Default value: none. 80 be used to implement bugtracker integration. Default value: none.
81 81
82css:: 82css::
83 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.
84 Default value: "/cgit.css". 84 Default value: "/cgit.css".
85 85
86embedded:: 86embedded::
87 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
88 suitable for embedding in other html pages. Default value: none. See 88 suitable for embedding in other html pages. Default value: none. See
89 also: "noheader". 89 also: "noheader".
90 90
91enable-filter-overrides:: 91enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be 92 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none. 93 overridden in repository-specific cgitrc files. Default value: none.
94 94
95enable-index-links:: 95enable-index-links::
96 Flag which, when set to "1", will make cgit generate extra links for 96 Flag which, when set to "1", will make cgit generate extra links for
97 each repo in the repository index (specifically, to the "summary", 97 each repo in the repository index (specifically, to the "summary",
98 "commit" and "tree" pages). Default value: "0". 98 "commit" and "tree" pages). Default value: "0".
99 99
100enable-log-filecount:: 100enable-log-filecount::
101 Flag which, when set to "1", will make cgit print the number of 101 Flag which, when set to "1", will make cgit print the number of
102 modified files for each commit on the repository log page. Default 102 modified files for each commit on the repository log page. Default
103 value: "0". 103 value: "0".
104 104
105enable-log-linecount:: 105enable-log-linecount::
106 Flag which, when set to "1", will make cgit print the number of added 106 Flag which, when set to "1", will make cgit print the number of added
107 and removed lines for each commit on the repository log page. Default 107 and removed lines for each commit on the repository log page. Default
108 value: "0". 108 value: "0".
109 109
110enable-tree-linenumbers:: 110enable-tree-linenumbers::
111 Flag which, when set to "1", will make cgit generate linenumber links 111 Flag which, when set to "1", will make cgit generate linenumber links
112 for plaintext blobs printed in the tree view. Default value: "1". 112 for plaintext blobs printed in the tree view. Default value: "1".
113 113
114favicon:: 114favicon::
115 Url used as link to a shortcut icon for cgit. If specified, it is 115 Url used as link to a shortcut icon for cgit. If specified, it is
116 suggested to use the value "/favicon.ico" since certain browsers will 116 suggested to use the value "/favicon.ico" since certain browsers will
117 ignore other values. Default value: none. 117 ignore other values. Default value: none.
118 118
119footer:: 119footer::
120 The content of the file specified with this option will be included 120 The content of the file specified with this option will be included
121 verbatim at the bottom of all pages (i.e. it replaces the standard 121 verbatim at the bottom of all pages (i.e. it replaces the standard
122 "generated by..." message. Default value: none. 122 "generated by..." message. Default value: none.
123 123
124head-include:: 124head-include::
125 The content of the file specified with this option will be included 125 The content of the file specified with this option will be included
126 verbatim in the html HEAD section on all pages. Default value: none. 126 verbatim in the html HEAD section on all pages. Default value: none.
127 127
128header:: 128header::
129 The content of the file specified with this option will be included 129 The content of the file specified with this option will be included
130 verbatim at the top of all pages. Default value: none. 130 verbatim at the top of all pages. Default value: none.
131 131
132include:: 132include::
133 Name of a configfile to include before the rest of the current config- 133 Name of a configfile to include before the rest of the current config-
134 file is parsed. Default value: none. 134 file is parsed. Default value: none.
135 135
136index-header:: 136index-header::
137 The content of the file specified with this option will be included 137 The content of the file specified with this option will be included
138 verbatim above the repository index. This setting is deprecated, and 138 verbatim above the repository index. This setting is deprecated, and
139 will not be supported by cgit-1.0 (use root-readme instead). Default 139 will not be supported by cgit-1.0 (use root-readme instead). Default
140 value: none. 140 value: none.
141 141
142index-info:: 142index-info::
143 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
144 verbatim below the heading on the repository index page. This setting 144 verbatim below the heading on the repository index page. This setting
145 is deprecated, and will not be supported by cgit-1.0 (use root-desc 145 is deprecated, and will not be supported by cgit-1.0 (use root-desc
146 instead). Default value: none. 146 instead). Default value: none.
147 147
148local-time:: 148local-time::
149 Flag which, if set to "1", makes cgit print commit and tag times in the 149 Flag which, if set to "1", makes cgit print commit and tag times in the
150 servers timezone. Default value: "0". 150 servers timezone. Default value: "0".
151 151
152logo:: 152logo::
153 Url which specifies the source of an image which will be used as a logo 153 Url which specifies the source of an image which will be used as a logo
154 on all cgit pages. Default value: "/cgit.png". 154 on all cgit pages. Default value: "/cgit.png".
155 155
156logo-link:: 156logo-link::
157 Url loaded when clicking on the cgit logo image. If unspecified the 157 Url loaded when clicking on the cgit logo image. If unspecified the
158 calculated url of the repository index page will be used. Default 158 calculated url of the repository index page will be used. Default
159 value: none. 159 value: none.
160 160
161max-commit-count:: 161max-commit-count::
162 Specifies the number of entries to list per page in "log" view. Default 162 Specifies the number of entries to list per page in "log" view. Default
163 value: "50". 163 value: "50".
164 164
165max-message-length:: 165max-message-length::
166 Specifies the maximum number of commit message characters to display in 166 Specifies the maximum number of commit message characters to display in
167 "log" view. Default value: "80". 167 "log" view. Default value: "80".
168 168
169max-repo-count:: 169max-repo-count::
170 Specifies the number of entries to list per page on therepository 170 Specifies the number of entries to list per page on therepository
171 index page. Default value: "50". 171 index page. Default value: "50".
172 172
173max-repodesc-length:: 173max-repodesc-length::
174 Specifies the maximum number of repo description characters to display 174 Specifies the maximum number of repo description characters to display
175 on the repository index page. Default value: "80". 175 on the repository index page. Default value: "80".
176 176
177max-stats:: 177max-stats::
178 Set the default maximum statistics period. Valid values are "week", 178 Set the default maximum statistics period. Valid values are "week",
179 "month", "quarter" and "year". If unspecified, statistics are 179 "month", "quarter" and "year". If unspecified, statistics are
180 disabled. Default value: none. See also: "repo.max-stats". 180 disabled. Default value: none. See also: "repo.max-stats".
181 181
182mimetype.<ext>:: 182mimetype.<ext>::
183 Set the mimetype for the specified filename extension. This is used 183 Set the mimetype for the specified filename extension. This is used
184 by the `plain` command when returning blob content. 184 by the `plain` command when returning blob content.
185 185
186module-link:: 186module-link::
187 Text which will be used as the formatstring for a hyperlink when a 187 Text which will be used as the formatstring for a hyperlink when a
188 submodule is printed in a directory listing. The arguments for the 188 submodule is printed in a directory listing. The arguments for the
189 formatstring are the path and SHA1 of the submodule commit. Default 189 formatstring are the path and SHA1 of the submodule commit. Default
190 value: "./?repo=%s&page=commit&id=%s" 190 value: "./?repo=%s&page=commit&id=%s"
191 191
192nocache:: 192nocache::
193 If set to the value "1" caching will be disabled. This settings is 193 If set to the value "1" caching will be disabled. This settings is
194 deprecated, and will not be honored starting with cgit-1.0. Default 194 deprecated, and will not be honored starting with cgit-1.0. Default
195 value: "0". 195 value: "0".
196 196
197noplainemail:: 197noplainemail::
198 If set to "1" showing full author email adresses will be disabled. 198 If set to "1" showing full author email adresses will be disabled.
199 Default value: "0". 199 Default value: "0".
200 200
201noheader:: 201noheader::
202 Flag which, when set to "1", will make cgit omit the standard header 202 Flag which, when set to "1", will make cgit omit the standard header
203 on all pages. Default value: none. See also: "embedded". 203 on all pages. Default value: none. See also: "embedded".
204 204
205renamelimit:: 205renamelimit::
206 Maximum number of files to consider when detecting renames. The value 206 Maximum number of files to consider when detecting renames. The value
207 "-1" uses the compiletime value in git (for further info, look at 207 "-1" uses the compiletime value in git (for further info, look at
208 `man git-diff`). Default value: "-1". 208 `man git-diff`). Default value: "-1".
209 209
210repo.group:: 210repo.group::
211 Legacy alias for "section". This option is deprecated and will not be 211 Legacy alias for "section". This option is deprecated and will not be
212 supported in cgit-1.0. 212 supported in cgit-1.0.
213 213
214robots:: 214robots::
215 Text used as content for the "robots" meta-tag. Default value: 215 Text used as content for the "robots" meta-tag. Default value:
216 "index, nofollow". 216 "index, nofollow".
217 217
218root-desc:: 218root-desc::
219 Text printed below the heading on the repository index page. Default 219 Text printed below the heading on the repository index page. Default
220 value: "a fast webinterface for the git dscm". 220 value: "a fast webinterface for the git dscm".
221 221
222root-readme:: 222root-readme::
223 The content of the file specified with this option will be included 223 The content of the file specified with this option will be included
224 verbatim below the "about" link on the repository index page. Default 224 verbatim below the "about" link on the repository index page. Default
225 value: none. 225 value: none.
226 226
227root-title:: 227root-title::
228 Text printed as heading on the repository index page. Default value: 228 Text printed as heading on the repository index page. Default value:
229 "Git Repository Browser". 229 "Git Repository Browser".
230 230
231scan-path:: 231scan-path::
232 A path which will be scanned for repositories. If caching is enabled, 232 A path which will be scanned for repositories. If caching is enabled,
233 the result will be cached as a cgitrc include-file in the cache 233 the result will be cached as a cgitrc include-file in the cache
234 directory. Default value: none. See also: cache-scanrc-ttl. 234 directory. Default value: none. See also: cache-scanrc-ttl.
235 235
236section:: 236section::
237 The name of the current repository section - all repositories defined 237 The name of the current repository section - all repositories defined
238 after this option will inherit the current section name. Default value: 238 after this option will inherit the current section name. Default value:
239 none. 239 none.
240 240
241side-by-side-diffs::
242 If set to "1" shows side-by-side diffs instead of unidiffs per
243 default. Default value: "0".
244
241snapshots:: 245snapshots::
242 Text which specifies the default set of snapshot formats generated by 246 Text which specifies the default set of snapshot formats generated by
243 cgit. The value is a space-separated list of zero or more of the 247 cgit. The value is a space-separated list of zero or more of the
244 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 248 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
245 249
246source-filter:: 250source-filter::
247 Specifies a command which will be invoked to format plaintext blobs 251 Specifies a command which will be invoked to format plaintext blobs
248 in the tree view. The command will get the blob content on its STDIN 252 in the tree view. The command will get the blob content on its STDIN
249 and the name of the blob as its only command line argument. The STDOUT 253 and the name of the blob as its only command line argument. The STDOUT
250 from the command will be included verbatim as the blob contents, i.e. 254 from the command will be included verbatim as the blob contents, i.e.
251 this can be used to implement e.g. syntax highlighting. Default value: 255 this can be used to implement e.g. syntax highlighting. Default value:
252 none. 256 none.
253 257
254summary-branches:: 258summary-branches::
255 Specifies the number of branches to display in the repository "summary" 259 Specifies the number of branches to display in the repository "summary"
256 view. Default value: "10". 260 view. Default value: "10".
257 261
258summary-log:: 262summary-log::
259 Specifies the number of log entries to display in the repository 263 Specifies the number of log entries to display in the repository
260 "summary" view. Default value: "10". 264 "summary" view. Default value: "10".
261 265
262summary-tags:: 266summary-tags::
263 Specifies the number of tags to display in the repository "summary" 267 Specifies the number of tags to display in the repository "summary"
264 view. Default value: "10". 268 view. Default value: "10".
265 269
266virtual-root:: 270virtual-root::
267 Url which, if specified, will be used as root for all cgit links. It 271 Url which, if specified, will be used as root for all cgit links. It
268 will also cause cgit to generate 'virtual urls', i.e. urls like 272 will also cause cgit to generate 'virtual urls', i.e. urls like
269 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 273 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
270 value: none. 274 value: none.
271 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 275 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
272 same kind of virtual urls, so this option will probably be deprecated. 276 same kind of virtual urls, so this option will probably be deprecated.
273 277
274REPOSITORY SETTINGS 278REPOSITORY SETTINGS
275------------------- 279-------------------
276repo.about-filter:: 280repo.about-filter::
277 Override the default about-filter. Default value: none. See also: 281 Override the default about-filter. Default value: none. See also:
278 "enable-filter-overrides". 282 "enable-filter-overrides".
279 283
280repo.clone-url:: 284repo.clone-url::
281 A list of space-separated urls which can be used to clone this repo. 285 A list of space-separated urls which can be used to clone this repo.
282 Default value: none. 286 Default value: none.
283 287
284repo.commit-filter:: 288repo.commit-filter::
285 Override the default commit-filter. Default value: none. See also: 289 Override the default commit-filter. Default value: none. See also:
286 "enable-filter-overrides". 290 "enable-filter-overrides".
287 291
288repo.defbranch:: 292repo.defbranch::
289 The name of the default branch for this repository. If no such branch 293 The name of the default branch for this repository. If no such branch
290 exists in the repository, the first branch name (when sorted) is used 294 exists in the repository, the first branch name (when sorted) is used
291 as default instead. Default value: "master". 295 as default instead. Default value: "master".
292 296
293repo.desc:: 297repo.desc::
294 The value to show as repository description. Default value: none. 298 The value to show as repository description. Default value: none.
295 299
296repo.enable-log-filecount:: 300repo.enable-log-filecount::
297 A flag which can be used to disable the global setting 301 A flag which can be used to disable the global setting
298 `enable-log-filecount'. Default value: none. 302 `enable-log-filecount'. Default value: none.
299 303
300repo.enable-log-linecount:: 304repo.enable-log-linecount::
301 A flag which can be used to disable the global setting 305 A flag which can be used to disable the global setting
302 `enable-log-linecount'. Default value: none. 306 `enable-log-linecount'. Default value: none.
303 307
304repo.max-stats:: 308repo.max-stats::
305 Override the default maximum statistics period. Valid values are equal 309 Override the default maximum statistics period. Valid values are equal
306 to the values specified for the global "max-stats" setting. Default 310 to the values specified for the global "max-stats" setting. Default
307 value: none. 311 value: none.
308 312
309repo.name:: 313repo.name::
310 The value to show as repository name. Default value: <repo.url>. 314 The value to show as repository name. Default value: <repo.url>.
311 315
312repo.owner:: 316repo.owner::
313 A value used to identify the owner of the repository. Default value: 317 A value used to identify the owner of the repository. Default value:
314 none. 318 none.
315 319
316repo.path:: 320repo.path::
317 An absolute path to the repository directory. For non-bare repositories 321 An absolute path to the repository directory. For non-bare repositories
318 this is the .git-directory. Default value: none. 322 this is the .git-directory. Default value: none.
319 323
320repo.readme:: 324repo.readme::
321 A path (relative to <repo.path>) which specifies a file to include 325 A path (relative to <repo.path>) which specifies a file to include
322 verbatim as the "About" page for this repo. Default value: none. 326 verbatim as the "About" page for this repo. Default value: none.
323 327
324repo.snapshots:: 328repo.snapshots::
325 A mask of allowed snapshot-formats for this repo, restricted by the 329 A mask of allowed snapshot-formats for this repo, restricted by the
326 "snapshots" global setting. Default value: <snapshots>. 330 "snapshots" global setting. Default value: <snapshots>.
327 331
328repo.section:: 332repo.section::
329 Override the current section name for this repository. Default value: 333 Override the current section name for this repository. Default value:
330 none. 334 none.
331 335
332repo.source-filter:: 336repo.source-filter::
333 Override the default source-filter. Default value: none. See also: 337 Override the default source-filter. Default value: none. See also:
334 "enable-filter-overrides". 338 "enable-filter-overrides".
335 339
336repo.url:: 340repo.url::
337 The relative url used to access the repository. This must be the first 341 The relative url used to access the repository. This must be the first
338 setting specified for each repo. Default value: none. 342 setting specified for each repo. Default value: none.
339 343
340 344
341REPOSITORY-SPECIFIC CGITRC FILE 345REPOSITORY-SPECIFIC CGITRC FILE
342------------------------------- 346-------------------------------
343When the option "scan-path" is used to auto-discover git repositories, cgit 347When the option "scan-path" is used to auto-discover git repositories, cgit
344will try to parse the file "cgitrc" within any found repository. Such a 348will try to parse the file "cgitrc" within any found repository. Such a
345repo-specific config file may contain any of the repo-specific options 349repo-specific config file may contain any of the repo-specific options
346described above, except "repo.url" and "repo.path". Additionally, the "filter" 350described above, except "repo.url" and "repo.path". Additionally, the "filter"
347options are only acknowledged in repo-specific config files when 351options are only acknowledged in repo-specific config files when
348"enable-filter-overrides" is set to "1". 352"enable-filter-overrides" is set to "1".
349 353
350Note: the "repo." prefix is dropped from the option names in repo-specific 354Note: the "repo." prefix is dropped from the option names in repo-specific
351config files, e.g. "repo.desc" becomes "desc". 355config files, e.g. "repo.desc" becomes "desc".
352 356
353 357
354EXAMPLE CGITRC FILE 358EXAMPLE CGITRC FILE
355------------------- 359-------------------
356 360
357.... 361....
358# Enable caching of up to 1000 output entriess 362# Enable caching of up to 1000 output entriess
359cache-size=1000 363cache-size=1000
360 364
361 365
362# Specify some default clone prefixes 366# Specify some default clone prefixes
363clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 367clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
364 368
365# Specify the css url 369# Specify the css url
366css=/css/cgit.css 370css=/css/cgit.css
367 371
368 372
369# Show extra links for each repository on the index page 373# Show extra links for each repository on the index page
370enable-index-links=1 374enable-index-links=1
371 375
372 376
373# Show number of affected files per commit on the log pages 377# Show number of affected files per commit on the log pages
374enable-log-filecount=1 378enable-log-filecount=1
375 379
376 380
377# Show number of added/removed lines per commit on the log pages 381# Show number of added/removed lines per commit on the log pages
378enable-log-linecount=1 382enable-log-linecount=1
379 383
380 384
381# Add a cgit favicon 385# Add a cgit favicon
382favicon=/favicon.ico 386favicon=/favicon.ico
383 387
384 388
385# Use a custom logo 389# Use a custom logo
386logo=/img/mylogo.png 390logo=/img/mylogo.png
387 391
388 392
389# Enable statistics per week, month and quarter 393# Enable statistics per week, month and quarter
390max-stats=quarter 394max-stats=quarter
391 395
392 396
393# Set the title and heading of the repository index page 397# Set the title and heading of the repository index page
394root-title=foobar.com git repositories 398root-title=foobar.com git repositories
395 399
396 400
397# Set a subheading for the repository index page 401# Set a subheading for the repository index page
398root-desc=tracking the foobar development 402root-desc=tracking the foobar development
399 403
400 404
401# Include some more info about foobar.com on the index page 405# Include some more info about foobar.com on the index page
402root-readme=/var/www/htdocs/about.html 406root-readme=/var/www/htdocs/about.html
403 407
404 408
405# Allow download of tar.gz, tar.bz2 and zip-files 409# Allow download of tar.gz, tar.bz2 and zip-files
406snapshots=tar.gz tar.bz2 zip 410snapshots=tar.gz tar.bz2 zip
407 411
408 412
409## 413##
410## List of common mimetypes 414## List of common mimetypes
411## 415##
412 416
413mimetype.git=image/git 417mimetype.git=image/git
414mimetype.html=text/html 418mimetype.html=text/html
415mimetype.jpg=image/jpeg 419mimetype.jpg=image/jpeg
416mimetype.jpeg=image/jpeg 420mimetype.jpeg=image/jpeg
417mimetype.pdf=application/pdf 421mimetype.pdf=application/pdf
418mimetype.png=image/png 422mimetype.png=image/png
419mimetype.svg=image/svg+xml 423mimetype.svg=image/svg+xml
420 424
421 425
422## 426##
423## List of repositories. 427## List of repositories.
424## PS: Any repositories listed when repo.group is unset will not be 428## PS: Any repositories listed when repo.group is unset will not be
425## displayed under a group heading 429## displayed under a group heading
426## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 430## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
427## and included like this: 431## and included like this:
428## include=/etc/cgitrepos 432## include=/etc/cgitrepos
429## 433##
430 434
431 435
432repo.url=foo 436repo.url=foo