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. See also: "FILTER API".
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 See also: "FILTER API".
85
86css::
87 Url which specifies the css document to include in all cgit pages.
88 Default value: "/cgit.css".
89
90embedded::
91 Flag which, when set to "1", will make cgit generate a html fragment
92 suitable for embedding in other html pages. Default value: none. See
93 also: "noheader".
94
95enable-commit-graph::
96 Flag which, when set to "1", will make cgit print an ASCII-art commit
97 history graph to the left of the commit messages in the repository
98 log page. Default value: "0".
99
100enable-filter-overrides::
101 Flag which, when set to "1", allows all filter settings to be
102 overridden in repository-specific cgitrc files. Default value: none.
103
104enable-gitweb-owner::
105 If set to "1" and scan-path is enabled, we first check each repository
106 for the git config value "gitweb.owner" to determine the owner.
107 Default value: "1". See also: scan-path.
108
109enable-index-links::
110 Flag which, when set to "1", will make cgit generate extra links for
111 each repo in the repository index (specifically, to the "summary",
112 "commit" and "tree" pages). Default value: "0".
113
114enable-log-filecount::
115 Flag which, when set to "1", will make cgit print the number of
116 modified files for each commit on the repository log page. Default
117 value: "0".
118
119enable-log-linecount::
120 Flag which, when set to "1", will make cgit print the number of added
121 and removed lines for each commit on the repository log page. Default
122 value: "0".
123
124enable-remote-branches::
125 Flag which, when set to "1", will make cgit display remote branches
126 in the summary and refs views. Default value: "0". See also:
127 "repo.enable-remote-branches".
128
129enable-subject-links::
130 Flag which, when set to "1", will make cgit use the subject of the
131 parent commit as link text when generating links to parent commits
132 in commit view. Default value: "0". See also:
133 "repo.enable-subject-links".
134
135enable-tree-linenumbers::
136 Flag which, when set to "1", will make cgit generate linenumber links
137 for plaintext blobs printed in the tree view. Default value: "1".
138
139favicon::
140 Url used as link to a shortcut icon for cgit. If specified, it is
141 suggested to use the value "/favicon.ico" since certain browsers will
142 ignore other values. Default value: none.
143
144footer::
145 The content of the file specified with this option will be included
146 verbatim at the bottom of all pages (i.e. it replaces the standard
147 "generated by..." message. Default value: none.
148
149head-include::
150 The content of the file specified with this option will be included
151 verbatim in the html HEAD section on all pages. Default value: none.
152
153header::
154 The content of the file specified with this option will be included
155 verbatim at the top of all pages. Default value: none.
156
157include::
158 Name of a configfile to include before the rest of the current config-
159 file is parsed. Default value: none.
160
161index-header::
162 The content of the file specified with this option will be included
163 verbatim above the repository index. This setting is deprecated, and
164 will not be supported by cgit-1.0 (use root-readme instead). Default
165 value: none.
166
167index-info::
168 The content of the file specified with this option will be included
169 verbatim below the heading on the repository index page. This setting
170 is deprecated, and will not be supported by cgit-1.0 (use root-desc
171 instead). Default value: none.
172
173local-time::
174 Flag which, if set to "1", makes cgit print commit and tag times in the
175 servers timezone. Default value: "0".
176
177logo::
178 Url which specifies the source of an image which will be used as a logo
179 on all cgit pages. Default value: "/cgit.png".
180
181logo-link::
182 Url loaded when clicking on the cgit logo image. If unspecified the
183 calculated url of the repository index page will be used. Default
184 value: none.
185
186max-atom-items::
187 Specifies the number of items to display in atom feeds view. Default
188 value: "10".
189
190max-commit-count::
191 Specifies the number of entries to list per page in "log" view. Default
192 value: "50".
193
194max-message-length::
195 Specifies the maximum number of commit message characters to display in
196 "log" view. Default value: "80".
197
198max-repo-count::
199 Specifies the number of entries to list per page on the repository
200 index page. Default value: "50".
201
202max-repodesc-length::
203 Specifies the maximum number of repo description characters to display
204 on the repository index page. Default value: "80".
205
206max-blob-size::
207 Specifies the maximum size of a blob to display HTML for in KBytes.
208 Default value: "0" (limit disabled).
209
210max-stats::
211 Set the default maximum statistics period. Valid values are "week",
212 "month", "quarter" and "year". If unspecified, statistics are
213 disabled. Default value: none. See also: "repo.max-stats".
214
215mimetype.<ext>::
216 Set the mimetype for the specified filename extension. This is used
217 by the `plain` command when returning blob content.
218
219module-link::
220 Text which will be used as the formatstring for a hyperlink when a
221 submodule is printed in a directory listing. The arguments for the
222 formatstring are the path and SHA1 of the submodule commit. Default
223 value: "./?repo=%s&page=commit&id=%s"
224
225nocache::
226 If set to the value "1" caching will be disabled. This settings is
227 deprecated, and will not be honored starting with cgit-1.0. Default
228 value: "0".
229
230noplainemail::
231 If set to "1" showing full author email adresses will be disabled.
232 Default value: "0".
233
234noheader::
235 Flag which, when set to "1", will make cgit omit the standard header
236 on all pages. Default value: none. See also: "embedded".
237
238project-list::
239 A list of subdirectories inside of scan-path, relative to it, that
240 should loaded as git repositories. This must be defined prior to
241 scan-path. Default value: none. See also: scan-path.
242
243readme::
244 Text which will be used as default value for "repo.readme". Default
245 value: none.
246
247remove-suffix::
248 If set to "1" and scan-path is enabled, if any repositories are found
249 with a suffix of ".git", this suffix will be removed for the url and
250 name. Default value: "0". See also: scan-path.
251
252renamelimit::
253 Maximum number of files to consider when detecting renames. The value
254 "-1" uses the compiletime value in git (for further info, look at
255 `man git-diff`). Default value: "-1".
256
257repo.group::
258 Legacy alias for "section". This option is deprecated and will not be
259 supported in cgit-1.0.
260
261robots::
262 Text used as content for the "robots" meta-tag. Default value:
263 "index, nofollow".
264
265root-desc::
266 Text printed below the heading on the repository index page. Default
267 value: "a fast webinterface for the git dscm".
268
269root-readme::
270 The content of the file specified with this option will be included
271 verbatim below the "about" link on the repository index page. Default
272 value: none.
273
274root-title::
275 Text printed as heading on the repository index page. Default value:
276 "Git Repository Browser".
277
278scan-hidden-path::
279 If set to "1" and scan-path is enabled, scan-path will recurse into
280 directories whose name starts with a period ('.'). Otherwise,
281 scan-path will stay away from such directories (considered as
282 "hidden"). Note that this does not apply to the ".git" directory in
283 non-bare repos. This must be defined prior to scan-path.
284 Default value: 0. See also: scan-path.
285
286scan-path::
287 A path which will be scanned for repositories. If caching is enabled,
288 the result will be cached as a cgitrc include-file in the cache
289 directory. If project-list has been defined prior to scan-path,
290 scan-path loads only the directories listed in the file pointed to by
291 project-list. Default value: none. See also: cache-scanrc-ttl,
292 project-list.
293
294section::
295 The name of the current repository section - all repositories defined
296 after this option will inherit the current section name. Default value:
297 none.
298
299section-from-path::
300 A number which, if specified before scan-path, specifies how many
301 path elements from each repo path to use as a default section name.
302 If negative, cgit will discard the specified number of path elements
303 above the repo directory. Default value: 0.
304
305side-by-side-diffs::
306 If set to "1" shows side-by-side diffs instead of unidiffs per
307 default. Default value: "0".
308
309snapshots::
310 Text which specifies the default set of snapshot formats generated by
311 cgit. The value is a space-separated list of zero or more of the
312 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
313
314source-filter::
315 Specifies a command which will be invoked to format plaintext blobs
316 in the tree view. The command will get the blob content on its STDIN
317 and the name of the blob as its only command line argument. The STDOUT
318 from the command will be included verbatim as the blob contents, i.e.
319 this can be used to implement e.g. syntax highlighting. Default value:
320 none. See also: "FILTER API".
321
322summary-branches::
323 Specifies the number of branches to display in the repository "summary"
324 view. Default value: "10".
325
326summary-log::
327 Specifies the number of log entries to display in the repository
328 "summary" view. Default value: "10".
329
330summary-tags::
331 Specifies the number of tags to display in the repository "summary"
332 view. Default value: "10".
333
334strict-export::
335 Filename which, if specified, needs to be present within the repository
336 for cgit to allow access to that repository. This can be used to emulate
337 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
338 repositories to match those exported by git-daemon. This option MUST come
339 before 'scan-path'.
340
341virtual-root::
342 Url which, if specified, will be used as root for all cgit links. It
343 will also cause cgit to generate 'virtual urls', i.e. urls like
344 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
345 value: none.
346 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
347 same kind of virtual urls, so this option will probably be deprecated.
348
349REPOSITORY SETTINGS
350-------------------
351repo.about-filter::
352 Override the default about-filter. Default value: none. See also:
353 "enable-filter-overrides". See also: "FILTER API".
354
355repo.clone-url::
356 A list of space-separated urls which can be used to clone this repo.
357 Default value: none.
358
359repo.commit-filter::
360 Override the default commit-filter. Default value: none. See also:
361 "enable-filter-overrides". See also: "FILTER API".
362
363repo.defbranch::
364 The name of the default branch for this repository. If no such branch
365 exists in the repository, the first branch name (when sorted) is used
366 as default instead. Default value: "master".
367
368repo.desc::
369 The value to show as repository description. Default value: none.
370
371repo.enable-commit-graph::
372 A flag which can be used to disable the global setting
373 `enable-commit-graph'. Default value: none.
374
375repo.enable-log-filecount::
376 A flag which can be used to disable the global setting
377 `enable-log-filecount'. Default value: none.
378
379repo.enable-log-linecount::
380 A flag which can be used to disable the global setting
381 `enable-log-linecount'. Default value: none.
382
383repo.enable-remote-branches::
384 Flag which, when set to "1", will make cgit display remote branches
385 in the summary and refs views. Default value: <enable-remote-branches>.
386
387repo.enable-subject-links::
388 A flag which can be used to override the global setting
389 `enable-subject-links'. Default value: none.
390
391repo.logo::
392 Url which specifies the source of an image which will be used as a logo
393 on this repo's pages. Default value: global logo.
394
395repo.logo-link::
396 Url loaded when clicking on the cgit logo image. If unspecified the
397 calculated url of the repository index page will be used. Default
398 value: global logo-link.
399
400repo.max-stats::
401 Override the default maximum statistics period. Valid values are equal
402 to the values specified for the global "max-stats" setting. Default
403 value: none.
404
405repo.name::
406 The value to show as repository name. Default value: <repo.url>.
407
408repo.owner::
409 A value used to identify the owner of the repository. Default value:
410 none.
411
412repo.path::
413 An absolute path to the repository directory. For non-bare repositories
414 this is the .git-directory. Default value: none.
415
416repo.readme::
417 A path (relative to <repo.path>) which specifies a file to include
418 verbatim as the "About" page for this repo. You may also specify a
419 git refspec by head or by hash by prepending the refspec followed by
420 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
421
422repo.snapshots::
423 A mask of allowed snapshot-formats for this repo, restricted by the
424 "snapshots" global setting. Default value: <snapshots>.
425
426repo.section::
427 Override the current section name for this repository. Default value:
428 none.
429
430repo.source-filter::
431 Override the default source-filter. Default value: none. See also:
432 "enable-filter-overrides". See also: "FILTER API".
433
434repo.url::
435 The relative url used to access the repository. This must be the first
436 setting specified for each repo. Default value: none.
437
438
439REPOSITORY-SPECIFIC CGITRC FILE
440-------------------------------
441When the option "scan-path" is used to auto-discover git repositories, cgit
442will try to parse the file "cgitrc" within any found repository. Such a
443repo-specific config file may contain any of the repo-specific options
444described above, except "repo.url" and "repo.path". Additionally, the "filter"
445options are only acknowledged in repo-specific config files when
446"enable-filter-overrides" is set to "1".
447
448Note: the "repo." prefix is dropped from the option names in repo-specific
449config files, e.g. "repo.desc" becomes "desc".
450
451
452FILTER API
453----------
454- about filter::
455 This filter is given no arguments.
456 The about text that is to be filtered is available on standard input and the
457 filtered text is expected on standard output.
458- commit filter::
459 This filter is given no arguments.
460 The commit message text that is to be filtered is available on standard input
461 and the filtered text is expected on standard output.
462- source filter::
463 This filter is given a single parameter: the filename of the source file to
464 filter. The filter can use the filename to determine (for example) the syntax
465 highlighting mode.
466 The contents of the source file that is to be filtered is available on
467 standard input and the filtered contents is expected on standard output.
468
469Also, all filters are handed the following environment variables:
470- CGIT_REPO_URL ( = repo.url setting )
471- CGIT_REPO_NAME ( = repo.name setting )
472- CGIT_REPO_PATH ( = repo.path setting )
473- CGIT_REPO_OWNER ( = repo.owner setting )
474- CGIT_REPO_DEFBRANCH ( = repo.defbranch setting )
475- CGIT_REPO_SECTION ( = section setting )
476- CGIT_REPO_CLONE_URL ( = repo.clone-url setting )
477
478If a setting is not defined for a repository and the corresponding global
479setting is also not defined (if applicable), then the corresponding
480environment variable will be an empty string.
481
482Note that under normal circumstance all these environment variables are
483defined. If however the total size of the defined settings exceed the
484allocated buffer within cgit then only the environment variables that fit
485in the allocated buffer are handed to the filter.
486
487
488EXAMPLE CGITRC FILE
489-------------------
490
491....
492# Enable caching of up to 1000 output entriess
493cache-size=1000
494
495
496# Specify some default clone prefixes
497clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
498
499# Specify the css url
500css=/css/cgit.css
501
502
503# Show extra links for each repository on the index page
504enable-index-links=1
505
506
507# Enable ASCII art commit history graph on the log pages
508enable-commit-graph=1
509
510
511# Show number of affected files per commit on the log pages
512enable-log-filecount=1
513
514
515# Show number of added/removed lines per commit on the log pages
516enable-log-linecount=1
517
518
519# Add a cgit favicon
520favicon=/favicon.ico
521
522
523# Use a custom logo
524logo=/img/mylogo.png
525
526
527# Enable statistics per week, month and quarter
528max-stats=quarter
529
530
531# Set the title and heading of the repository index page
532root-title=example.com git repositories
533
534
535# Set a subheading for the repository index page
536root-desc=tracking the foobar development
537
538
539# Include some more info about example.com on the index page
540root-readme=/var/www/htdocs/about.html
541
542
543# Allow download of tar.gz, tar.bz2 and zip-files
544snapshots=tar.gz tar.bz2 zip
545
546
547##
548## List of common mimetypes
549##
550
551mimetype.gif=image/gif
552mimetype.html=text/html
553mimetype.jpg=image/jpeg
554mimetype.jpeg=image/jpeg
555mimetype.pdf=application/pdf
556mimetype.png=image/png
557mimetype.svg=image/svg+xml
558
559
560##
561## List of repositories.
562## PS: Any repositories listed when section is unset will not be
563## displayed under a section heading
564## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
565## and included like this:
566## include=/etc/cgitrepos
567##
568
569
570repo.url=foo
571repo.path=/pub/git/foo.git
572repo.desc=the master foo repository
573repo.owner=fooman@example.com
574repo.readme=info/web/about.html
575
576
577repo.url=bar
578repo.path=/pub/git/bar.git
579repo.desc=the bars for your foo
580repo.owner=barman@example.com
581repo.readme=info/web/about.html
582
583
584# The next repositories will be displayed under the 'extras' heading
585section=extras
586
587
588repo.url=baz
589repo.path=/pub/git/baz.git
590repo.desc=a set of extensions for bar users
591
592repo.url=wiz
593repo.path=/pub/git/wiz.git
594repo.desc=the wizard of foo
595
596
597# Add some mirrored repositories
598section=mirrors
599
600
601repo.url=git
602repo.path=/pub/git/git.git
603repo.desc=the dscm
604
605
606repo.url=linux
607repo.path=/pub/git/linux.git
608repo.desc=the kernel
609
610# Disable adhoc downloads of this repo
611repo.snapshots=0
612
613# Disable line-counts for this repo
614repo.enable-log-linecount=0
615
616# Restrict the max statistics period for this repo
617repo.max-stats=month
618....
619
620
621BUGS
622----
623Comments currently cannot appear on the same line as a setting; the comment
624will be included as part of the value. E.g. this line:
625
626 robots=index # allow indexing
627
628will generate the following html element:
629
630 <meta name='robots' content='index # allow indexing'/>
631
632
633
634AUTHOR
635------
636Lars Hjemli <hjemli@gmail.com>
637Jason A. Donenfeld <Jason@zx2c4.com>