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