summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt21
1 files changed, 16 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 46df291..617b7c3 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -43,96 +43,100 @@ cache-root::
43 43
44cache-dynamic-ttl:: 44cache-dynamic-ttl::
45 Number which specifies the time-to-live, in minutes, for the cached 45 Number which specifies the time-to-live, in minutes, for the cached
46 version of repository pages accessed without a fixed SHA1. Default 46 version of repository pages accessed without a fixed SHA1. Default
47 value: "5". 47 value: "5".
48 48
49cache-repo-ttl:: 49cache-repo-ttl::
50 Number which specifies the time-to-live, in minutes, for the cached 50 Number which specifies the time-to-live, in minutes, for the cached
51 version of the repository summary page. Default value: "5". 51 version of the repository summary page. Default value: "5".
52 52
53cache-root-ttl:: 53cache-root-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached 54 Number which specifies the time-to-live, in minutes, for the cached
55 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
56 56
57cache-scanrc-ttl:: 57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result 58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15". 59 of scanning a path for git repositories. Default value: "15".
60 60
61cache-size:: 61cache-size::
62 The maximum number of entries in the cgit cache. Default value: "0" 62 The maximum number of entries in the cgit cache. Default value: "0"
63 (i.e. caching is disabled). 63 (i.e. caching is disabled).
64 64
65cache-static-ttl:: 65cache-static-ttl::
66 Number which specifies the time-to-live, in minutes, for the cached 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: 67 version of repository pages accessed with a fixed SHA1. Default value:
68 "5". 68 "5".
69 69
70clone-prefix:: 70clone-prefix::
71 Space-separated list of common prefixes which, when combined with a 71 Space-separated list of common prefixes which, when combined with a
72 repository url, generates valid clone urls for the repository. This 72 repository url, generates valid clone urls for the repository. This
73 setting is only used if `repo.clone-url` is unspecified. Default value: 73 setting is only used if `repo.clone-url` is unspecified. Default value:
74 none. 74 none.
75 75
76commit-filter:: 76commit-filter::
77 Specifies a command which will be invoked to format commit messages. 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 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 79 command will be included verbatim as the commit message, i.e. this can
80 be used to implement bugtracker integration. Default value: none. 80 be used to implement bugtracker integration. Default value: none.
81 81
82css:: 82css::
83 Url which specifies the css document to include in all cgit pages. 83 Url which specifies the css document to include in all cgit pages.
84 Default value: "/cgit.css". 84 Default value: "/cgit.css".
85 85
86embedded:: 86embedded::
87 Flag which, when set to "1", will make cgit generate a html fragment 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 88 suitable for embedding in other html pages. Default value: none. See
89 also: "noheader". 89 also: "noheader".
90 90
91enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none.
94
91enable-index-links:: 95enable-index-links::
92 Flag which, when set to "1", will make cgit generate extra links for 96 Flag which, when set to "1", will make cgit generate extra links for
93 each repo in the repository index (specifically, to the "summary", 97 each repo in the repository index (specifically, to the "summary",
94 "commit" and "tree" pages). Default value: "0". 98 "commit" and "tree" pages). Default value: "0".
95 99
96enable-log-filecount:: 100enable-log-filecount::
97 Flag which, when set to "1", will make cgit print the number of 101 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 102 modified files for each commit on the repository log page. Default
99 value: "0". 103 value: "0".
100 104
101enable-log-linecount:: 105enable-log-linecount::
102 Flag which, when set to "1", will make cgit print the number of added 106 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 107 and removed lines for each commit on the repository log page. Default
104 value: "0". 108 value: "0".
105 109
106favicon:: 110favicon::
107 Url used as link to a shortcut icon for cgit. If specified, it is 111 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 112 suggested to use the value "/favicon.ico" since certain browsers will
109 ignore other values. Default value: none. 113 ignore other values. Default value: none.
110 114
111footer:: 115footer::
112 The content of the file specified with this option will be included 116 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 117 verbatim at the bottom of all pages (i.e. it replaces the standard
114 "generated by..." message. Default value: none. 118 "generated by..." message. Default value: none.
115 119
116head-include:: 120head-include::
117 The content of the file specified with this option will be included 121 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. 122 verbatim in the html HEAD section on all pages. Default value: none.
119 123
120header:: 124header::
121 The content of the file specified with this option will be included 125 The content of the file specified with this option will be included
122 verbatim at the top of all pages. Default value: none. 126 verbatim at the top of all pages. Default value: none.
123 127
124include:: 128include::
125 Name of a configfile to include before the rest of the current config- 129 Name of a configfile to include before the rest of the current config-
126 file is parsed. Default value: none. 130 file is parsed. Default value: none.
127 131
128index-header:: 132index-header::
129 The content of the file specified with this option will be included 133 The content of the file specified with this option will be included
130 verbatim above the repository index. This setting is deprecated, and 134 verbatim above the repository index. This setting is deprecated, and
131 will not be supported by cgit-1.0 (use root-readme instead). Default 135 will not be supported by cgit-1.0 (use root-readme instead). Default
132 value: none. 136 value: none.
133 137
134index-info:: 138index-info::
135 The content of the file specified with this option will be included 139 The content of the file specified with this option will be included
136 verbatim below the heading on the repository index page. This setting 140 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 141 is deprecated, and will not be supported by cgit-1.0 (use root-desc
138 instead). Default value: none. 142 instead). Default value: none.
@@ -221,164 +225,171 @@ root-title::
221 "Git Repository Browser". 225 "Git Repository Browser".
222 226
223scan-path:: 227scan-path::
224 A path which will be scanned for repositories. If caching is enabled, 228 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 229 the result will be cached as a cgitrc include-file in the cache
226 directory. Default value: none. See also: cache-scanrc-ttl. 230 directory. Default value: none. See also: cache-scanrc-ttl.
227 231
228section:: 232section::
229 The name of the current repository section - all repositories defined 233 The name of the current repository section - all repositories defined
230 after this option will inherit the current section name. Default value: 234 after this option will inherit the current section name. Default value:
231 none. 235 none.
232 236
233snapshots:: 237snapshots::
234 Text which specifies the default set of snapshot formats generated by 238 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 239 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. 240 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
237 241
238source-filter:: 242source-filter::
239 Specifies a command which will be invoked to format plaintext blobs 243 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 244 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 245 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. 246 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: 247 this can be used to implement e.g. syntax highlighting. Default value:
244 none. 248 none.
245 249
246summary-branches:: 250summary-branches::
247 Specifies the number of branches to display in the repository "summary" 251 Specifies the number of branches to display in the repository "summary"
248 view. Default value: "10". 252 view. Default value: "10".
249 253
250summary-log:: 254summary-log::
251 Specifies the number of log entries to display in the repository 255 Specifies the number of log entries to display in the repository
252 "summary" view. Default value: "10". 256 "summary" view. Default value: "10".
253 257
254summary-tags:: 258summary-tags::
255 Specifies the number of tags to display in the repository "summary" 259 Specifies the number of tags to display in the repository "summary"
256 view. Default value: "10". 260 view. Default value: "10".
257 261
258virtual-root:: 262virtual-root::
259 Url which, if specified, will be used as root for all cgit links. It 263 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 264 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 265 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
262 value: none. 266 value: none.
263 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 267 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. 268 same kind of virtual urls, so this option will probably be deprecated.
265 269
266REPOSITORY SETTINGS 270REPOSITORY SETTINGS
267------------------- 271-------------------
268repo.about-filter:: 272repo.about-filter::
269 Override the default about-filter. Default value: <about-filter>. 273 Override the default about-filter. Default value: none. See also:
274 "enable-filter-overrides".
270 275
271repo.clone-url:: 276repo.clone-url::
272 A list of space-separated urls which can be used to clone this repo. 277 A list of space-separated urls which can be used to clone this repo.
273 Default value: none. 278 Default value: none.
274 279
275repo.commit-filter:: 280repo.commit-filter::
276 Override the default commit-filter. Default value: <commit-filter>. 281 Override the default commit-filter. Default value: none. See also:
282 "enable-filter-overrides".
277 283
278repo.defbranch:: 284repo.defbranch::
279 The name of the default branch for this repository. If no such branch 285 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 286 exists in the repository, the first branch name (when sorted) is used
281 as default instead. Default value: "master". 287 as default instead. Default value: "master".
282 288
283repo.desc:: 289repo.desc::
284 The value to show as repository description. Default value: none. 290 The value to show as repository description. Default value: none.
285 291
286repo.enable-log-filecount:: 292repo.enable-log-filecount::
287 A flag which can be used to disable the global setting 293 A flag which can be used to disable the global setting
288 `enable-log-filecount'. Default value: none. 294 `enable-log-filecount'. Default value: none.
289 295
290repo.enable-log-linecount:: 296repo.enable-log-linecount::
291 A flag which can be used to disable the global setting 297 A flag which can be used to disable the global setting
292 `enable-log-linecount'. Default value: none. 298 `enable-log-linecount'. Default value: none.
293 299
294repo.max-stats:: 300repo.max-stats::
295 Override the default maximum statistics period. Valid values are equal 301 Override the default maximum statistics period. Valid values are equal
296 to the values specified for the global "max-stats" setting. Default 302 to the values specified for the global "max-stats" setting. Default
297 value: none. 303 value: none.
298 304
299repo.name:: 305repo.name::
300 The value to show as repository name. Default value: <repo.url>. 306 The value to show as repository name. Default value: <repo.url>.
301 307
302repo.owner:: 308repo.owner::
303 A value used to identify the owner of the repository. Default value: 309 A value used to identify the owner of the repository. Default value:
304 none. 310 none.
305 311
306repo.path:: 312repo.path::
307 An absolute path to the repository directory. For non-bare repositories 313 An absolute path to the repository directory. For non-bare repositories
308 this is the .git-directory. Default value: none. 314 this is the .git-directory. Default value: none.
309 315
310repo.readme:: 316repo.readme::
311 A path (relative to <repo.path>) which specifies a file to include 317 A path (relative to <repo.path>) which specifies a file to include
312 verbatim as the "About" page for this repo. Default value: none. 318 verbatim as the "About" page for this repo. Default value: none.
313 319
314repo.snapshots:: 320repo.snapshots::
315 A mask of allowed snapshot-formats for this repo, restricted by the 321 A mask of allowed snapshot-formats for this repo, restricted by the
316 "snapshots" global setting. Default value: <snapshots>. 322 "snapshots" global setting. Default value: <snapshots>.
317 323
318repo.section:: 324repo.section::
319 Override the current section name for this repository. Default value: 325 Override the current section name for this repository. Default value:
320 none. 326 none.
321 327
322repo.source-filter:: 328repo.source-filter::
323 Override the default source-filter. Default value: <source-filter>. 329 Override the default source-filter. Default value: none. See also:
330 "enable-filter-overrides".
324 331
325repo.url:: 332repo.url::
326 The relative url used to access the repository. This must be the first 333 The relative url used to access the repository. This must be the first
327 setting specified for each repo. Default value: none. 334 setting specified for each repo. Default value: none.
328 335
329 336
330REPOSITORY-SPECIFIC CGITRC FILE 337REPOSITORY-SPECIFIC CGITRC FILE
331------------------------------- 338-------------------------------
332When the option "scan-path" is used to auto-discover git repositories, cgit 339When the option "scan-path" is used to auto-discover git repositories, cgit
333will try to parse the file "cgitrc" within any found repository. Such a 340will try to parse the file "cgitrc" within any found repository. Such a
334repo-specific config file may contain any of the repo-specific options 341repo-specific config file may contain any of the repo-specific options
335described above, except "repo.url" and "repo.path". Also, in a repo-specific 342described above, except "repo.url" and "repo.path". Additionally, the "filter"
336config file, the "repo." prefix is dropped from the config option names. 343options are only acknowledged in repo-specific config files when
344"enable-filter-overrides" is set to "1".
345
346Note: the "repo." prefix is dropped from the option names in repo-specific
347config files, e.g. "repo.desc" becomes "desc".
337 348
338 349
339EXAMPLE CGITRC FILE 350EXAMPLE CGITRC FILE
340------------------- 351-------------------
341 352
342.... 353....
343# Enable caching of up to 1000 output entriess 354# Enable caching of up to 1000 output entriess
344cache-size=1000 355cache-size=1000
345 356
346 357
347# Specify some default clone prefixes 358# Specify some default clone prefixes
348clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 359clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
349 360
350# Specify the css url 361# Specify the css url
351css=/css/cgit.css 362css=/css/cgit.css
352 363
353 364
354# Show extra links for each repository on the index page 365# Show extra links for each repository on the index page
355enable-index-links=1 366enable-index-links=1
356 367
357 368
358# Show number of affected files per commit on the log pages 369# Show number of affected files per commit on the log pages
359enable-log-filecount=1 370enable-log-filecount=1
360 371
361 372
362# Show number of added/removed lines per commit on the log pages 373# Show number of added/removed lines per commit on the log pages
363enable-log-linecount=1 374enable-log-linecount=1
364 375
365 376
366# Add a cgit favicon 377# Add a cgit favicon
367favicon=/favicon.ico 378favicon=/favicon.ico
368 379
369 380
370# Use a custom logo 381# Use a custom logo
371logo=/img/mylogo.png 382logo=/img/mylogo.png
372 383
373 384
374# Enable statistics per week, month and quarter 385# Enable statistics per week, month and quarter
375max-stats=quarter 386max-stats=quarter
376 387
377 388
378# Set the title and heading of the repository index page 389# Set the title and heading of the repository index page
379root-title=foobar.com git repositories 390root-title=foobar.com git repositories
380 391
381 392
382# Set a subheading for the repository index page 393# Set a subheading for the repository index page
383root-desc=tracking the foobar development 394root-desc=tracking the foobar development
384 395