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