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, and the STDOUT from the
  33         command will be included verbatim on the about page. Default value:
  34         none. See also: "FILTER API".
  35
  36 agefile::
  37         Specifies a path, relative to each repository path, which can be used
  38         to specify the date and time of the youngest commit in the repository.
  39         The first line in the file is used as input to the "parse_date"
  40         function in libgit. Recommended timestamp-format is "yyyy-mm-dd
  41         hh:mm:ss". Default value: "info/web/last-modified".
  42
  43 cache-root::
  44         Path used to store the cgit cache entries. Default value:
  45         "/var/cache/cgit". See also: "MACRO EXPANSION".
  46
  47 cache-dynamic-ttl::
  48         Number which specifies the time-to-live, in minutes, for the cached
  49         version of repository pages accessed without a fixed SHA1. Default
  50         value: "5".
  51
  52 cache-repo-ttl::
  53         Number which specifies the time-to-live, in minutes, for the cached
  54         version of the repository summary page. Default value: "5".
  55
  56 cache-root-ttl::
  57         Number which specifies the time-to-live, in minutes, for the cached
  58         version of the repository index page. Default value: "5".
  59
  60 cache-scanrc-ttl::
  61         Number which specifies the time-to-live, in minutes, for the result
  62         of scanning a path for git repositories. Default value: "15".
  63
  64 cache-size::
  65         The maximum number of entries in the cgit cache. Default value: "0"
  66         (i.e. caching is disabled).
  67
  68 cache-static-ttl::
  69         Number which specifies the time-to-live, in minutes, for the cached
  70         version of repository pages accessed with a fixed SHA1. Default value:
  71         "5".
  72
  73 clone-prefix::
  74         Space-separated list of common prefixes which, when combined with a
  75         repository url, generates valid clone urls for the repository. This
  76         setting is only used if `repo.clone-url` is unspecified. Default value:
  77         none.
  78
  79 clone-url::
  80         Space-separated list of clone-url templates. This setting is only
  81         used if `repo.clone-url` is unspecified. Default value: none. See
  82         also: "MACRO EXPANSION", "FILTER API".
  83
  84 commit-filter::
  85         Specifies a command which will be invoked to format commit messages.
  86         The command will get the message on its STDIN, and the STDOUT from the
  87         command will be included verbatim as the commit message, i.e. this can
  88         be used to implement bugtracker integration. Default value: none.
  89         See also: "FILTER API".
  90
  91 css::
  92         Url which specifies the css document to include in all cgit pages.
  93         Default value: "/cgit.css".
  94
  95 embedded::
  96         Flag which, when set to "1", will make cgit generate a html fragment
  97         suitable for embedding in other html pages. Default value: none. See
  98         also: "noheader".
  99
 100 enable-commit-graph::
 101         Flag which, when set to "1", will make cgit print an ASCII-art commit
 102         history graph to the left of the commit messages in the repository
 103         log page. Default value: "0".
 104
 105 enable-filter-overrides::
 106         Flag which, when set to "1", allows all filter settings to be
 107         overridden in repository-specific cgitrc files. Default value: none.
 108
 109 enable-gitweb-owner::
 110         If set to "1" and scan-path is enabled, we first check each repository
 111         for the git config value "gitweb.owner" to determine the owner.
 112         Default value: "1". See also: scan-path.
 113
 114 enable-http-clone::
 115         If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
 116         If you use an alternate way of serving git repositories, you may wish
 117         to disable this. Default value: "1".
 118
 119 enable-index-links::
 120         Flag which, when set to "1", will make cgit generate extra links for
 121         each repo in the repository index (specifically, to the "summary",
 122         "commit" and "tree" pages). Default value: "0".
 123
 124 enable-log-filecount::
 125         Flag which, when set to "1", will make cgit print the number of
 126         modified files for each commit on the repository log page. Default
 127         value: "0".
 128
 129 enable-log-linecount::
 130         Flag which, when set to "1", will make cgit print the number of added
 131         and removed lines for each commit on the repository log page. Default
 132         value: "0".
 133
 134 enable-remote-branches::
 135         Flag which, when set to "1", will make cgit display remote branches
 136         in the summary and refs views. Default value: "0". See also:
 137         "repo.enable-remote-branches".
 138
 139 enable-subject-links::
 140         Flag which, when set to "1", will make cgit use the subject of the
 141         parent commit as link text when generating links to parent commits
 142         in commit view. Default value: "0". See also:
 143         "repo.enable-subject-links".
 144
 145 enable-tree-linenumbers::
 146         Flag which, when set to "1", will make cgit generate linenumber links
 147         for plaintext blobs printed in the tree view. Default value: "1".
 148
 149 favicon::
 150         Url used as link to a shortcut icon for cgit. If specified, it is
 151         suggested to use the value "/favicon.ico" since certain browsers will
 152         ignore other values. Default value: none.
 153
 154 footer::
 155         The content of the file specified with this option will be included
 156         verbatim at the bottom of all pages (i.e. it replaces the standard
 157         "generated by..." message. Default value: none.
 158
 159 head-include::
 160         The content of the file specified with this option will be included
 161         verbatim in the html HEAD section on all pages. Default value: none.
 162
 163 header::
 164         The content of the file specified with this option will be included
 165         verbatim at the top of all pages. Default value: none.
 166
 167 include::
 168         Name of a configfile to include before the rest of the current config-
 169         file is parsed. Default value: none. See also: "MACRO EXPANSION".
 170
 171 index-header::
 172         The content of the file specified with this option will be included
 173         verbatim above the repository index. This setting is deprecated, and
 174         will not be supported by cgit-1.0 (use root-readme instead). Default
 175         value: none.
 176
 177 index-info::
 178         The content of the file specified with this option will be included
 179         verbatim below the heading on the repository index page. This setting
 180         is deprecated, and will not be supported by cgit-1.0 (use root-desc
 181         instead). Default value: none.
 182
 183 local-time::
 184         Flag which, if set to "1", makes cgit print commit and tag times in the
 185         servers timezone. Default value: "0".
 186
 187 logo::
 188         Url which specifies the source of an image which will be used as a logo
 189         on all cgit pages. Default value: "/cgit.png".
 190
 191 logo-link::
 192         Url loaded when clicking on the cgit logo image. If unspecified the
 193         calculated url of the repository index page will be used. Default
 194         value: none.
 195
 196 max-atom-items::
 197         Specifies the number of items to display in atom feeds view. Default
 198         value: "10".
 199
 200 max-commit-count::
 201         Specifies the number of entries to list per page in "log" view. Default
 202         value: "50".
 203
 204 max-message-length::
 205         Specifies the maximum number of commit message characters to display in
 206         "log" view. Default value: "80".
 207
 208 max-repo-count::
 209         Specifies the number of entries to list per page on the repository
 210         index page. Default value: "50".
 211
 212 max-repodesc-length::
 213         Specifies the maximum number of repo description characters to display
 214         on the repository index page. Default value: "80".
 215
 216 max-blob-size::
 217         Specifies the maximum size of a blob to display HTML for in KBytes.
 218         Default value: "0" (limit disabled).
 219
 220 max-stats::
 221         Set the default maximum statistics period. Valid values are "week",
 222         "month", "quarter" and "year". If unspecified, statistics are
 223         disabled. Default value: none. See also: "repo.max-stats".
 224
 225 mimetype.<ext>::
 226         Set the mimetype for the specified filename extension. This is used
 227         by the `plain` command when returning blob content.
 228
 229 module-link::
 230         Text which will be used as the formatstring for a hyperlink when a
 231         submodule is printed in a directory listing. The arguments for the
 232         formatstring are the path and SHA1 of the submodule commit. Default
 233         value: "./?repo=%s&page=commit&id=%s"
 234
 235 nocache::
 236         If set to the value "1" caching will be disabled. This settings is
 237         deprecated, and will not be honored starting with cgit-1.0. Default
 238         value: "0".
 239
 240 noplainemail::
 241         If set to "1" showing full author email adresses will be disabled.
 242         Default value: "0".
 243
 244 noheader::
 245         Flag which, when set to "1", will make cgit omit the standard header
 246         on all pages. Default value: none. See also: "embedded".
 247
 248 project-list::
 249         A list of subdirectories inside of scan-path, relative to it, that
 250         should loaded as git repositories. This must be defined prior to
 251         scan-path. Default value: none. See also: scan-path, "MACRO
 252         EXPANSION".
 253
 254 readme::
 255         Text which will be used as default value for "repo.readme". Default
 256         value: none.
 257
 258 remove-suffix::
 259         If set to "1" and scan-path is enabled, if any repositories are found
 260         with a suffix of ".git", this suffix will be removed for the url and
 261         name. Default value: "0". See also: scan-path.
 262
 263 renamelimit::
 264         Maximum number of files to consider when detecting renames. The value
 265          "-1" uses the compiletime value in git (for further info, look at
 266           `man git-diff`). Default value: "-1".
 267
 268 repo.group::
 269         Legacy alias for "section". This option is deprecated and will not be
 270         supported in cgit-1.0.
 271
 272 robots::
 273         Text used as content for the "robots" meta-tag. Default value:
 274         "index, nofollow".
 275
 276 root-desc::
 277         Text printed below the heading on the repository index page. Default
 278         value: "a fast webinterface for the git dscm".
 279
 280 root-readme::
 281         The content of the file specified with this option will be included
 282         verbatim below the "about" link on the repository index page. Default
 283         value: none.
 284
 285 root-title::
 286         Text printed as heading on the repository index page. Default value:
 287         "Git Repository Browser".
 288
 289 scan-hidden-path::
 290         If set to "1" and scan-path is enabled, scan-path will recurse into
 291         directories whose name starts with a period ('.'). Otherwise,
 292         scan-path will stay away from such directories (considered as
 293         "hidden"). Note that this does not apply to the ".git" directory in
 294         non-bare repos. This must be defined prior to scan-path.
 295         Default value: 0. See also: scan-path.
 296
 297 scan-path::
 298         A path which will be scanned for repositories. If caching is enabled,
 299         the result will be cached as a cgitrc include-file in the cache
 300         directory. If project-list has been defined prior to scan-path,
 301         scan-path loads only the directories listed in the file pointed to by
 302         project-list. Be advised that only the global settings taken
 303         before the scan-path directive will be applied to each repository.
 304         Default value: none. See also: cache-scanrc-ttl, project-list,
 305         "MACRO EXPANSION".
 306
 307 section::
 308         The name of the current repository section - all repositories defined
 309         after this option will inherit the current section name. Default value:
 310         none.
 311
 312 section-from-path::
 313         A number which, if specified before scan-path, specifies how many
 314         path elements from each repo path to use as a default section name.
 315         If negative, cgit will discard the specified number of path elements
 316         above the repo directory. Default value: 0.
 317
 318 side-by-side-diffs::
 319         If set to "1" shows side-by-side diffs instead of unidiffs per
 320         default. Default value: "0".
 321
 322 snapshots::
 323         Text which specifies the default set of snapshot formats generated by
 324         cgit. The value is a space-separated list of zero or more of the
 325         values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
 326         none.
 327
 328 source-filter::
 329         Specifies a command which will be invoked to format plaintext blobs
 330         in the tree view. The command will get the blob content on its STDIN
 331         and the name of the blob as its only command line argument. The STDOUT
 332         from the command will be included verbatim as the blob contents, i.e.
 333         this can be used to implement e.g. syntax highlighting. Default value:
 334         none. See also: "FILTER API".
 335
 336 summary-branches::
 337         Specifies the number of branches to display in the repository "summary"
 338         view. Default value: "10".
 339
 340 summary-log::
 341         Specifies the number of log entries to display in the repository
 342         "summary" view. Default value: "10".
 343
 344 summary-tags::
 345         Specifies the number of tags to display in the repository "summary"
 346         view. Default value: "10".
 347
 348 strict-export::
 349         Filename which, if specified, needs to be present within the repository
 350         for cgit to allow access to that repository. This can be used to emulate
 351         gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
 352         repositories to match those exported by git-daemon. This option MUST come
 353         before 'scan-path'.
 354
 355 virtual-root::
 356         Url which, if specified, will be used as root for all cgit links. It
 357         will also cause cgit to generate 'virtual urls', i.e. urls like
 358         '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
 359         value: none.
 360         NOTE: cgit has recently learned how to use PATH_INFO to achieve the
 361         same kind of virtual urls, so this option will probably be deprecated.
 362
 363 REPOSITORY SETTINGS
 364 -------------------
 365 repo.about-filter::
 366         Override the default about-filter. Default value: none. See also:
 367         "enable-filter-overrides". See also: "FILTER API".
 368
 369 repo.clone-url::
 370         A list of space-separated urls which can be used to clone this repo.
 371         Default value: none. See also: "MACRO EXPANSION".
 372
 373 repo.commit-filter::
 374         Override the default commit-filter. Default value: none. See also:
 375         "enable-filter-overrides". See also: "FILTER API".
 376
 377 repo.defbranch::
 378         The name of the default branch for this repository. If no such branch
 379         exists in the repository, the first branch name (when sorted) is used
 380         as default instead. Default value: "master".
 381
 382 repo.desc::
 383         The value to show as repository description. Default value: none.
 384
 385 repo.enable-commit-graph::
 386         A flag which can be used to disable the global setting
 387         `enable-commit-graph'. Default value: none.
 388
 389 repo.enable-log-filecount::
 390         A flag which can be used to disable the global setting
 391         `enable-log-filecount'. Default value: none.
 392
 393 repo.enable-log-linecount::
 394         A flag which can be used to disable the global setting
 395         `enable-log-linecount'. Default value: none.
 396
 397 repo.enable-remote-branches::
 398         Flag which, when set to "1", will make cgit display remote branches
 399         in the summary and refs views. Default value: <enable-remote-branches>.
 400
 401 repo.enable-subject-links::
 402         A flag which can be used to override the global setting
 403         `enable-subject-links'. Default value: none.
 404
 405 repo.logo::
 406         Url which specifies the source of an image which will be used as a logo
 407         on this repo's pages. Default value: global logo.
 408
 409 repo.logo-link::
 410         Url loaded when clicking on the cgit logo image. If unspecified the
 411         calculated url of the repository index page will be used. Default
 412         value: global logo-link.
 413
 414 repo.module-link::
 415         Text which will be used as the formatstring for a hyperlink when a
 416         submodule is printed in a directory listing. The arguments for the
 417         formatstring are the path and SHA1 of the submodule commit. Default
 418         value: <module-link>
 419
 420 repo.max-stats::
 421         Override the default maximum statistics period. Valid values are equal
 422         to the values specified for the global "max-stats" setting. Default
 423         value: none.
 424
 425 repo.name::
 426         The value to show as repository name. Default value: <repo.url>.
 427
 428 repo.owner::
 429         A value used to identify the owner of the repository. Default value:
 430         none.
 431
 432 repo.path::
 433         An absolute path to the repository directory. For non-bare repositories
 434         this is the .git-directory. Default value: none.
 435
 436 repo.readme::
 437         A path (relative to <repo.path>) which specifies a file to include
 438         verbatim as the "About" page for this repo. You may also specify a
 439         git refspec by head or by hash by prepending the refspec followed by
 440         a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
 441
 442 repo.snapshots::
 443         A mask of allowed snapshot-formats for this repo, restricted by the
 444         "snapshots" global setting. Default value: <snapshots>.
 445
 446 repo.section::
 447         Override the current section name for this repository. Default value:
 448         none.
 449
 450 repo.source-filter::
 451         Override the default source-filter. Default value: none. See also:
 452         "enable-filter-overrides". See also: "FILTER API".
 453
 454 repo.url::
 455         The relative url used to access the repository. This must be the first
 456         setting specified for each repo. Default value: none.
 457
 458
 459 REPOSITORY-SPECIFIC CGITRC FILE
 460 -------------------------------
 461 When the option "scan-path" is used to auto-discover git repositories, cgit
 462 will try to parse the file "cgitrc" within any found repository. Such a
 463 repo-specific config file may contain any of the repo-specific options
 464 described above, except "repo.url" and "repo.path". Additionally, the "filter"
 465 options are only acknowledged in repo-specific config files when
 466 "enable-filter-overrides" is set to "1".
 467
 468 Note: the "repo." prefix is dropped from the option names in repo-specific
 469 config files, e.g. "repo.desc" becomes "desc".
 470
 471
 472 FILTER API
 473 ----------
 474 about filter::
 475         This filter is given no arguments. The about text that is to be
 476         filtered is available on standard input and the filtered text is
 477         expected on standard output.
 478
 479 commit filter::
 480         This filter is given no arguments. The commit message text that is to
 481         be filtered is available on standard input and the filtered text is
 482         expected on standard output.
 483
 484 source filter::
 485         This filter is given a single parameter: the filename of the source
 486         file to filter. The filter can use the filename to determine (for
 487         example) the syntax highlighting mode. The contents of the source
 488         file that is to be filtered is available on standard input and the
 489         filtered contents is expected on standard output.
 490
 491 Also, all filters are handed the following environment variables:
 492
 493 - CGIT_REPO_URL (from repo.url)
 494 - CGIT_REPO_NAME (from repo.name)
 495 - CGIT_REPO_PATH (from repo.path)
 496 - CGIT_REPO_OWNER (from repo.owner)
 497 - CGIT_REPO_DEFBRANCH (from repo.defbranch)
 498 - CGIT_REPO_SECTION (from repo.section)
 499 - CGIT_REPO_CLONE_URL (from repo.clone-url)
 500
 501 If a setting is not defined for a repository and the corresponding global
 502 setting is also not defined (if applicable), then the corresponding
 503 environment variable will be unset.
 504
 505
 506 MACRO EXPANSION
 507 ---------------
 508 The following cgitrc options supports a simple macro expansion feature,
 509 where tokens prefixed with "$" are replaced with the value of a similary
 510 named environment variable:
 511
 512 - cache-root
 513 - include
 514 - project-list
 515 - scan-path
 516
 517 Macro expansion will also happen on the content of $CGIT_CONFIG, if
 518 defined.
 519
 520 One usage of this feature is virtual hosting, which in its simplest form
 521 can be accomplished by adding the following line to /etc/cgitrc:
 522
 523         include=/etc/cgitrc.d/$HTTP_HOST
 524
 525 The following options are expanded during request processing, and support
 526 the environment variables defined in "FILTER API":
 527
 528 - clone-url
 529 - repo.clone-url
 530
 531
 532 EXAMPLE CGITRC FILE
 533 -------------------
 534
 535 ....
 536 # Enable caching of up to 1000 output entriess
 537 cache-size=1000
 538
 539
 540 # Specify some default clone urls using macro expansion
 541 clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 542
 543 # Specify the css url
 544 css=/css/cgit.css
 545
 546
 547 # Show extra links for each repository on the index page
 548 enable-index-links=1
 549
 550
 551 # Enable ASCII art commit history graph on the log pages
 552 enable-commit-graph=1
 553
 554
 555 # Show number of affected files per commit on the log pages
 556 enable-log-filecount=1
 557
 558
 559 # Show number of added/removed lines per commit on the log pages
 560 enable-log-linecount=1
 561
 562
 563 # Add a cgit favicon
 564 favicon=/favicon.ico
 565
 566
 567 # Use a custom logo
 568 logo=/img/mylogo.png
 569
 570
 571 # Enable statistics per week, month and quarter
 572 max-stats=quarter
 573
 574
 575 # Set the title and heading of the repository index page
 576 root-title=example.com git repositories
 577
 578
 579 # Set a subheading for the repository index page
 580 root-desc=tracking the foobar development
 581
 582
 583 # Include some more info about example.com on the index page
 584 root-readme=/var/www/htdocs/about.html
 585
 586
 587 # Allow download of tar.gz, tar.bz2 and zip-files
 588 snapshots=tar.gz tar.bz2 zip
 589
 590
 591 ##
 592 ## List of common mimetypes
 593 ##
 594
 595 mimetype.gif=image/gif
 596 mimetype.html=text/html
 597 mimetype.jpg=image/jpeg
 598 mimetype.jpeg=image/jpeg
 599 mimetype.pdf=application/pdf
 600 mimetype.png=image/png
 601 mimetype.svg=image/svg+xml
 602
 603
 604 ##
 605 ## List of repositories.
 606 ## PS: Any repositories listed when section is unset will not be
 607 ##     displayed under a section heading
 608 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 609 ##      and included like this:
 610 ##        include=/etc/cgitrepos
 611 ##
 612
 613
 614 repo.url=foo
 615 repo.path=/pub/git/foo.git
 616 repo.desc=the master foo repository
 617 repo.owner=fooman@example.com
 618 repo.readme=info/web/about.html
 619
 620
 621 repo.url=bar
 622 repo.path=/pub/git/bar.git
 623 repo.desc=the bars for your foo
 624 repo.owner=barman@example.com
 625 repo.readme=info/web/about.html
 626
 627
 628 # The next repositories will be displayed under the 'extras' heading
 629 section=extras
 630
 631
 632 repo.url=baz
 633 repo.path=/pub/git/baz.git
 634 repo.desc=a set of extensions for bar users
 635
 636 repo.url=wiz
 637 repo.path=/pub/git/wiz.git
 638 repo.desc=the wizard of foo
 639
 640
 641 # Add some mirrored repositories
 642 section=mirrors
 643
 644
 645 repo.url=git
 646 repo.path=/pub/git/git.git
 647 repo.desc=the dscm
 648
 649
 650 repo.url=linux
 651 repo.path=/pub/git/linux.git
 652 repo.desc=the kernel
 653
 654 # Disable adhoc downloads of this repo
 655 repo.snapshots=0
 656
 657 # Disable line-counts for this repo
 658 repo.enable-log-linecount=0
 659
 660 # Restrict the max statistics period for this repo
 661 repo.max-stats=month
 662 ....
 663
 664
 665 BUGS
 666 ----
 667 Comments currently cannot appear on the same line as a setting; the comment
 668 will be included as part of the value. E.g. this line:
 669
 670         robots=index  # allow indexing
 671
 672 will generate the following html element:
 673
 674         <meta name='robots' content='index  # allow indexing'/>
 675
 676
 677
 678 AUTHOR
 679 ------
 680 Lars Hjemli <hjemli@gmail.com>
 681 Jason A. Donenfeld <Jason@zx2c4.com>