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         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
 140 enable-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
 145 enable-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
 149 enable-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
 154 enable-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
 159 enable-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
 164 enable-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
 170 enable-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
 174 enable-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
 184 favicon::
 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
 189 footer::
 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
 194 head-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
 198 header::
 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
 202 include::
 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
 206 index-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
 212 index-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
 218 local-time::
 219         Flag which, if set to "1", makes cgit print commit and tag times in the
 220         servers timezone. Default value: "0".
 221
 222 logo::
 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
 226 logo-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
 231 max-atom-items::
 232         Specifies the number of items to display in atom feeds view. Default
 233         value: "10".
 234
 235 max-commit-count::
 236         Specifies the number of entries to list per page in "log" view. Default
 237         value: "50".
 238
 239 max-message-length::
 240         Specifies the maximum number of commit message characters to display in
 241         "log" view. Default value: "80".
 242
 243 max-repo-count::
 244         Specifies the number of entries to list per page on the repository
 245         index page. Default value: "50".
 246
 247 max-repodesc-length::
 248         Specifies the maximum number of repo description characters to display
 249         on the repository index page. Default value: "80".
 250
 251 max-blob-size::
 252         Specifies the maximum size of a blob to display HTML for in KBytes.
 253         Default value: "0" (limit disabled).
 254
 255 max-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
 260 mimetype.<ext>::
 261         Set the mimetype for the specified filename extension. This is used
 262         by the `plain` command when returning blob content.
 263
 264 mimetype-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
 276 module-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
 282 nocache::
 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
 287 noplainemail::
 288         If set to "1" showing full author email addresses will be disabled.
 289         Default value: "0".
 290
 291 noheader::
 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
 295 project-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
 301 readme::
 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
 307 remove-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
 313 renamelimit::
 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
 318 repo.group::
 319         Legacy alias for "section". This option is deprecated and will not be
 320         supported in cgit-1.0.
 321
 322 repository-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
 328 robots::
 329         Text used as content for the "robots" meta-tag. Default value:
 330         "index, nofollow".
 331
 332 root-desc::
 333         Text printed below the heading on the repository index page. Default
 334         value: "a fast webinterface for the git dscm".
 335
 336 root-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
 341 root-title::
 342         Text printed as heading on the repository index page. Default value:
 343         "Git Repository Browser".
 344
 345 scan-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
 353 scan-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
 363 section::
 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
 368 section-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
 374 section-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
 380 side-by-side-diffs::
 381         If set to "1" shows side-by-side diffs instead of unidiffs per
 382         default. Default value: "0".
 383
 384 snapshots::
 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
 390 source-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
 398 summary-branches::
 399         Specifies the number of branches to display in the repository "summary"
 400         view. Default value: "10".
 401
 402 summary-log::
 403         Specifies the number of log entries to display in the repository
 404         "summary" view. Default value: "10".
 405
 406 summary-tags::
 407         Specifies the number of tags to display in the repository "summary"
 408         view. Default value: "10".
 409
 410 strict-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
 417 virtual-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
 426 REPOSITORY SETTINGS
 427 -------------------
 428 repo.about-filter::
 429         Override the default about-filter. Default value: none. See also:
 430         "enable-filter-overrides". See also: "FILTER API".
 431
 432 repo.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
 437 repo.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
 441 repo.commit-filter::
 442         Override the default commit-filter. Default value: none. See also:
 443         "enable-filter-overrides". See also: "FILTER API".
 444
 445 repo.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
 451 repo.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
 457 repo.desc::
 458         The value to show as repository description. Default value: none.
 459
 460 repo.enable-commit-graph::
 461         A flag which can be used to disable the global setting
 462         `enable-commit-graph'. Default value: none.
 463
 464 repo.enable-log-filecount::
 465         A flag which can be used to disable the global setting
 466         `enable-log-filecount'. Default value: none.
 467
 468 repo.enable-log-linecount::
 469         A flag which can be used to disable the global setting
 470         `enable-log-linecount'. Default value: none.
 471
 472 repo.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
 476 repo.enable-subject-links::
 477         A flag which can be used to override the global setting
 478         `enable-subject-links'. Default value: none.
 479
 480 repo.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
 484 repo.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
 489 repo.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
 495 repo.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
 501 repo.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
 506 repo.name::
 507         The value to show as repository name. Default value: <repo.url>.
 508
 509 repo.owner::
 510         A value used to identify the owner of the repository. Default value:
 511         none.
 512
 513 repo.path::
 514         An absolute path to the repository directory. For non-bare repositories
 515         this is the .git-directory. Default value: none.
 516
 517 repo.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
 528 repo.snapshots::
 529         A mask of allowed snapshot-formats for this repo, restricted by the
 530         "snapshots" global setting. Default value: <snapshots>.
 531
 532 repo.section::
 533         Override the current section name for this repository. Default value:
 534         none.
 535
 536 repo.source-filter::
 537         Override the default source-filter. Default value: none. See also:
 538         "enable-filter-overrides". See also: "FILTER API".
 539
 540 repo.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
 545 REPOSITORY-SPECIFIC CGITRC FILE
 546 -------------------------------
 547 When the option "scan-path" is used to auto-discover git repositories, cgit
 548 will try to parse the file "cgitrc" within any found repository. Such a
 549 repo-specific config file may contain any of the repo-specific options
 550 described above, except "repo.url" and "repo.path". Additionally, the "filter"
 551 options are only acknowledged in repo-specific config files when
 552 "enable-filter-overrides" is set to "1".
 553
 554 Note: the "repo." prefix is dropped from the option names in repo-specific
 555 config files, e.g. "repo.desc" becomes "desc".
 556
 557
 558 FILTER API
 559 ----------
 560 By default, filters are separate processes that are executed each time they
 561 are needed.  Alternative technologies may be used by prefixing the filter
 562 specification with the relevant string; available values are:
 563
 564 'exec:'::
 565         The default "one process per filter" mode.
 566
 567 'lua:'::
 568         Executes the script using a built-in Lua interpreter. The script is
 569         loaded once per execution of cgit, and may be called multiple times
 570         during cgit's lifetime, making it a good choice for repeated filters
 571         such as the 'email filter'. It responds to three functions:
 572
 573         'filter_open(argument1, argument2, argument3, ...)'::
 574                 This is called upon activation of the filter for a particular
 575                 set of data.
 576         'filter_write(buffer)'::
 577                 This is called whenever cgit writes data to the webpage.
 578         'filter_close()'::
 579                 This is called when the current filtering operation is
 580                 completed.
 581
 582         Additionally, cgit exposes to the Lua the following built-in functions:
 583
 584         'html(str)'::
 585                 Writes 'str' to the webpage.
 586         'html_txt(str)'::
 587                 HTML escapes and writes 'str' to the webpage.
 588         'html_attr(str)'::
 589                 HTML escapes for an attribute and writes "str' to the webpage.
 590         'html_url_path(str)'::
 591                 URL escapes for a path and writes 'str' to the webpage.
 592         'html_url_arg(str)'::
 593                 URL escapes for an argument and writes 'str' to the webpage.
 594
 595
 596 Parameters are provided to filters as follows.
 597
 598 about filter::
 599         This filter is given a single parameter: the filename of the source
 600         file to filter. The filter can use the filename to determine (for
 601         example) the type of syntax to follow when formatting the readme file.
 602         The about text that is to be filtered is available on standard input
 603         and the filtered text is expected on standard output.
 604
 605 commit filter::
 606         This filter is given no arguments. The commit message text that is to
 607         be filtered is available on standard input and the filtered text is
 608         expected on standard output.
 609
 610 source filter::
 611         This filter is given a single parameter: the filename of the source
 612         file to filter. The filter can use the filename to determine (for
 613         example) the syntax highlighting mode. The contents of the source
 614         file that is to be filtered is available on standard input and the
 615         filtered contents is expected on standard output.
 616
 617 Also, all filters are handed the following environment variables:
 618
 619 - CGIT_REPO_URL (from repo.url)
 620 - CGIT_REPO_NAME (from repo.name)
 621 - CGIT_REPO_PATH (from repo.path)
 622 - CGIT_REPO_OWNER (from repo.owner)
 623 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
 624 - CGIT_REPO_SECTION (from repo.section)
 625 - CGIT_REPO_CLONE_URL (from repo.clone-url)
 626
 627 If a setting is not defined for a repository and the corresponding global
 628 setting is also not defined (if applicable), then the corresponding
 629 environment variable will be unset.
 630
 631
 632 MACRO EXPANSION
 633 ---------------
 634 The following cgitrc options support a simple macro expansion feature,
 635 where tokens prefixed with "$" are replaced with the value of a similarly
 636 named environment variable:
 637
 638 - cache-root
 639 - include
 640 - project-list
 641 - scan-path
 642
 643 Macro expansion will also happen on the content of $CGIT_CONFIG, if
 644 defined.
 645
 646 One usage of this feature is virtual hosting, which in its simplest form
 647 can be accomplished by adding the following line to /etc/cgitrc:
 648
 649         include=/etc/cgitrc.d/$HTTP_HOST
 650
 651 The following options are expanded during request processing, and support
 652 the environment variables defined in "FILTER API":
 653
 654 - clone-url
 655 - repo.clone-url
 656
 657
 658 EXAMPLE CGITRC FILE
 659 -------------------
 660
 661 ....
 662 # Enable caching of up to 1000 output entries
 663 cache-size=1000
 664
 665
 666 # Specify some default clone urls using macro expansion
 667 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 668
 669 # Specify the css url
 670 css=/css/cgit.css
 671
 672
 673 # Show owner on index page
 674 enable-index-owner=1
 675
 676
 677 # Allow http transport git clone
 678 enable-http-clone=1
 679
 680
 681 # Show extra links for each repository on the index page
 682 enable-index-links=1
 683
 684
 685 # Enable ASCII art commit history graph on the log pages
 686 enable-commit-graph=1
 687
 688
 689 # Show number of affected files per commit on the log pages
 690 enable-log-filecount=1
 691
 692
 693 # Show number of added/removed lines per commit on the log pages
 694 enable-log-linecount=1
 695
 696
 697 # Sort branches by date
 698 branch-sort=age
 699
 700
 701 # Add a cgit favicon
 702 favicon=/favicon.ico
 703
 704
 705 # Use a custom logo
 706 logo=/img/mylogo.png
 707
 708
 709 # Enable statistics per week, month and quarter
 710 max-stats=quarter
 711
 712
 713 # Set the title and heading of the repository index page
 714 root-title=example.com git repositories
 715
 716
 717 # Set a subheading for the repository index page
 718 root-desc=tracking the foobar development
 719
 720
 721 # Include some more info about example.com on the index page
 722 root-readme=/var/www/htdocs/about.html
 723
 724
 725 # Allow download of tar.gz, tar.bz2 and zip-files
 726 snapshots=tar.gz tar.bz2 zip
 727
 728
 729 ##
 730 ## List of common mimetypes
 731 ##
 732
 733 mimetype.gif=image/gif
 734 mimetype.html=text/html
 735 mimetype.jpg=image/jpeg
 736 mimetype.jpeg=image/jpeg
 737 mimetype.pdf=application/pdf
 738 mimetype.png=image/png
 739 mimetype.svg=image/svg+xml
 740
 741
 742 # Highlight source code with python pygments-based highlighter
 743 source-filter=/var/www/cgit/filters/syntax-highlighting.py
 744
 745 # Format markdown, restructuredtext, manpages, text files, and html files
 746 # through the right converters
 747 about-filter=/var/www/cgit/filters/about-formatting.sh
 748
 749 ##
 750 ## Search for these files in the root of the default branch of repositories
 751 ## for coming up with the about page:
 752 ##
 753 readme=:README.md
 754 readme=:readme.md
 755 readme=:README.mkd
 756 readme=:readme.mkd
 757 readme=:README.rst
 758 readme=:readme.rst
 759 readme=:README.html
 760 readme=:readme.html
 761 readme=:README.htm
 762 readme=:readme.htm
 763 readme=:README.txt
 764 readme=:readme.txt
 765 readme=:README
 766 readme=:readme
 767 readme=:INSTALL.md
 768 readme=:install.md
 769 readme=:INSTALL.mkd
 770 readme=:install.mkd
 771 readme=:INSTALL.rst
 772 readme=:install.rst
 773 readme=:INSTALL.html
 774 readme=:install.html
 775 readme=:INSTALL.htm
 776 readme=:install.htm
 777 readme=:INSTALL.txt
 778 readme=:install.txt
 779 readme=:INSTALL
 780 readme=:install
 781
 782
 783 ##
 784 ## List of repositories.
 785 ## PS: Any repositories listed when section is unset will not be
 786 ##     displayed under a section heading
 787 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 788 ##      and included like this:
 789 ##        include=/etc/cgitrepos
 790 ##
 791
 792
 793 repo.url=foo
 794 repo.path=/pub/git/foo.git
 795 repo.desc=the master foo repository
 796 repo.owner=fooman@example.com
 797 repo.readme=info/web/about.html
 798
 799
 800 repo.url=bar
 801 repo.path=/pub/git/bar.git
 802 repo.desc=the bars for your foo
 803 repo.owner=barman@example.com
 804 repo.readme=info/web/about.html
 805
 806
 807 # The next repositories will be displayed under the 'extras' heading
 808 section=extras
 809
 810
 811 repo.url=baz
 812 repo.path=/pub/git/baz.git
 813 repo.desc=a set of extensions for bar users
 814
 815 repo.url=wiz
 816 repo.path=/pub/git/wiz.git
 817 repo.desc=the wizard of foo
 818
 819
 820 # Add some mirrored repositories
 821 section=mirrors
 822
 823
 824 repo.url=git
 825 repo.path=/pub/git/git.git
 826 repo.desc=the dscm
 827
 828
 829 repo.url=linux
 830 repo.path=/pub/git/linux.git
 831 repo.desc=the kernel
 832
 833 # Disable adhoc downloads of this repo
 834 repo.snapshots=0
 835
 836 # Disable line-counts for this repo
 837 repo.enable-log-linecount=0
 838
 839 # Restrict the max statistics period for this repo
 840 repo.max-stats=month
 841 ....
 842
 843
 844 BUGS
 845 ----
 846 Comments currently cannot appear on the same line as a setting; the comment
 847 will be included as part of the value. E.g. this line:
 848
 849         robots=index  # allow indexing
 850
 851 will generate the following html element:
 852
 853         <meta name='robots' content='index  # allow indexing'/>
 854
 855
 856
 857 AUTHOR
 858 ------
 859 Lars Hjemli <hjemli@gmail.com>
 860 Jason A. Donenfeld <Jason@zx2c4.com>