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