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