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