gitweb.ps.run Git - ps-cgit/blob - cgitrc.5.txt

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