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