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.logo::
 513         Url which specifies the source of an image which will be used as a logo
 514         on this repo's pages. Default value: global logo.
 515
 516 repo.logo-link::
 517         Url loaded when clicking on the cgit logo image. If unspecified the
 518         calculated url of the repository index page will be used. Default
 519         value: global logo-link.
 520
 521 repo.owner-filter::
 522         Override the default owner-filter. Default value: none. See also:
 523         "enable-filter-overrides". See also: "FILTER API".
 524
 525 repo.module-link::
 526         Text which will be used as the formatstring for a hyperlink when a
 527         submodule is printed in a directory listing. The arguments for the
 528         formatstring are the path and SHA1 of the submodule commit. Default
 529         value: <module-link>
 530
 531 repo.module-link.<path>::
 532         Text which will be used as the formatstring for a hyperlink when a
 533         submodule with the specified subdirectory path is printed in a
 534         directory listing. The only argument for the formatstring is the SHA1
 535         of the submodule commit. Default value: none.
 536
 537 repo.max-stats::
 538         Override the default maximum statistics period. Valid values are equal
 539         to the values specified for the global "max-stats" setting. Default
 540         value: none.
 541
 542 repo.name::
 543         The value to show as repository name. Default value: <repo.url>.
 544
 545 repo.owner::
 546         A value used to identify the owner of the repository. Default value:
 547         none.
 548
 549 repo.path::
 550         An absolute path to the repository directory. For non-bare repositories
 551         this is the .git-directory. Default value: none.
 552
 553 repo.readme::
 554         A path (relative to <repo.path>) which specifies a file to include
 555         verbatim as the "About" page for this repo. You may also specify a
 556         git refspec by head or by hash by prepending the refspec followed by
 557         a colon. For example, "master:docs/readme.mkd". If the value begins
 558         with a colon, i.e. ":docs/readme.rst", the default branch of the
 559         repository will be used. Sharing any file will expose that entire
 560         directory tree to the "/about/PATH" endpoints, so be sure that there
 561         are no non-public files located in the same directory as the readme
 562         file. Default value: <readme>.
 563
 564 repo.snapshots::
 565         A mask of snapshot formats for this repo that cgit generates links for,
 566         restricted by the global "snapshots" setting. Default value:
 567         <snapshots>.
 568
 569 repo.section::
 570         Override the current section name for this repository. Default value:
 571         none.
 572
 573 repo.source-filter::
 574         Override the default source-filter. Default value: none. See also:
 575         "enable-filter-overrides". See also: "FILTER API".
 576
 577 repo.url::
 578         The relative url used to access the repository. This must be the first
 579         setting specified for each repo. Default value: none.
 580
 581
 582 REPOSITORY-SPECIFIC CGITRC FILE
 583 -------------------------------
 584 When the option "scan-path" is used to auto-discover git repositories, cgit
 585 will try to parse the file "cgitrc" within any found repository. Such a
 586 repo-specific config file may contain any of the repo-specific options
 587 described above, except "repo.url" and "repo.path". Additionally, the "filter"
 588 options are only acknowledged in repo-specific config files when
 589 "enable-filter-overrides" is set to "1".
 590
 591 Note: the "repo." prefix is dropped from the option names in repo-specific
 592 config files, e.g. "repo.desc" becomes "desc".
 593
 594
 595 FILTER API
 596 ----------
 597 By default, filters are separate processes that are executed each time they
 598 are needed.  Alternative technologies may be used by prefixing the filter
 599 specification with the relevant string; available values are:
 600
 601 'exec:'::
 602         The default "one process per filter" mode.
 603
 604 'lua:'::
 605         Executes the script using a built-in Lua interpreter. The script is
 606         loaded once per execution of cgit, and may be called multiple times
 607         during cgit's lifetime, making it a good choice for repeated filters
 608         such as the 'email filter'. It responds to three functions:
 609
 610         'filter_open(argument1, argument2, argument3, ...)'::
 611                 This is called upon activation of the filter for a particular
 612                 set of data.
 613         'filter_write(buffer)'::
 614                 This is called whenever cgit writes data to the webpage.
 615         'filter_close()'::
 616                 This is called when the current filtering operation is
 617                 completed. It must return an integer value. Usually 0
 618                 indicates success.
 619
 620         Additionally, cgit exposes to the Lua the following built-in functions:
 621
 622         'html(str)'::
 623                 Writes 'str' to the webpage.
 624         'html_txt(str)'::
 625                 HTML escapes and writes 'str' to the webpage.
 626         'html_attr(str)'::
 627                 HTML escapes for an attribute and writes "str' to the webpage.
 628         'html_url_path(str)'::
 629                 URL escapes for a path and writes 'str' to the webpage.
 630         'html_url_arg(str)'::
 631                 URL escapes for an argument and writes 'str' to the webpage.
 632         'html_include(file)'::
 633                 Includes 'file' in webpage.
 634
 635
 636 Parameters are provided to filters as follows.
 637
 638 about filter::
 639         This filter is given a single parameter: the filename of the source
 640         file to filter. The filter can use the filename to determine (for
 641         example) the type of syntax to follow when formatting the readme file.
 642         The about text that is to be filtered is available on standard input
 643         and the filtered text is expected on standard output.
 644
 645 commit filter::
 646         This filter is given no arguments. The commit message text that is to
 647         be filtered is available on standard input and the filtered text is
 648         expected on standard output.
 649
 650 email filter::
 651         This filter is given two parameters: the email address of the relevent
 652         author and a string indicating the originating page. The filter will
 653         then receive the text string to format on standard input and is
 654         expected to write to standard output the formatted text to be included
 655         in the page.
 656
 657 owner filter::
 658         This filter is given no arguments.  The owner text is avilable on
 659         standard input and the filter is expected to write to standard
 660         output.  The output is included in the Owner column.
 661
 662 source filter::
 663         This filter is given a single parameter: the filename of the source
 664         file to filter. The filter can use the filename to determine (for
 665         example) the syntax highlighting mode. The contents of the source
 666         file that is to be filtered is available on standard input and the
 667         filtered contents is expected on standard output.
 668
 669 auth filter::
 670         The authentication filter receives 12 parameters:
 671           - filter action, explained below, which specifies which action the
 672             filter is called for
 673           - http cookie
 674           - http method
 675           - http referer
 676           - http path
 677           - http https flag
 678           - cgit repo
 679           - cgit page
 680           - cgit url
 681           - cgit login url
 682         When the filter action is "body", this filter must write to output the
 683         HTML for displaying the login form, which POSTs to the login url. When
 684         the filter action is "authenticate-cookie", this filter must validate
 685         the http cookie and return a 0 if it is invalid or 1 if it is invalid,
 686         in the exit code / close function. If the filter action is
 687         "authenticate-post", this filter receives POST'd parameters on
 688         standard input, and should write a complete CGI response, preferably
 689         with a 302 redirect, and write to output one or more "Set-Cookie"
 690         HTTP headers, each followed by a newline.
 691
 692         Please see `filters/simple-authentication.lua` for a clear example
 693         script that may be modified.
 694
 695
 696 All filters are handed the following environment variables:
 697
 698 - CGIT_REPO_URL (from repo.url)
 699 - CGIT_REPO_NAME (from repo.name)
 700 - CGIT_REPO_PATH (from repo.path)
 701 - CGIT_REPO_OWNER (from repo.owner)
 702 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
 703 - CGIT_REPO_SECTION (from repo.section)
 704 - CGIT_REPO_CLONE_URL (from repo.clone-url)
 705
 706 If a setting is not defined for a repository and the corresponding global
 707 setting is also not defined (if applicable), then the corresponding
 708 environment variable will be unset.
 709
 710
 711 MACRO EXPANSION
 712 ---------------
 713 The following cgitrc options support a simple macro expansion feature,
 714 where tokens prefixed with "$" are replaced with the value of a similarly
 715 named environment variable:
 716
 717 - cache-root
 718 - include
 719 - project-list
 720 - scan-path
 721
 722 Macro expansion will also happen on the content of $CGIT_CONFIG, if
 723 defined.
 724
 725 One usage of this feature is virtual hosting, which in its simplest form
 726 can be accomplished by adding the following line to /etc/cgitrc:
 727
 728         include=/etc/cgitrc.d/$HTTP_HOST
 729
 730 The following options are expanded during request processing, and support
 731 the environment variables defined in "FILTER API":
 732
 733 - clone-url
 734 - repo.clone-url
 735
 736
 737 CACHE
 738 ------
 739
 740 All cache ttl values are in minutes. Negative ttl values indicate that a page
 741 type will never expire, and thus the first time a URL is accessed, the result
 742 will be cached indefinitely, even if the underlying git repository changes.
 743 Conversely, when a ttl value is zero, the cache is disabled for that
 744 particular page type, and the page type is never cached.
 745
 746
 747 EXAMPLE CGITRC FILE
 748 -------------------
 749
 750 ....
 751 # Enable caching of up to 1000 output entries
 752 cache-size=1000
 753
 754
 755 # Specify some default clone urls using macro expansion
 756 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 757
 758 # Specify the css url
 759 css=/css/cgit.css
 760
 761
 762 # Show owner on index page
 763 enable-index-owner=1
 764
 765
 766 # Allow http transport git clone
 767 enable-http-clone=1
 768
 769
 770 # Show extra links for each repository on the index page
 771 enable-index-links=1
 772
 773
 774 # Enable ASCII art commit history graph on the log pages
 775 enable-commit-graph=1
 776
 777
 778 # Show number of affected files per commit on the log pages
 779 enable-log-filecount=1
 780
 781
 782 # Show number of added/removed lines per commit on the log pages
 783 enable-log-linecount=1
 784
 785
 786 # Sort branches by date
 787 branch-sort=age
 788
 789
 790 # Add a cgit favicon
 791 favicon=/favicon.ico
 792
 793
 794 # Use a custom logo
 795 logo=/img/mylogo.png
 796
 797
 798 # Enable statistics per week, month and quarter
 799 max-stats=quarter
 800
 801
 802 # Set the title and heading of the repository index page
 803 root-title=example.com git repositories
 804
 805
 806 # Set a subheading for the repository index page
 807 root-desc=tracking the foobar development
 808
 809
 810 # Include some more info about example.com on the index page
 811 root-readme=/var/www/htdocs/about.html
 812
 813
 814 # Allow download of tar.gz, tar.bz2 and zip-files
 815 snapshots=tar.gz tar.bz2 zip
 816
 817
 818 ##
 819 ## List of common mimetypes
 820 ##
 821
 822 mimetype.gif=image/gif
 823 mimetype.html=text/html
 824 mimetype.jpg=image/jpeg
 825 mimetype.jpeg=image/jpeg
 826 mimetype.pdf=application/pdf
 827 mimetype.png=image/png
 828 mimetype.svg=image/svg+xml
 829
 830
 831 # Highlight source code with python pygments-based highlighter
 832 source-filter=/var/www/cgit/filters/syntax-highlighting.py
 833
 834 # Format markdown, restructuredtext, manpages, text files, and html files
 835 # through the right converters
 836 about-filter=/var/www/cgit/filters/about-formatting.sh
 837
 838 ##
 839 ## Search for these files in the root of the default branch of repositories
 840 ## for coming up with the about page:
 841 ##
 842 readme=:README.md
 843 readme=:readme.md
 844 readme=:README.mkd
 845 readme=:readme.mkd
 846 readme=:README.rst
 847 readme=:readme.rst
 848 readme=:README.html
 849 readme=:readme.html
 850 readme=:README.htm
 851 readme=:readme.htm
 852 readme=:README.txt
 853 readme=:readme.txt
 854 readme=:README
 855 readme=:readme
 856 readme=:INSTALL.md
 857 readme=:install.md
 858 readme=:INSTALL.mkd
 859 readme=:install.mkd
 860 readme=:INSTALL.rst
 861 readme=:install.rst
 862 readme=:INSTALL.html
 863 readme=:install.html
 864 readme=:INSTALL.htm
 865 readme=:install.htm
 866 readme=:INSTALL.txt
 867 readme=:install.txt
 868 readme=:INSTALL
 869 readme=:install
 870
 871
 872 ##
 873 ## List of repositories.
 874 ## PS: Any repositories listed when section is unset will not be
 875 ##     displayed under a section heading
 876 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 877 ##      and included like this:
 878 ##        include=/etc/cgitrepos
 879 ##
 880
 881
 882 repo.url=foo
 883 repo.path=/pub/git/foo.git
 884 repo.desc=the master foo repository
 885 repo.owner=fooman@example.com
 886 repo.readme=info/web/about.html
 887
 888
 889 repo.url=bar
 890 repo.path=/pub/git/bar.git
 891 repo.desc=the bars for your foo
 892 repo.owner=barman@example.com
 893 repo.readme=info/web/about.html
 894
 895
 896 # The next repositories will be displayed under the 'extras' heading
 897 section=extras
 898
 899
 900 repo.url=baz
 901 repo.path=/pub/git/baz.git
 902 repo.desc=a set of extensions for bar users
 903
 904 repo.url=wiz
 905 repo.path=/pub/git/wiz.git
 906 repo.desc=the wizard of foo
 907
 908
 909 # Add some mirrored repositories
 910 section=mirrors
 911
 912
 913 repo.url=git
 914 repo.path=/pub/git/git.git
 915 repo.desc=the dscm
 916
 917
 918 repo.url=linux
 919 repo.path=/pub/git/linux.git
 920 repo.desc=the kernel
 921
 922 # Disable adhoc downloads of this repo
 923 repo.snapshots=0
 924
 925 # Disable line-counts for this repo
 926 repo.enable-log-linecount=0
 927
 928 # Restrict the max statistics period for this repo
 929 repo.max-stats=month
 930 ....
 931
 932
 933 BUGS
 934 ----
 935 Comments currently cannot appear on the same line as a setting; the comment
 936 will be included as part of the value. E.g. this line:
 937
 938         robots=index  # allow indexing
 939
 940 will generate the following html element:
 941
 942         <meta name='robots' content='index  # allow indexing'/>
 943
 944
 945
 946 AUTHOR
 947 ------
 948 Lars Hjemli <hjemli@gmail.com>
 949 Jason A. Donenfeld <Jason@zx2c4.com>