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