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