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