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