gitweb.ps.run Git - ps-cgit/blob - cgitrc.5.txt

   1 CGITRC(5)
   2 ========
   3
   4
   5 NAME
   6 ----
   7 cgitrc - runtime configuration for cgit
   8
   9
  10 SYNOPSIS
  11 --------
  12 Cgitrc contains all runtime settings for cgit, including the list of git
  13 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
  14 lines, and lines starting with '#', are ignored.
  15
  16
  17 LOCATION
  18 --------
  19 The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
  20 runtime, cgit will consult the environment variable CGIT_CONFIG and, if
  21 defined, use its value instead.
  22
  23
  24 GLOBAL SETTINGS
  25 ---------------
  26 about-filter::
  27         Specifies a command which will be invoked to format the content of
  28         about pages (both top-level and for each repository). The command will
  29         get the content of the about-file on its STDIN, and the STDOUT from the
  30         command will be included verbatim on the about page. Default value:
  31         none.
  32
  33 agefile::
  34         Specifies a path, relative to each repository path, which can be used
  35         to specify the date and time of the youngest commit in the repository.
  36         The first line in the file is used as input to the "parse_date"
  37         function in libgit. Recommended timestamp-format is "yyyy-mm-dd
  38         hh:mm:ss". Default value: "info/web/last-modified".
  39
  40 cache-root::
  41         Path used to store the cgit cache entries. Default value:
  42         "/var/cache/cgit".
  43
  44 cache-dynamic-ttl::
  45         Number which specifies the time-to-live, in minutes, for the cached
  46         version of repository pages accessed without a fixed SHA1. Default
  47         value: "5".
  48
  49 cache-repo-ttl::
  50         Number which specifies the time-to-live, in minutes, for the cached
  51         version of the repository summary page. Default value: "5".
  52
  53 cache-root-ttl::
  54         Number which specifies the time-to-live, in minutes, for the cached
  55         version of the repository index page. Default value: "5".
  56
  57 cache-scanrc-ttl::
  58         Number which specifies the time-to-live, in minutes, for the result
  59         of scanning a path for git repositories. Default value: "15".
  60
  61 cache-size::
  62         The maximum number of entries in the cgit cache. Default value: "0"
  63         (i.e. caching is disabled).
  64
  65 cache-static-ttl::
  66         Number which specifies the time-to-live, in minutes, for the cached
  67         version of repository pages accessed with a fixed SHA1. Default value:
  68         "5".
  69
  70 clone-prefix::
  71         Space-separated list of common prefixes which, when combined with a
  72         repository url, generates valid clone urls for the repository. This
  73         setting is only used if `repo.clone-url` is unspecified. Default value:
  74         none.
  75
  76 commit-filter::
  77         Specifies a command which will be invoked to format commit messages.
  78         The command will get the message on its STDIN, and the STDOUT from the
  79         command will be included verbatim as the commit message, i.e. this can
  80         be used to implement bugtracker integration. Default value: none.
  81
  82 css::
  83         Url which specifies the css document to include in all cgit pages.
  84         Default value: "/cgit.css".
  85
  86 embedded::
  87         Flag which, when set to "1", will make cgit generate a html fragment
  88         suitable for embedding in other html pages. Default value: none. See
  89         also: "noheader".
  90
  91 enable-index-links::
  92         Flag which, when set to "1", will make cgit generate extra links for
  93         each repo in the repository index (specifically, to the "summary",
  94         "commit" and "tree" pages). Default value: "0".
  95
  96 enable-log-filecount::
  97         Flag which, when set to "1", will make cgit print the number of
  98         modified files for each commit on the repository log page. Default
  99         value: "0".
 100
 101 enable-log-linecount::
 102         Flag which, when set to "1", will make cgit print the number of added
 103         and removed lines for each commit on the repository log page. Default
 104         value: "0".
 105
 106 favicon::
 107         Url used as link to a shortcut icon for cgit. If specified, it is
 108         suggested to use the value "/favicon.ico" since certain browsers will
 109         ignore other values. Default value: none.
 110
 111 footer::
 112         The content of the file specified with this option will be included
 113         verbatim at the bottom of all pages (i.e. it replaces the standard
 114         "generated by..." message. Default value: none.
 115
 116 head-include::
 117         The content of the file specified with this option will be included
 118         verbatim in the html HEAD section on all pages. Default value: none.
 119
 120 header::
 121         The content of the file specified with this option will be included
 122         verbatim at the top of all pages. Default value: none.
 123
 124 include::
 125         Name of a configfile to include before the rest of the current config-
 126         file is parsed. Default value: none.
 127
 128 index-header::
 129         The content of the file specified with this option will be included
 130         verbatim above the repository index. This setting is deprecated, and
 131         will not be supported by cgit-1.0 (use root-readme instead). Default
 132         value: none.
 133
 134 index-info::
 135         The content of the file specified with this option will be included
 136         verbatim below the heading on the repository index page. This setting
 137         is deprecated, and will not be supported by cgit-1.0 (use root-desc
 138         instead). Default value: none.
 139
 140 local-time::
 141         Flag which, if set to "1", makes cgit print commit and tag times in the
 142         servers timezone. Default value: "0".
 143
 144 logo::
 145         Url which specifies the source of an image which will be used as a logo
 146         on all cgit pages. Default value: "/cgit.png".
 147
 148 logo-link::
 149         Url loaded when clicking on the cgit logo image. If unspecified the
 150         calculated url of the repository index page will be used. Default
 151         value: none.
 152
 153 max-commit-count::
 154         Specifies the number of entries to list per page in "log" view. Default
 155         value: "50".
 156
 157 max-message-length::
 158         Specifies the maximum number of commit message characters to display in
 159         "log" view. Default value: "80".
 160
 161 max-repo-count::
 162         Specifies the number of entries to list per page on the repository
 163         index page. Default value: "50".
 164
 165 max-repodesc-length::
 166         Specifies the maximum number of repo description characters to display
 167         on the repository index page. Default value: "80".
 168
 169 max-stats::
 170         Set the default maximum statistics period. Valid values are "week",
 171         "month", "quarter" and "year". If unspecified, statistics are
 172         disabled. Default value: none. See also: "repo.max-stats".
 173
 174 mimetype.<ext>::
 175         Set the mimetype for the specified filename extension. This is used
 176         by the `plain` command when returning blob content.
 177
 178 module-link::
 179         Text which will be used as the formatstring for a hyperlink when a
 180         submodule is printed in a directory listing. The arguments for the
 181         formatstring are the path and SHA1 of the submodule commit. Default
 182         value: "./?repo=%s&page=commit&id=%s"
 183
 184 nocache::
 185         If set to the value "1" caching will be disabled. This settings is
 186         deprecated, and will not be honored starting with cgit-1.0. Default
 187         value: "0".
 188
 189 noplainemail::
 190         If set to "1" showing full author email adresses will be disabled.
 191         Default value: "0".
 192
 193 noheader::
 194         Flag which, when set to "1", will make cgit omit the standard header
 195         on all pages. Default value: none. See also: "embedded".
 196
 197 renamelimit::
 198         Maximum number of files to consider when detecting renames. The value
 199          "-1" uses the compiletime value in git (for further info, look at
 200           `man git-diff`). Default value: "-1".
 201
 202 repo.group::
 203         Legacy alias for 'section' which will be deprecated starting with
 204         cgit-1.0.
 205
 206 robots::
 207         Text used as content for the "robots" meta-tag. Default value:
 208         "index, nofollow".
 209
 210 root-desc::
 211         Text printed below the heading on the repository index page. Default
 212         value: "a fast webinterface for the git dscm".
 213
 214 root-readme::
 215         The content of the file specified with this option will be included
 216         verbatim below the "about" link on the repository index page. Default
 217         value: none.
 218
 219 root-title::
 220         Text printed as heading on the repository index page. Default value:
 221         "Git Repository Browser".
 222
 223 scan-path::
 224         A path which will be scanned for repositories. If caching is enabled,
 225         the result will be cached as a cgitrc include-file in the cache
 226         directory. Default value: none. See also: cache-scanrc-ttl.
 227
 228 section:
 229         The name of the current repository section - all repositories defined
 230         after this option will inherit the current section name. Default value:
 231         none.
 232
 233 snapshots::
 234         Text which specifies the default set of snapshot formats generated by
 235         cgit. The value is a space-separated list of zero or more of the
 236         values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
 237
 238 source-filter::
 239         Specifies a command which will be invoked to format plaintext blobs
 240         in the tree view. The command will get the blob content on its STDIN
 241         and the name of the blob as its only command line argument. The STDOUT
 242         from the command will be included verbatim as the blob contents, i.e.
 243         this can be used to implement e.g. syntax highlighting. Default value:
 244         none.
 245
 246 summary-branches::
 247         Specifies the number of branches to display in the repository "summary"
 248         view. Default value: "10".
 249
 250 summary-log::
 251         Specifies the number of log entries to display in the repository
 252         "summary" view. Default value: "10".
 253
 254 summary-tags::
 255         Specifies the number of tags to display in the repository "summary"
 256         view. Default value: "10".
 257
 258 virtual-root::
 259         Url which, if specified, will be used as root for all cgit links. It
 260         will also cause cgit to generate 'virtual urls', i.e. urls like
 261         '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
 262         value: none.
 263         NOTE: cgit has recently learned how to use PATH_INFO to achieve the
 264         same kind of virtual urls, so this option will probably be deprecated.
 265
 266 REPOSITORY SETTINGS
 267 -------------------
 268 repo.about-filter::
 269         Override the default about-filter. Default value: <about-filter>.
 270
 271 repo.clone-url::
 272         A list of space-separated urls which can be used to clone this repo.
 273         Default value: none.
 274
 275 repo.commit-filter::
 276         Override the default commit-filter. Default value: <commit-filter>.
 277
 278 repo.defbranch::
 279         The name of the default branch for this repository. If no such branch
 280         exists in the repository, the first branch name (when sorted) is used
 281         as default instead. Default value: "master".
 282
 283 repo.desc::
 284         The value to show as repository description. Default value: none.
 285
 286 repo.enable-log-filecount::
 287         A flag which can be used to disable the global setting
 288         `enable-log-filecount'. Default value: none.
 289
 290 repo.enable-log-linecount::
 291         A flag which can be used to disable the global setting
 292         `enable-log-linecount'. Default value: none.
 293
 294 repo.max-stats::
 295         Override the default maximum statistics period. Valid values are equal
 296         to the values specified for the global "max-stats" setting. Default
 297         value: none.
 298
 299 repo.name::
 300         The value to show as repository name. Default value: <repo.url>.
 301
 302 repo.owner::
 303         A value used to identify the owner of the repository. Default value:
 304         none.
 305
 306 repo.path::
 307         An absolute path to the repository directory. For non-bare repositories
 308         this is the .git-directory. Default value: none.
 309
 310 repo.readme::
 311         A path (relative to <repo.path>) which specifies a file to include
 312         verbatim as the "About" page for this repo. Default value: none.
 313
 314 repo.snapshots::
 315         A mask of allowed snapshot-formats for this repo, restricted by the
 316         "snapshots" global setting. Default value: <snapshots>.
 317
 318 repo.section::
 319         Override the current section for this repository. Default value: none.
 320
 321 repo.source-filter::
 322         Override the default source-filter. Default value: <source-filter>.
 323
 324 repo.url::
 325         The relative url used to access the repository. This must be the first
 326         setting specified for each repo. Default value: none.
 327
 328
 329 EXAMPLE CGITRC FILE
 330 -------------------
 331
 332 ....
 333 # Enable caching of up to 1000 output entriess
 334 cache-size=1000
 335
 336
 337 # Specify some default clone prefixes
 338 clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
 339
 340 # Specify the css url
 341 css=/css/cgit.css
 342
 343
 344 # Show extra links for each repository on the index page
 345 enable-index-links=1
 346
 347
 348 # Show number of affected files per commit on the log pages
 349 enable-log-filecount=1
 350
 351
 352 # Show number of added/removed lines per commit on the log pages
 353 enable-log-linecount=1
 354
 355
 356 # Add a cgit favicon
 357 favicon=/favicon.ico
 358
 359
 360 # Use a custom logo
 361 logo=/img/mylogo.png
 362
 363
 364 # Enable statistics per week, month and quarter
 365 max-stats=quarter
 366
 367
 368 # Set the title and heading of the repository index page
 369 root-title=foobar.com git repositories
 370
 371
 372 # Set a subheading for the repository index page
 373 root-desc=tracking the foobar development
 374
 375
 376 # Include some more info about foobar.com on the index page
 377 root-readme=/var/www/htdocs/about.html
 378
 379
 380 # Allow download of tar.gz, tar.bz2 and zip-files
 381 snapshots=tar.gz tar.bz2 zip
 382
 383
 384 ##
 385 ## List of common mimetypes
 386 ##
 387
 388 mimetype.git=image/git
 389 mimetype.html=text/html
 390 mimetype.jpg=image/jpeg
 391 mimetype.jpeg=image/jpeg
 392 mimetype.pdf=application/pdf
 393 mimetype.png=image/png
 394 mimetype.svg=image/svg+xml
 395
 396
 397 ##
 398 ## List of repositories.
 399 ## PS: Any repositories listed when repo.group is unset will not be
 400 ##     displayed under a group heading
 401 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 402 ##      and included like this:
 403 ##        include=/etc/cgitrepos
 404 ##
 405
 406
 407 repo.url=foo
 408 repo.path=/pub/git/foo.git
 409 repo.desc=the master foo repository
 410 repo.owner=fooman@foobar.com
 411 repo.readme=info/web/about.html
 412
 413
 414 repo.url=bar
 415 repo.path=/pub/git/bar.git
 416 repo.desc=the bars for your foo
 417 repo.owner=barman@foobar.com
 418 repo.readme=info/web/about.html
 419
 420
 421 # The next repositories will be displayed under the 'extras' heading
 422 repo.group=extras
 423
 424
 425 repo.url=baz
 426 repo.path=/pub/git/baz.git
 427 repo.desc=a set of extensions for bar users
 428
 429 repo.url=wiz
 430 repo.path=/pub/git/wiz.git
 431 repo.desc=the wizard of foo
 432
 433
 434 # Add some mirrored repositories
 435 repo.group=mirrors
 436
 437
 438 repo.url=git
 439 repo.path=/pub/git/git.git
 440 repo.desc=the dscm
 441
 442
 443 repo.url=linux
 444 repo.path=/pub/git/linux.git
 445 repo.desc=the kernel
 446
 447 # Disable adhoc downloads of this repo
 448 repo.snapshots=0
 449
 450 # Disable line-counts for this repo
 451 repo.enable-log-linecount=0
 452
 453 # Restrict the max statistics period for this repo
 454 repo.max-stats=month
 455 ....
 456
 457
 458 BUGS
 459 ----
 460 Comments currently cannot appear on the same line as a setting; the comment
 461 will be included as part of the value. E.g. this line:
 462
 463         robots=index  # allow indexing
 464
 465 will generate the following html element:
 466
 467         <meta name='robots' content='index  # allow indexing'/>
 468
 469
 470
 471 AUTHOR
 472 ------
 473 Lars Hjemli <hjemli@gmail.com>