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".
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.
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.
241
242readme::
243 Text which will be used as default value for "repo.readme". Default
244 value: none.
245
246remove-suffix::
247 If set to "1" and scan-path is enabled, if any repositories are found
248 with a suffix of ".git", this suffix will be removed for the url and
249 name. Default value: "0". See also: scan-path.
250
251renamelimit::
252 Maximum number of files to consider when detecting renames. The value
253 "-1" uses the compiletime value in git (for further info, look at
254 `man git-diff`). Default value: "-1".
255
256repo.group::
257 Legacy alias for "section". This option is deprecated and will not be
258 supported in cgit-1.0.
259
260robots::
261 Text used as content for the "robots" meta-tag. Default value:
262 "index, nofollow".
263
264root-desc::
265 Text printed below the heading on the repository index page. Default
266 value: "a fast webinterface for the git dscm".
267
268root-readme::
269 The content of the file specified with this option will be included
270 verbatim below the "about" link on the repository index page. Default
271 value: none.
272
273root-title::
274 Text printed as heading on the repository index page. Default value:
275 "Git Repository Browser".
276
277scan-hidden-path::
278 If set to "1" and scan-path is enabled, scan-path will recurse into
279 directories whose name starts with a period ('.'). Otherwise,
280 scan-path will stay away from such directories (considered as
281 "hidden"). Note that this does not apply to the ".git" directory in
282 non-bare repos. This must be defined prior to scan-path.
283 Default value: 0. See also: scan-path.
284
285scan-path::
286 A path which will be scanned for repositories. If caching is enabled,
287 the result will be cached as a cgitrc include-file in the cache
288 directory. If project-list has been defined prior to scan-path,
289 scan-path loads only the directories listed in the file pointed to by
290 project-list. Default value: none. See also: cache-scanrc-ttl,
291 project-list.
292
293section::
294 The name of the current repository section - all repositories defined
295 after this option will inherit the current section name. Default value:
296 none.
297
298section-from-path::
299 A number which, if specified before scan-path, specifies how many
300 path elements from each repo path to use as a default section name.
301 If negative, cgit will discard the specified number of path elements
302 above the repo directory. Default value: 0.
303
304side-by-side-diffs::
305 If set to "1" shows side-by-side diffs instead of unidiffs per
306 default. Default value: "0".
307
308snapshots::
309 Text which specifies the default set of snapshot formats generated by
310 cgit. The value is a space-separated list of zero or more of the
311 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
312
313source-filter::
314 Specifies a command which will be invoked to format plaintext blobs
315 in the tree view. The command will get the blob content on its STDIN
316 and the name of the blob as its only command line argument. The STDOUT
317 from the command will be included verbatim as the blob contents, i.e.
318 this can be used to implement e.g. syntax highlighting. Default value:
319 none.
320
321summary-branches::
322 Specifies the number of branches to display in the repository "summary"
323 view. Default value: "10".
324
325summary-log::
326 Specifies the number of log entries to display in the repository
327 "summary" view. Default value: "10".
328
329summary-tags::
330 Specifies the number of tags to display in the repository "summary"
331 view. Default value: "10".
332
333strict-export::
334 Filename which, if specified, needs to be present within the repository
335 for cgit to allow access to that repository. This can be used to emulate
336 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
337 repositories to match those exported by git-daemon. This option MUST come
338 before 'scan-path'.
339
340virtual-root::
341 Url which, if specified, will be used as root for all cgit links. It
342 will also cause cgit to generate 'virtual urls', i.e. urls like
343 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
344 value: none.
345 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
346 same kind of virtual urls, so this option will probably be deprecated.
347
348REPOSITORY SETTINGS
349-------------------
350repo.about-filter::
351 Override the default about-filter. Default value: none. See also:
352 "enable-filter-overrides".
353
354repo.clone-url::
355 A list of space-separated urls which can be used to clone this repo.
356 Default value: none.
357
358repo.commit-filter::
359 Override the default commit-filter. Default value: none. See also:
360 "enable-filter-overrides".
361
362repo.defbranch::
363 The name of the default branch for this repository. If no such branch
364 exists in the repository, the first branch name (when sorted) is used
365 as default instead. Default value: "master".
366
367repo.desc::
368 The value to show as repository description. Default value: none.
369
370repo.enable-commit-graph::
371 A flag which can be used to disable the global setting
372 `enable-commit-graph'. Default value: none.
373
374repo.enable-log-filecount::
375 A flag which can be used to disable the global setting
376 `enable-log-filecount'. Default value: none.
377
378repo.enable-log-linecount::
379 A flag which can be used to disable the global setting
380 `enable-log-linecount'. Default value: none.
381
382repo.enable-remote-branches::
383 Flag which, when set to "1", will make cgit display remote branches
384 in the summary and refs views. Default value: <enable-remote-branches>.
385
386repo.enable-subject-links::
387 A flag which can be used to override the global setting
388 `enable-subject-links'. Default value: none.
389
390repo.logo::
391 Url which specifies the source of an image which will be used as a logo
392 on this repo's pages. Default value: global logo.
393
394repo.logo-link::
395 Url loaded when clicking on the cgit logo image. If unspecified the
396 calculated url of the repository index page will be used. Default
397 value: global logo-link.
398
399repo.max-stats::
400 Override the default maximum statistics period. Valid values are equal
401 to the values specified for the global "max-stats" setting. Default
402 value: none.
403
404repo.name::
405 The value to show as repository name. Default value: <repo.url>.
406
407repo.owner::
408 A value used to identify the owner of the repository. Default value:
409 none.
410
411repo.path::
412 An absolute path to the repository directory. For non-bare repositories
413 this is the .git-directory. Default value: none.
414
415repo.readme::
416 A path (relative to <repo.path>) which specifies a file to include
417 verbatim as the "About" page for this repo. You may also specify a
418 git refspec by head or by hash by prepending the refspec followed by
419 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
420
421repo.snapshots::
422 A mask of allowed snapshot-formats for this repo, restricted by the
423 "snapshots" global setting. Default value: <snapshots>.
424
425repo.section::
426 Override the current section name for this repository. Default value:
427 none.
428
429repo.source-filter::
430 Override the default source-filter. Default value: none. See also:
431 "enable-filter-overrides".
432
433repo.url::
434 The relative url used to access the repository. This must be the first
435 setting specified for each repo. Default value: none.
436
437
438REPOSITORY-SPECIFIC CGITRC FILE
439-------------------------------
440When the option "scan-path" is used to auto-discover git repositories, cgit
441will try to parse the file "cgitrc" within any found repository. Such a
442repo-specific config file may contain any of the repo-specific options
443described above, except "repo.url" and "repo.path". Additionally, the "filter"
444options are only acknowledged in repo-specific config files when
445"enable-filter-overrides" is set to "1".
446
447Note: the "repo." prefix is dropped from the option names in repo-specific
448config files, e.g. "repo.desc" becomes "desc".
449
450
451EXAMPLE CGITRC FILE
452-------------------
453
454....
455# Enable caching of up to 1000 output entriess
456cache-size=1000
457
458
459# Specify some default clone prefixes
460clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
461
462# Specify the css url
463css=/css/cgit.css
464
465
466# Show extra links for each repository on the index page
467enable-index-links=1
468
469
470# Enable ASCII art commit history graph on the log pages
471enable-commit-graph=1
472
473
474# Show number of affected files per commit on the log pages
475enable-log-filecount=1
476
477
478# Show number of added/removed lines per commit on the log pages
479enable-log-linecount=1
480
481
482# Add a cgit favicon
483favicon=/favicon.ico
484
485
486# Use a custom logo
487logo=/img/mylogo.png
488
489
490# Enable statistics per week, month and quarter
491max-stats=quarter
492
493
494# Set the title and heading of the repository index page
495root-title=example.com git repositories
496
497
498# Set a subheading for the repository index page
499root-desc=tracking the foobar development
500
501
502# Include some more info about example.com on the index page
503root-readme=/var/www/htdocs/about.html
504
505
506# Allow download of tar.gz, tar.bz2 and zip-files
507snapshots=tar.gz tar.bz2 zip
508
509
510##
511## List of common mimetypes
512##
513
514mimetype.gif=image/gif
515mimetype.html=text/html
516mimetype.jpg=image/jpeg
517mimetype.jpeg=image/jpeg
518mimetype.pdf=application/pdf
519mimetype.png=image/png
520mimetype.svg=image/svg+xml
521
522
523##
524## List of repositories.
525## PS: Any repositories listed when section is unset will not be
526## displayed under a section heading
527## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
528## and included like this:
529## include=/etc/cgitrepos
530##
531
532
533repo.url=foo
534repo.path=/pub/git/foo.git
535repo.desc=the master foo repository
536repo.owner=fooman@example.com
537repo.readme=info/web/about.html
538
539
540repo.url=bar
541repo.path=/pub/git/bar.git
542repo.desc=the bars for your foo
543repo.owner=barman@example.com
544repo.readme=info/web/about.html
545
546
547# The next repositories will be displayed under the 'extras' heading
548section=extras
549
550
551repo.url=baz
552repo.path=/pub/git/baz.git
553repo.desc=a set of extensions for bar users
554
555repo.url=wiz
556repo.path=/pub/git/wiz.git
557repo.desc=the wizard of foo
558
559
560# Add some mirrored repositories
561section=mirrors
562
563
564repo.url=git
565repo.path=/pub/git/git.git
566repo.desc=the dscm
567
568
569repo.url=linux
570repo.path=/pub/git/linux.git
571repo.desc=the kernel
572
573# Disable adhoc downloads of this repo
574repo.snapshots=0
575
576# Disable line-counts for this repo
577repo.enable-log-linecount=0
578
579# Restrict the max statistics period for this repo
580repo.max-stats=month
581....
582
583
584BUGS
585----
586Comments currently cannot appear on the same line as a setting; the comment
587will be included as part of the value. E.g. this line:
588
589 robots=index # allow indexing
590
591will generate the following html element:
592
593 <meta name='robots' content='index # allow indexing'/>
594
595
596
597AUTHOR
598------
599Lars Hjemli <hjemli@gmail.com>
600Jason A. Donenfeld <Jason@zx2c4.com>