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

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