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