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