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