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

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