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, the name of the file
33 as the first argument, and the STDOUT from the command will be
34 included verbatim on the about page. Default value: none. See
35 also: "FILTER API".
36
37agefile::
38 Specifies a path, relative to each repository path, which can be used
39 to specify the date and time of the youngest commit in the repository.
40 The first line in the file is used as input to the "parse_date"
41 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
42 hh:mm:ss". You may want to generate this file from a post-receive
43 hook. Default value: "info/web/last-modified".
44
45branch-sort::
46 Flag which, when set to "age", enables date ordering in the branch ref
47 list, and when set to "name" enables ordering by branch name. Default
48 value: "name".
49
50cache-root::
51 Path used to store the cgit cache entries. Default value:
52 "/var/cache/cgit". See also: "MACRO EXPANSION".
53
54cache-static-ttl::
55 Number which specifies the time-to-live, in minutes, for the cached
56 version of repository pages accessed with a fixed SHA1. Negative
57 values have infinite ttl. Default value: -1".
58
59cache-dynamic-ttl::
60 Number which specifies the time-to-live, in minutes, for the cached
61 version of repository pages accessed without a fixed SHA1. Negative
62 values have infinite ttl. Default value: "5".
63
64cache-repo-ttl::
65 Number which specifies the time-to-live, in minutes, for the cached
66 version of the repository summary page. Negative values have infinite
67 ttl. Default value: "5".
68
69cache-root-ttl::
70 Number which specifies the time-to-live, in minutes, for the cached
71 version of the repository index page. Negative values have infinite
72 ttl. Default value: "5".
73
74cache-scanrc-ttl::
75 Number which specifies the time-to-live, in minutes, for the result
76 of scanning a path for git repositories. Negative values have infinite
77 ttl. Default value: "15".
78
79cache-about-ttl::
80 Number which specifies the time-to-live, in minutes, for the cached
81 version of the repository about page. Negative values have infinite
82 ttl. Default value: "15".
83
84cache-size::
85 The maximum number of entries in the cgit cache. Default value: "0"
86 (i.e. caching is disabled).
87
88case-sensitive-sort::
89 Sort items in the repo list case sensitively. Default value: "1".
90 See also: repository-sort, section-sort.
91
92clone-prefix::
93 Space-separated list of common prefixes which, when combined with a
94 repository url, generates valid clone urls for the repository. This
95 setting is only used if `repo.clone-url` is unspecified. Default value:
96 none.
97
98clone-url::
99 Space-separated list of clone-url templates. This setting is only
100 used if `repo.clone-url` is unspecified. Default value: none. See
101 also: "MACRO EXPANSION", "FILTER API".
102
103commit-filter::
104 Specifies a command which will be invoked to format commit messages.
105 The command will get the message on its STDIN, and the STDOUT from the
106 command will be included verbatim as the commit message, i.e. this can
107 be used to implement bugtracker integration. Default value: none.
108 See also: "FILTER API".
109
110commit-sort::
111 Flag which, when set to "date", enables strict date ordering in the
112 commit log, and when set to "topo" enables strict topological
113 ordering. If unset, the default ordering of "git log" is used. Default
114 value: unset.
115
116css::
117 Url which specifies the css document to include in all cgit pages.
118 Default value: "/cgit.css".
119
120email-filter::
121 Specifies a command which will be invoked to format names and email
122 address of committers, authors, and taggers, as represented in various
123 places throughout the cgit interface. This command will receive an
124 email address as its only command line argument, and the text to
125 format on STDIN. It is to write the formatted text back out onto
126 STDOUT. Default value: none. See also: "FILTER API".
127
128embedded::
129 Flag which, when set to "1", will make cgit generate a html fragment
130 suitable for embedding in other html pages. Default value: none. See
131 also: "noheader".
132
133enable-commit-graph::
134 Flag which, when set to "1", will make cgit print an ASCII-art commit
135 history graph to the left of the commit messages in the repository
136 log page. Default value: "0".
137
138enable-filter-overrides::
139 Flag which, when set to "1", allows all filter settings to be
140 overridden in repository-specific cgitrc files. Default value: none.
141
142enable-http-clone::
143 If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
144 You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url
145 to expose this feature. If you use an alternate way of serving git
146 repositories, you may wish to disable this. Default value: "1".
147
148enable-index-links::
149 Flag which, when set to "1", will make cgit generate extra links for
150 each repo in the repository index (specifically, to the "summary",
151 "commit" and "tree" pages). Default value: "0".
152
153enable-index-owner::
154 Flag which, when set to "1", will make cgit display the owner of
155 each repo in the repository index. Default value: "1".
156
157enable-log-filecount::
158 Flag which, when set to "1", will make cgit print the number of
159 modified files for each commit on the repository log page. Default
160 value: "0".
161
162enable-log-linecount::
163 Flag which, when set to "1", will make cgit print the number of added
164 and removed lines for each commit on the repository log page. Default
165 value: "0".
166
167enable-remote-branches::
168 Flag which, when set to "1", will make cgit display remote branches
169 in the summary and refs views. Default value: "0". See also:
170 "repo.enable-remote-branches".
171
172enable-subject-links::
173 Flag which, when set to "1", will make cgit use the subject of the
174 parent commit as link text when generating links to parent commits
175 in commit view. Default value: "0". See also:
176 "repo.enable-subject-links".
177
178enable-tree-linenumbers::
179 Flag which, when set to "1", will make cgit generate linenumber links
180 for plaintext blobs printed in the tree view. Default value: "1".
181
182enable-git-config::
183 Flag which, when set to "1", will allow cgit to use git config to set
184 any repo specific settings. This option is used in conjunction with
185 "scan-path", and must be defined prior, to augment repo-specific
186 settings. The keys gitweb.owner, gitweb.category, and gitweb.description
187 will map to the cgit keys repo.owner, repo.section, and repo.desc,
188 respectively. All git config keys that begin with "cgit." will be mapped
189 to the corresponding "repo." key in cgit. Default value: "0". See also:
190 scan-path, section-from-path.
191
192favicon::
193 Url used as link to a shortcut icon for cgit. It is suggested to use
194 the value "/favicon.ico" since certain browsers will ignore other
195 values. Default value: "/favicon.ico".
196
197footer::
198 The content of the file specified with this option will be included
199 verbatim at the bottom of all pages (i.e. it replaces the standard
200 "generated by..." message. Default value: none.
201
202head-include::
203 The content of the file specified with this option will be included
204 verbatim in the html HEAD section on all pages. Default value: none.
205
206header::
207 The content of the file specified with this option will be included
208 verbatim at the top of all pages. Default value: none.
209
210include::
211 Name of a configfile to include before the rest of the current config-
212 file is parsed. Default value: none. See also: "MACRO EXPANSION".
213
214index-header::
215 The content of the file specified with this option will be included
216 verbatim above the repository index. This setting is deprecated, and
217 will not be supported by cgit-1.0 (use root-readme instead). Default
218 value: none.
219
220index-info::
221 The content of the file specified with this option will be included
222 verbatim below the heading on the repository index page. This setting
223 is deprecated, and will not be supported by cgit-1.0 (use root-desc
224 instead). Default value: none.
225
226local-time::
227 Flag which, if set to "1", makes cgit print commit and tag times in the
228 servers timezone. Default value: "0".
229
230logo::
231 Url which specifies the source of an image which will be used as a logo
232 on all cgit pages. Default value: "/cgit.png".
233
234logo-link::
235 Url loaded when clicking on the cgit logo image. If unspecified the
236 calculated url of the repository index page will be used. Default
237 value: none.
238
239max-atom-items::
240 Specifies the number of items to display in atom feeds view. Default
241 value: "10".
242
243max-commit-count::
244 Specifies the number of entries to list per page in "log" view. Default
245 value: "50".
246
247max-message-length::
248 Specifies the maximum number of commit message characters to display in
249 "log" view. Default value: "80".
250
251max-repo-count::
252 Specifies the number of entries to list per page on the repository
253 index page. Default value: "50".
254
255max-repodesc-length::
256 Specifies the maximum number of repo description characters to display
257 on the repository index page. Default value: "80".
258
259max-blob-size::
260 Specifies the maximum size of a blob to display HTML for in KBytes.
261 Default value: "0" (limit disabled).
262
263max-stats::
264 Set the default maximum statistics period. Valid values are "week",
265 "month", "quarter" and "year". If unspecified, statistics are
266 disabled. Default value: none. See also: "repo.max-stats".
267
268mimetype.<ext>::
269 Set the mimetype for the specified filename extension. This is used
270 by the `plain` command when returning blob content.
271
272mimetype-file::
273 Specifies the file to use for automatic mimetype lookup. If specified
274 then this field is used as a fallback when no "mimetype.<ext>" match is
275 found. If unspecified then no such lookup is performed. The typical file
276 to use on a Linux system is /etc/mime.types. The format of the file must
277 comply to:
278 - a comment line is an empty line or a line starting with a hash (#),
279 optionally preceded by whitespace
280 - a non-comment line starts with the mimetype (like image/png), followed
281 by one or more file extensions (like jpg), all separated by whitespace
282 Default value: none. See also: "mimetype.<ext>".
283
284module-link::
285 Text which will be used as the formatstring for a hyperlink when a
286 submodule is printed in a directory listing. The arguments for the
287 formatstring are the path and SHA1 of the submodule commit. Default
288 value: none.
289
290nocache::
291 If set to the value "1" caching will be disabled. This settings is
292 deprecated, and will not be honored starting with cgit-1.0. Default
293 value: "0".
294
295noplainemail::
296 If set to "1" showing full author email addresses will be disabled.
297 Default value: "0".
298
299noheader::
300 Flag which, when set to "1", will make cgit omit the standard header
301 on all pages. Default value: none. See also: "embedded".
302
303project-list::
304 A list of subdirectories inside of scan-path, relative to it, that
305 should loaded as git repositories. This must be defined prior to
306 scan-path. Default value: none. See also: scan-path, "MACRO
307 EXPANSION".
308
309readme::
310 Text which will be used as default value for "repo.readme". Multiple
311 config keys may be specified, and cgit will use the first found file
312 in this list. This is useful in conjunction with scan-path. Default
313 value: none. See also: scan-path, repo.readme.
314
315remove-suffix::
316 If set to "1" and scan-path is enabled, if any repositories are found
317 with a suffix of ".git", this suffix will be removed for the url and
318 name. This must be defined prior to scan-path. Default value: "0".
319 See also: scan-path.
320
321renamelimit::
322 Maximum number of files to consider when detecting renames. The value
323 "-1" uses the compiletime value in git (for further info, look at
324 `man git-diff`). Default value: "-1".
325
326repo.group::
327 Legacy alias for "section". This option is deprecated and will not be
328 supported in cgit-1.0.
329
330repository-sort::
331 The way in which repositories in each section are sorted. Valid values
332 are "name" for sorting by the repo name or "age" for sorting by the
333 most recently updated repository. Default value: "name". See also:
334 section, case-sensitive-sort, section-sort.
335
336robots::
337 Text used as content for the "robots" meta-tag. Default value:
338 "index, nofollow".
339
340root-desc::
341 Text printed below the heading on the repository index page. Default
342 value: "a fast webinterface for the git dscm".
343
344root-readme::
345 The content of the file specified with this option will be included
346 verbatim below the "about" link on the repository index page. Default
347 value: none.
348
349root-title::
350 Text printed as heading on the repository index page. Default value:
351 "Git Repository Browser".
352
353scan-hidden-path::
354 If set to "1" and scan-path is enabled, scan-path will recurse into
355 directories whose name starts with a period ('.'). Otherwise,
356 scan-path will stay away from such directories (considered as
357 "hidden"). Note that this does not apply to the ".git" directory in
358 non-bare repos. This must be defined prior to scan-path.
359 Default value: 0. See also: scan-path.
360
361scan-path::
362 A path which will be scanned for repositories. If caching is enabled,
363 the result will be cached as a cgitrc include-file in the cache
364 directory. If project-list has been defined prior to scan-path,
365 scan-path loads only the directories listed in the file pointed to by
366 project-list. Be advised that only the global settings taken
367 before the scan-path directive will be applied to each repository.
368 Default value: none. See also: cache-scanrc-ttl, project-list,
369 "MACRO EXPANSION".
370
371section::
372 The name of the current repository section - all repositories defined
373 after this option will inherit the current section name. Default value:
374 none.
375
376section-sort::
377 Flag which, when set to "1", will sort the sections on the repository
378 listing by name. Set this flag to "0" if the order in the cgitrc file should
379 be preserved. Default value: "1". See also: section,
380 case-sensitive-sort, repository-sort.
381
382section-from-path::
383 A number which, if defined prior to scan-path, specifies how many
384 path elements from each repo path to use as a default section name.
385 If negative, cgit will discard the specified number of path elements
386 above the repo directory. Default value: "0".
387
388side-by-side-diffs::
389 If set to "1" shows side-by-side diffs instead of unidiffs per
390 default. Default value: "0".
391
392snapshots::
393 Text which specifies the default set of snapshot formats generated by
394 cgit. The value is a space-separated list of zero or more of the
395 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
396 none.
397
398source-filter::
399 Specifies a command which will be invoked to format plaintext blobs
400 in the tree view. The command will get the blob content on its STDIN
401 and the name of the blob as its only command line argument. The STDOUT
402 from the command will be included verbatim as the blob contents, i.e.
403 this can be used to implement e.g. syntax highlighting. Default value:
404 none. See also: "FILTER API".
405
406summary-branches::
407 Specifies the number of branches to display in the repository "summary"
408 view. Default value: "10".
409
410summary-log::
411 Specifies the number of log entries to display in the repository
412 "summary" view. Default value: "10".
413
414summary-tags::
415 Specifies the number of tags to display in the repository "summary"
416 view. Default value: "10".
417
418strict-export::
419 Filename which, if specified, needs to be present within the repository
420 for cgit to allow access to that repository. This can be used to emulate
421 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
422 repositories to match those exported by git-daemon. This option must
423 be defined prior to scan-path.
424
425virtual-root::
426 Url which, if specified, will be used as root for all cgit links. It
427 will also cause cgit to generate 'virtual urls', i.e. urls like
428 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
429 value: none.
430 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
431 same kind of virtual urls, so this option will probably be deprecated.
432
433
434REPOSITORY SETTINGS
435-------------------
436repo.about-filter::
437 Override the default about-filter. Default value: none. See also:
438 "enable-filter-overrides". See also: "FILTER API".
439
440repo.branch-sort::
441 Flag which, when set to "age", enables date ordering in the branch ref
442 list, and when set to "name" enables ordering by branch name. Default
443 value: "name".
444
445repo.clone-url::
446 A list of space-separated urls which can be used to clone this repo.
447 Default value: none. See also: "MACRO EXPANSION".
448
449repo.commit-filter::
450 Override the default commit-filter. Default value: none. See also:
451 "enable-filter-overrides". See also: "FILTER API".
452
453repo.commit-sort::
454 Flag which, when set to "date", enables strict date ordering in the
455 commit log, and when set to "topo" enables strict topological
456 ordering. If unset, the default ordering of "git log" is used. Default
457 value: unset.
458
459repo.defbranch::
460 The name of the default branch for this repository. If no such branch
461 exists in the repository, the first branch name (when sorted) is used
462 as default instead. Default value: branch pointed to by HEAD, or
463 "master" if there is no suitable HEAD.
464
465repo.desc::
466 The value to show as repository description. Default value: none.
467
468repo.email-filter::
469 Override the default email-filter. Default value: none. See also:
470 "enable-filter-overrides". See also: "FILTER API".
471
472repo.enable-commit-graph::
473 A flag which can be used to disable the global setting
474 `enable-commit-graph'. Default value: none.
475
476repo.enable-log-filecount::
477 A flag which can be used to disable the global setting
478 `enable-log-filecount'. Default value: none.
479
480repo.enable-log-linecount::
481 A flag which can be used to disable the global setting
482 `enable-log-linecount'. Default value: none.
483
484repo.enable-remote-branches::
485 Flag which, when set to "1", will make cgit display remote branches
486 in the summary and refs views. Default value: <enable-remote-branches>.
487
488repo.enable-subject-links::
489 A flag which can be used to override the global setting
490 `enable-subject-links'. Default value: none.
491
492repo.logo::
493 Url which specifies the source of an image which will be used as a logo
494 on this repo's pages. Default value: global logo.
495
496repo.logo-link::
497 Url loaded when clicking on the cgit logo image. If unspecified the
498 calculated url of the repository index page will be used. Default
499 value: global logo-link.
500
501repo.module-link::
502 Text which will be used as the formatstring for a hyperlink when a
503 submodule is printed in a directory listing. The arguments for the
504 formatstring are the path and SHA1 of the submodule commit. Default
505 value: <module-link>
506
507repo.module-link.<path>::
508 Text which will be used as the formatstring for a hyperlink when a
509 submodule with the specified subdirectory path is printed in a
510 directory listing. The only argument for the formatstring is the SHA1
511 of the submodule commit. Default value: none.
512
513repo.max-stats::
514 Override the default maximum statistics period. Valid values are equal
515 to the values specified for the global "max-stats" setting. Default
516 value: none.
517
518repo.name::
519 The value to show as repository name. Default value: <repo.url>.
520
521repo.owner::
522 A value used to identify the owner of the repository. Default value:
523 none.
524
525repo.path::
526 An absolute path to the repository directory. For non-bare repositories
527 this is the .git-directory. Default value: none.
528
529repo.readme::
530 A path (relative to <repo.path>) which specifies a file to include
531 verbatim as the "About" page for this repo. You may also specify a
532 git refspec by head or by hash by prepending the refspec followed by
533 a colon. For example, "master:docs/readme.mkd". If the value begins
534 with a colon, i.e. ":docs/readme.rst", the default branch of the
535 repository will be used. Sharing any file will expose that entire
536 directory tree to the "/about/PATH" endpoints, so be sure that there
537 are no non-public files located in the same directory as the readme
538 file. Default value: <readme>.
539
540repo.snapshots::
541 A mask of allowed snapshot-formats for this repo, restricted by the
542 "snapshots" global setting. Default value: <snapshots>.
543
544repo.section::
545 Override the current section name for this repository. Default value:
546 none.
547
548repo.source-filter::
549 Override the default source-filter. Default value: none. See also:
550 "enable-filter-overrides". See also: "FILTER API".
551
552repo.url::
553 The relative url used to access the repository. This must be the first
554 setting specified for each repo. Default value: none.
555
556
557REPOSITORY-SPECIFIC CGITRC FILE
558-------------------------------
559When the option "scan-path" is used to auto-discover git repositories, cgit
560will try to parse the file "cgitrc" within any found repository. Such a
561repo-specific config file may contain any of the repo-specific options
562described above, except "repo.url" and "repo.path". Additionally, the "filter"
563options are only acknowledged in repo-specific config files when
564"enable-filter-overrides" is set to "1".
565
566Note: the "repo." prefix is dropped from the option names in repo-specific
567config files, e.g. "repo.desc" becomes "desc".
568
569
570FILTER API
571----------
572By default, filters are separate processes that are executed each time they
573are needed. Alternative technologies may be used by prefixing the filter
574specification with the relevant string; available values are:
575
576'exec:'::
577 The default "one process per filter" mode.
578
579'lua:'::
580 Executes the script using a built-in Lua interpreter. The script is
581 loaded once per execution of cgit, and may be called multiple times
582 during cgit's lifetime, making it a good choice for repeated filters
583 such as the 'email filter'. It responds to three functions:
584
585 'filter_open(argument1, argument2, argument3, ...)'::
586 This is called upon activation of the filter for a particular
587 set of data.
588 'filter_write(buffer)'::
589 This is called whenever cgit writes data to the webpage.
590 'filter_close()'::
591 This is called when the current filtering operation is
592 completed.
593
594 Additionally, cgit exposes to the Lua the following built-in functions:
595
596 'html(str)'::
597 Writes 'str' to the webpage.
598 'html_txt(str)'::
599 HTML escapes and writes 'str' to the webpage.
600 'html_attr(str)'::
601 HTML escapes for an attribute and writes "str' to the webpage.
602 'html_url_path(str)'::
603 URL escapes for a path and writes 'str' to the webpage.
604 'html_url_arg(str)'::
605 URL escapes for an argument and writes 'str' to the webpage.
606
607
608Parameters are provided to filters as follows.
609
610about filter::
611 This filter is given a single parameter: the filename of the source
612 file to filter. The filter can use the filename to determine (for
613 example) the type of syntax to follow when formatting the readme file.
614 The about text that is to be filtered is available on standard input
615 and the filtered text is expected on standard output.
616
617commit filter::
618 This filter is given no arguments. The commit message text that is to
619 be filtered is available on standard input and the filtered text is
620 expected on standard output.
621
622email filter::
623 This filter is given a single parameter: the email address of the
624 relevent user. The filter will then receive the text string to format
625 on standard input and is expected to write to standard output the
626 formatted text to be included in the page.
627
628source filter::
629 This filter is given a single parameter: the filename of the source
630 file to filter. The filter can use the filename to determine (for
631 example) the syntax highlighting mode. The contents of the source
632 file that is to be filtered is available on standard input and the
633 filtered contents is expected on standard output.
634
635Also, all filters are handed the following environment variables:
636
637- CGIT_REPO_URL (from repo.url)
638- CGIT_REPO_NAME (from repo.name)
639- CGIT_REPO_PATH (from repo.path)
640- CGIT_REPO_OWNER (from repo.owner)
641- CGIT_REPO_DEFBRANCH (from repo.defbranch)
642- CGIT_REPO_SECTION (from repo.section)
643- CGIT_REPO_CLONE_URL (from repo.clone-url)
644
645If a setting is not defined for a repository and the corresponding global
646setting is also not defined (if applicable), then the corresponding
647environment variable will be unset.
648
649
650MACRO EXPANSION
651---------------
652The following cgitrc options support a simple macro expansion feature,
653where tokens prefixed with "$" are replaced with the value of a similarly
654named environment variable:
655
656- cache-root
657- include
658- project-list
659- scan-path
660
661Macro expansion will also happen on the content of $CGIT_CONFIG, if
662defined.
663
664One usage of this feature is virtual hosting, which in its simplest form
665can be accomplished by adding the following line to /etc/cgitrc:
666
667 include=/etc/cgitrc.d/$HTTP_HOST
668
669The following options are expanded during request processing, and support
670the environment variables defined in "FILTER API":
671
672- clone-url
673- repo.clone-url
674
675
676EXAMPLE CGITRC FILE
677-------------------
678
679....
680# Enable caching of up to 1000 output entries
681cache-size=1000
682
683
684# Specify some default clone urls using macro expansion
685clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
686
687# Specify the css url
688css=/css/cgit.css
689
690
691# Show owner on index page
692enable-index-owner=1
693
694
695# Allow http transport git clone
696enable-http-clone=1
697
698
699# Show extra links for each repository on the index page
700enable-index-links=1
701
702
703# Enable ASCII art commit history graph on the log pages
704enable-commit-graph=1
705
706
707# Show number of affected files per commit on the log pages
708enable-log-filecount=1
709
710
711# Show number of added/removed lines per commit on the log pages
712enable-log-linecount=1
713
714
715# Sort branches by date
716branch-sort=age
717
718
719# Add a cgit favicon
720favicon=/favicon.ico
721
722
723# Use a custom logo
724logo=/img/mylogo.png
725
726
727# Enable statistics per week, month and quarter
728max-stats=quarter
729
730
731# Set the title and heading of the repository index page
732root-title=example.com git repositories
733
734
735# Set a subheading for the repository index page
736root-desc=tracking the foobar development
737
738
739# Include some more info about example.com on the index page
740root-readme=/var/www/htdocs/about.html
741
742
743# Allow download of tar.gz, tar.bz2 and zip-files
744snapshots=tar.gz tar.bz2 zip
745
746
747##
748## List of common mimetypes
749##
750
751mimetype.gif=image/gif
752mimetype.html=text/html
753mimetype.jpg=image/jpeg
754mimetype.jpeg=image/jpeg
755mimetype.pdf=application/pdf
756mimetype.png=image/png
757mimetype.svg=image/svg+xml
758
759
760# Highlight source code with python pygments-based highlighter
761source-filter=/var/www/cgit/filters/syntax-highlighting.py
762
763# Format markdown, restructuredtext, manpages, text files, and html files
764# through the right converters
765about-filter=/var/www/cgit/filters/about-formatting.sh
766
767##
768## Search for these files in the root of the default branch of repositories
769## for coming up with the about page:
770##
771readme=:README.md
772readme=:readme.md
773readme=:README.mkd
774readme=:readme.mkd
775readme=:README.rst
776readme=:readme.rst
777readme=:README.html
778readme=:readme.html
779readme=:README.htm
780readme=:readme.htm
781readme=:README.txt
782readme=:readme.txt
783readme=:README
784readme=:readme
785readme=:INSTALL.md
786readme=:install.md
787readme=:INSTALL.mkd
788readme=:install.mkd
789readme=:INSTALL.rst
790readme=:install.rst
791readme=:INSTALL.html
792readme=:install.html
793readme=:INSTALL.htm
794readme=:install.htm
795readme=:INSTALL.txt
796readme=:install.txt
797readme=:INSTALL
798readme=:install
799
800
801##
802## List of repositories.
803## PS: Any repositories listed when section is unset will not be
804## displayed under a section heading
805## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
806## and included like this:
807## include=/etc/cgitrepos
808##
809
810
811repo.url=foo
812repo.path=/pub/git/foo.git
813repo.desc=the master foo repository
814repo.owner=fooman@example.com
815repo.readme=info/web/about.html
816
817
818repo.url=bar
819repo.path=/pub/git/bar.git
820repo.desc=the bars for your foo
821repo.owner=barman@example.com
822repo.readme=info/web/about.html
823
824
825# The next repositories will be displayed under the 'extras' heading
826section=extras
827
828
829repo.url=baz
830repo.path=/pub/git/baz.git
831repo.desc=a set of extensions for bar users
832
833repo.url=wiz
834repo.path=/pub/git/wiz.git
835repo.desc=the wizard of foo
836
837
838# Add some mirrored repositories
839section=mirrors
840
841
842repo.url=git
843repo.path=/pub/git/git.git
844repo.desc=the dscm
845
846
847repo.url=linux
848repo.path=/pub/git/linux.git
849repo.desc=the kernel
850
851# Disable adhoc downloads of this repo
852repo.snapshots=0
853
854# Disable line-counts for this repo
855repo.enable-log-linecount=0
856
857# Restrict the max statistics period for this repo
858repo.max-stats=month
859....
860
861
862BUGS
863----
864Comments currently cannot appear on the same line as a setting; the comment
865will be included as part of the value. E.g. this line:
866
867 robots=index # allow indexing
868
869will generate the following html element:
870
871 <meta name='robots' content='index # allow indexing'/>
872
873
874
875AUTHOR
876------
877Lars Hjemli <hjemli@gmail.com>
878Jason A. Donenfeld <Jason@zx2c4.com>