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