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