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