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