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