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