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