gitweb.ps.run Git - ps-cgit/blob - cgitrc.5.txt

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