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