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