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