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