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         Default value: none.
 433
 434 source-filter::
 435         Specifies a command which will be invoked to format plaintext blobs
 436         in the tree view. The command will get the blob content on its STDIN
 437         and the name of the blob as its only command line argument. The STDOUT
 438         from the command will be included verbatim as the blob contents, i.e.
 439         this can be used to implement e.g. syntax highlighting. Default value:
 440         none. See also: "FILTER API".
 441
 442 summary-branches::
 443         Specifies the number of branches to display in the repository "summary"
 444         view. Default value: "10".
 445
 446 summary-log::
 447         Specifies the number of log entries to display in the repository
 448         "summary" view. Default value: "10".
 449
 450 summary-tags::
 451         Specifies the number of tags to display in the repository "summary"
 452         view. Default value: "10".
 453
 454 strict-export::
 455         Filename which, if specified, needs to be present within the repository
 456         for cgit to allow access to that repository. This can be used to emulate
 457         gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
 458         repositories to match those exported by git-daemon. This option must
 459         be defined prior to scan-path.
 460
 461 virtual-root::
 462         Url which, if specified, will be used as root for all cgit links. It
 463         will also cause cgit to generate 'virtual urls', i.e. urls like
 464         '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
 465         value: none.
 466         NOTE: cgit has recently learned how to use PATH_INFO to achieve the
 467         same kind of virtual urls, so this option will probably be deprecated.
 468
 469
 470 REPOSITORY SETTINGS
 471 -------------------
 472 repo.about-filter::
 473         Override the default about-filter. Default value: none. See also:
 474         "enable-filter-overrides". See also: "FILTER API".
 475
 476 repo.branch-sort::
 477         Flag which, when set to "age", enables date ordering in the branch ref
 478         list, and when set to "name" enables ordering by branch name. Default
 479         value: "name".
 480
 481 repo.clone-url::
 482         A list of space-separated urls which can be used to clone this repo.
 483         Default value: none. See also: "MACRO EXPANSION".
 484
 485 repo.commit-filter::
 486         Override the default commit-filter. Default value: none. See also:
 487         "enable-filter-overrides". See also: "FILTER API".
 488
 489 repo.commit-sort::
 490         Flag which, when set to "date", enables strict date ordering in the
 491         commit log, and when set to "topo" enables strict topological
 492         ordering. If unset, the default ordering of "git log" is used. Default
 493         value: unset.
 494
 495 repo.defbranch::
 496         The name of the default branch for this repository. If no such branch
 497         exists in the repository, the first branch name (when sorted) is used
 498         as default instead. Default value: branch pointed to by HEAD, or
 499         "master" if there is no suitable HEAD.
 500
 501 repo.desc::
 502         The value to show as repository description. Default value: none.
 503
 504 repo.homepage::
 505         The value to show as repository homepage. Default value: none.
 506
 507 repo.email-filter::
 508         Override the default email-filter. Default value: none. See also:
 509         "enable-filter-overrides". See also: "FILTER API".
 510
 511 repo.enable-commit-graph::
 512         A flag which can be used to disable the global setting
 513         `enable-commit-graph'. Default value: none.
 514
 515 repo.enable-log-filecount::
 516         A flag which can be used to disable the global setting
 517         `enable-log-filecount'. Default value: none.
 518
 519 repo.enable-log-linecount::
 520         A flag which can be used to disable the global setting
 521         `enable-log-linecount'. Default value: none.
 522
 523 repo.enable-remote-branches::
 524         Flag which, when set to "1", will make cgit display remote branches
 525         in the summary and refs views. Default value: <enable-remote-branches>.
 526
 527 repo.enable-subject-links::
 528         A flag which can be used to override the global setting
 529         `enable-subject-links'. Default value: none.
 530
 531 repo.enable-html-serving::
 532         A flag which can be used to override the global setting
 533         `enable-html-serving`. Default value: none.
 534
 535 repo.hide::
 536         Flag which, when set to "1", hides the repository from the repository
 537         index. The repository can still be accessed by providing a direct path.
 538         Default value: "0". See also: "repo.ignore".
 539
 540 repo.ignore::
 541         Flag which, when set to "1", ignores the repository. The repository
 542         is not shown in the index and cannot be accessed by providing a direct
 543         path. Default value: "0". See also: "repo.hide".
 544
 545 repo.logo::
 546         Url which specifies the source of an image which will be used as a logo
 547         on this repo's pages. Default value: global logo.
 548
 549 repo.logo-link::
 550         Url loaded when clicking on the cgit logo image. If unspecified the
 551         calculated url of the repository index page will be used. Default
 552         value: global logo-link.
 553
 554 repo.owner-filter::
 555         Override the default owner-filter. Default value: none. See also:
 556         "enable-filter-overrides". See also: "FILTER API".
 557
 558 repo.module-link::
 559         Text which will be used as the formatstring for a hyperlink when a
 560         submodule is printed in a directory listing. The arguments for the
 561         formatstring are the path and SHA1 of the submodule commit. Default
 562         value: <module-link>
 563
 564 repo.module-link.<path>::
 565         Text which will be used as the formatstring for a hyperlink when a
 566         submodule with the specified subdirectory path is printed in a
 567         directory listing. The only argument for the formatstring is the SHA1
 568         of the submodule commit. Default value: none.
 569
 570 repo.max-stats::
 571         Override the default maximum statistics period. Valid values are equal
 572         to the values specified for the global "max-stats" setting. Default
 573         value: none.
 574
 575 repo.name::
 576         The value to show as repository name. Default value: <repo.url>.
 577
 578 repo.owner::
 579         A value used to identify the owner of the repository. Default value:
 580         none.
 581
 582 repo.path::
 583         An absolute path to the repository directory. For non-bare repositories
 584         this is the .git-directory. Default value: none.
 585
 586 repo.readme::
 587         A path (relative to <repo.path>) which specifies a file to include
 588         verbatim as the "About" page for this repo. You may also specify a
 589         git refspec by head or by hash by prepending the refspec followed by
 590         a colon. For example, "master:docs/readme.mkd". If the value begins
 591         with a colon, i.e. ":docs/readme.rst", the default branch of the
 592         repository will be used. Sharing any file will expose that entire
 593         directory tree to the "/about/PATH" endpoints, so be sure that there
 594         are no non-public files located in the same directory as the readme
 595         file. Default value: <readme>.
 596
 597 repo.snapshots::
 598         A mask of snapshot formats for this repo that cgit generates links for,
 599         restricted by the global "snapshots" setting. Default value:
 600         <snapshots>.
 601
 602 repo.section::
 603         Override the current section name for this repository. Default value:
 604         none.
 605
 606 repo.source-filter::
 607         Override the default source-filter. Default value: none. See also:
 608         "enable-filter-overrides". See also: "FILTER API".
 609
 610 repo.url::
 611         The relative url used to access the repository. This must be the first
 612         setting specified for each repo. Default value: none.
 613
 614
 615 REPOSITORY-SPECIFIC CGITRC FILE
 616 -------------------------------
 617 When the option "scan-path" is used to auto-discover git repositories, cgit
 618 will try to parse the file "cgitrc" within any found repository. Such a
 619 repo-specific config file may contain any of the repo-specific options
 620 described above, except "repo.url" and "repo.path". Additionally, the "filter"
 621 options are only acknowledged in repo-specific config files when
 622 "enable-filter-overrides" is set to "1".
 623
 624 Note: the "repo." prefix is dropped from the option names in repo-specific
 625 config files, e.g. "repo.desc" becomes "desc".
 626
 627
 628 FILTER API
 629 ----------
 630 By default, filters are separate processes that are executed each time they
 631 are needed.  Alternative technologies may be used by prefixing the filter
 632 specification with the relevant string; available values are:
 633
 634 'exec:'::
 635         The default "one process per filter" mode.
 636
 637 'lua:'::
 638         Executes the script using a built-in Lua interpreter. The script is
 639         loaded once per execution of cgit, and may be called multiple times
 640         during cgit's lifetime, making it a good choice for repeated filters
 641         such as the 'email filter'. It responds to three functions:
 642
 643         'filter_open(argument1, argument2, argument3, ...)'::
 644                 This is called upon activation of the filter for a particular
 645                 set of data.
 646         'filter_write(buffer)'::
 647                 This is called whenever cgit writes data to the webpage.
 648         'filter_close()'::
 649                 This is called when the current filtering operation is
 650                 completed. It must return an integer value. Usually 0
 651                 indicates success.
 652
 653         Additionally, cgit exposes to the Lua the following built-in functions:
 654
 655         'html(str)'::
 656                 Writes 'str' to the webpage.
 657         'html_txt(str)'::
 658                 HTML escapes and writes 'str' to the webpage.
 659         'html_attr(str)'::
 660                 HTML escapes for an attribute and writes "str' to the webpage.
 661         'html_url_path(str)'::
 662                 URL escapes for a path and writes 'str' to the webpage.
 663         'html_url_arg(str)'::
 664                 URL escapes for an argument and writes 'str' to the webpage.
 665         'html_include(file)'::
 666                 Includes 'file' in webpage.
 667
 668
 669 Parameters are provided to filters as follows.
 670
 671 about filter::
 672         This filter is given a single parameter: the filename of the source
 673         file to filter. The filter can use the filename to determine (for
 674         example) the type of syntax to follow when formatting the readme file.
 675         The about text that is to be filtered is available on standard input
 676         and the filtered text is expected on standard output.
 677
 678 commit filter::
 679         This filter is given no arguments. The commit message text that is to
 680         be filtered is available on standard input and the filtered text is
 681         expected on standard output.
 682
 683 email filter::
 684         This filter is given two parameters: the email address of the relevant
 685         author and a string indicating the originating page. The filter will
 686         then receive the text string to format on standard input and is
 687         expected to write to standard output the formatted text to be included
 688         in the page.
 689
 690 owner filter::
 691         This filter is given no arguments.  The owner text is available on
 692         standard input and the filter is expected to write to standard
 693         output.  The output is included in the Owner column.
 694
 695 source filter::
 696         This filter is given a single parameter: the filename of the source
 697         file to filter. The filter can use the filename to determine (for
 698         example) the syntax highlighting mode. The contents of the source
 699         file that is to be filtered is available on standard input and the
 700         filtered contents is expected on standard output.
 701
 702 auth filter::
 703         The authentication filter receives 12 parameters:
 704           - filter action, explained below, which specifies which action the
 705             filter is called for
 706           - http cookie
 707           - http method
 708           - http referer
 709           - http path
 710           - http https flag
 711           - cgit repo
 712           - cgit page
 713           - cgit url
 714           - cgit login url
 715         When the filter action is "body", this filter must write to output the
 716         HTML for displaying the login form, which POSTs to the login url. When
 717         the filter action is "authenticate-cookie", this filter must validate
 718         the http cookie and return a 0 if it is invalid or 1 if it is invalid,
 719         in the exit code / close function. If the filter action is
 720         "authenticate-post", this filter receives POST'd parameters on
 721         standard input, and should write a complete CGI response, preferably
 722         with a 302 redirect, and write to output one or more "Set-Cookie"
 723         HTTP headers, each followed by a newline.
 724
 725         Please see `filters/simple-authentication.lua` for a clear example
 726         script that may be modified.
 727
 728
 729 All filters are handed the following environment variables:
 730
 731 - CGIT_REPO_URL (from repo.url)
 732 - CGIT_REPO_NAME (from repo.name)
 733 - CGIT_REPO_PATH (from repo.path)
 734 - CGIT_REPO_OWNER (from repo.owner)
 735 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
 736 - CGIT_REPO_SECTION (from repo.section)
 737 - CGIT_REPO_CLONE_URL (from repo.clone-url)
 738
 739 If a setting is not defined for a repository and the corresponding global
 740 setting is also not defined (if applicable), then the corresponding
 741 environment variable will be unset.
 742
 743
 744 MACRO EXPANSION
 745 ---------------
 746 The following cgitrc options support a simple macro expansion feature,
 747 where tokens prefixed with "$" are replaced with the value of a similarly
 748 named environment variable:
 749
 750 - cache-root
 751 - include
 752 - project-list
 753 - scan-path
 754
 755 Macro expansion will also happen on the content of $CGIT_CONFIG, if
 756 defined.
 757
 758 One usage of this feature is virtual hosting, which in its simplest form
 759 can be accomplished by adding the following line to /etc/cgitrc:
 760
 761         include=/etc/cgitrc.d/$HTTP_HOST
 762
 763 The following options are expanded during request processing, and support
 764 the environment variables defined in "FILTER API":
 765
 766 - clone-url
 767 - repo.clone-url
 768
 769
 770 CACHE
 771 ------
 772
 773 All cache ttl values are in minutes. Negative ttl values indicate that a page
 774 type will never expire, and thus the first time a URL is accessed, the result
 775 will be cached indefinitely, even if the underlying git repository changes.
 776 Conversely, when a ttl value is zero, the cache is disabled for that
 777 particular page type, and the page type is never cached.
 778
 779
 780 EXAMPLE CGITRC FILE
 781 -------------------
 782
 783 ....
 784 # Enable caching of up to 1000 output entries
 785 cache-size=1000
 786
 787
 788 # Specify some default clone urls using macro expansion
 789 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 790
 791 # Specify the css url
 792 css=/css/cgit.css
 793
 794
 795 # Show owner on index page
 796 enable-index-owner=1
 797
 798
 799 # Allow http transport git clone
 800 enable-http-clone=1
 801
 802
 803 # Show extra links for each repository on the index page
 804 enable-index-links=1
 805
 806
 807 # Enable blame page and create links to it from tree page
 808 enable-blame=1
 809
 810
 811 # Enable ASCII art commit history graph on the log pages
 812 enable-commit-graph=1
 813
 814
 815 # Show number of affected files per commit on the log pages
 816 enable-log-filecount=1
 817
 818
 819 # Show number of added/removed lines per commit on the log pages
 820 enable-log-linecount=1
 821
 822
 823 # Sort branches by date
 824 branch-sort=age
 825
 826
 827 # Add a cgit favicon
 828 favicon=/favicon.ico
 829
 830
 831 # Use a custom logo
 832 logo=/img/mylogo.png
 833
 834
 835 # Enable statistics per week, month and quarter
 836 max-stats=quarter
 837
 838
 839 # Set the title and heading of the repository index page
 840 root-title=example.com git repositories
 841
 842
 843 # Set a subheading for the repository index page
 844 root-desc=tracking the foobar development
 845
 846
 847 # Include some more info about example.com on the index page
 848 root-readme=/var/www/htdocs/about.html
 849
 850
 851 # Allow download of tar.gz, tar.bz2 and zip-files
 852 snapshots=tar.gz tar.bz2 zip
 853
 854
 855 ##
 856 ## List of common mimetypes
 857 ##
 858
 859 mimetype.gif=image/gif
 860 mimetype.html=text/html
 861 mimetype.jpg=image/jpeg
 862 mimetype.jpeg=image/jpeg
 863 mimetype.pdf=application/pdf
 864 mimetype.png=image/png
 865 mimetype.svg=image/svg+xml
 866
 867
 868 # Highlight source code with python pygments-based highlighter
 869 source-filter=/var/www/cgit/filters/syntax-highlighting.py
 870
 871 # Format markdown, restructuredtext, manpages, text files, and html files
 872 # through the right converters
 873 about-filter=/var/www/cgit/filters/about-formatting.sh
 874
 875 ##
 876 ## Search for these files in the root of the default branch of repositories
 877 ## for coming up with the about page:
 878 ##
 879 readme=:README.md
 880 readme=:readme.md
 881 readme=:README.mkd
 882 readme=:readme.mkd
 883 readme=:README.rst
 884 readme=:readme.rst
 885 readme=:README.html
 886 readme=:readme.html
 887 readme=:README.htm
 888 readme=:readme.htm
 889 readme=:README.txt
 890 readme=:readme.txt
 891 readme=:README
 892 readme=:readme
 893 readme=:INSTALL.md
 894 readme=:install.md
 895 readme=:INSTALL.mkd
 896 readme=:install.mkd
 897 readme=:INSTALL.rst
 898 readme=:install.rst
 899 readme=:INSTALL.html
 900 readme=:install.html
 901 readme=:INSTALL.htm
 902 readme=:install.htm
 903 readme=:INSTALL.txt
 904 readme=:install.txt
 905 readme=:INSTALL
 906 readme=:install
 907
 908
 909 ##
 910 ## List of repositories.
 911 ## PS: Any repositories listed when section is unset will not be
 912 ##     displayed under a section heading
 913 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 914 ##      and included like this:
 915 ##        include=/etc/cgitrepos
 916 ##
 917
 918
 919 repo.url=foo
 920 repo.path=/pub/git/foo.git
 921 repo.desc=the master foo repository
 922 repo.owner=fooman@example.com
 923 repo.readme=info/web/about.html
 924
 925
 926 repo.url=bar
 927 repo.path=/pub/git/bar.git
 928 repo.desc=the bars for your foo
 929 repo.owner=barman@example.com
 930 repo.readme=info/web/about.html
 931
 932
 933 # The next repositories will be displayed under the 'extras' heading
 934 section=extras
 935
 936
 937 repo.url=baz
 938 repo.path=/pub/git/baz.git
 939 repo.desc=a set of extensions for bar users
 940
 941 repo.url=wiz
 942 repo.path=/pub/git/wiz.git
 943 repo.desc=the wizard of foo
 944
 945
 946 # Add some mirrored repositories
 947 section=mirrors
 948
 949
 950 repo.url=git
 951 repo.path=/pub/git/git.git
 952 repo.desc=the dscm
 953
 954
 955 repo.url=linux
 956 repo.path=/pub/git/linux.git
 957 repo.desc=the kernel
 958
 959 # Disable adhoc downloads of this repo
 960 repo.snapshots=0
 961
 962 # Disable line-counts for this repo
 963 repo.enable-log-linecount=0
 964
 965 # Restrict the max statistics period for this repo
 966 repo.max-stats=month
 967 ....
 968
 969
 970 BUGS
 971 ----
 972 Comments currently cannot appear on the same line as a setting; the comment
 973 will be included as part of the value. E.g. this line:
 974
 975         robots=index  # allow indexing
 976
 977 will generate the following html element:
 978
 979         <meta name='robots' content='index  # allow indexing'/>
 980
 981
 982
 983 AUTHOR
 984 ------
 985 Lars Hjemli <hjemli@gmail.com>
 986 Jason A. Donenfeld <Jason@zx2c4.com>