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