summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2009-02-13 19:43:30 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-07-25 10:55:15 (UTC)
commitc4d46c7035d07070ac1ebf0c0b44df927358687f (patch) (unidiff)
tree562cf4f01afe78b92b13ad5be5dc01e07db04a66 /cgitrc.5.txt
parent286a905842dc0bec6d21a614ec4a97c5f19d5bc4 (diff)
downloadcgit-c4d46c7035d07070ac1ebf0c0b44df927358687f.zip
cgit-c4d46c7035d07070ac1ebf0c0b44df927358687f.tar.gz
cgit-c4d46c7035d07070ac1ebf0c0b44df927358687f.tar.bz2
Add support for mime type registration and lookup
This patch makes it possible to register mappings from filename extension to mime type in cgitrc and use this mapping when returning blob content in `plain` view. The reason for adding this mapping to cgitrc (as opposed to parsing something like /etc/mime.types) is to allow quick lookup of a limited number of filename extensions (/etc/mime-types on my machine currently contains over 700 entries). NB: A nice addition to this patch would be to parse /etc/mime.types when `plain` view is requested for a file with an extension for which there is no mapping registered in cgitrc. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
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 a207fe0..7256ec0 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -86,128 +86,132 @@ favicon::
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
161noheader:: 165noheader::
162 Flag which, when set to "1", will make cgit omit the standard header 166 Flag which, when set to "1", will make cgit omit the standard header
163 on all pages. Default value: none. See also: "embedded". 167 on all pages. Default value: none. See also: "embedded".
164 168
165renamelimit:: 169renamelimit::
166 Maximum number of files to consider when detecting renames. The value 170 Maximum number of files to consider when detecting renames. The value
167 "-1" uses the compiletime value in git (for further info, look at 171 "-1" uses the compiletime value in git (for further info, look at
168 `man git-diff`). Default value: "-1". 172 `man git-diff`). Default value: "-1".
169 173
170repo.group:: 174repo.group::
171 A value for the current repository group, which all repositories 175 A value for the current repository group, which all repositories
172 specified after this setting will inherit. Default value: none. 176 specified after this setting will inherit. Default value: none.
173 177
174robots:: 178robots::
175 Text used as content for the "robots" meta-tag. Default value: 179 Text used as content for the "robots" meta-tag. Default value:
176 "index, nofollow". 180 "index, nofollow".
177 181
178root-desc:: 182root-desc::
179 Text printed below the heading on the repository index page. Default 183 Text printed below the heading on the repository index page. Default
180 value: "a fast webinterface for the git dscm". 184 value: "a fast webinterface for the git dscm".
181 185
182root-readme:: 186root-readme::
183 The content of the file specified with this option will be included 187 The content of the file specified with this option will be included
184 verbatim below the "about" link on the repository index page. Default 188 verbatim below the "about" link on the repository index page. Default
185 value: none. 189 value: none.
186 190
187root-title:: 191root-title::
188 Text printed as heading on the repository index page. Default value: 192 Text printed as heading on the repository index page. Default value:
189 "Git Repository Browser". 193 "Git Repository Browser".
190 194
191snapshots:: 195snapshots::
192 Text which specifies the default (and allowed) set of snapshot formats 196 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 197 supported by cgit. The value is a space-separated list of zero or more
194 of the following values: 198 of the following values:
195 "tar" uncompressed tar-file 199 "tar" uncompressed tar-file
196 "tar.gz"gzip-compressed tar-file 200 "tar.gz"gzip-compressed tar-file
197 "tar.bz2"bzip-compressed tar-file 201 "tar.bz2"bzip-compressed tar-file
198 "zip" zip-file 202 "zip" zip-file
199 Default value: none. 203 Default value: none.
200 204
201summary-branches:: 205summary-branches::
202 Specifies the number of branches to display in the repository "summary" 206 Specifies the number of branches to display in the repository "summary"
203 view. Default value: "10". 207 view. Default value: "10".
204 208
205summary-log:: 209summary-log::
206 Specifies the number of log entries to display in the repository 210 Specifies the number of log entries to display in the repository
207 "summary" view. Default value: "10". 211 "summary" view. Default value: "10".
208 212
209summary-tags:: 213summary-tags::
210 Specifies the number of tags to display in the repository "summary" 214 Specifies the number of tags to display in the repository "summary"
211 view. Default value: "10". 215 view. Default value: "10".
212 216
213virtual-root:: 217virtual-root::
@@ -264,128 +268,141 @@ repo.snapshots::
264 A mask of allowed snapshot-formats for this repo, restricted by the 268 A mask of allowed snapshot-formats for this repo, restricted by the
265 "snapshots" global setting. Default value: <snapshots>. 269 "snapshots" global setting. Default value: <snapshots>.
266 270
267repo.url:: 271repo.url::
268 The relative url used to access the repository. This must be the first 272 The relative url used to access the repository. This must be the first
269 setting specified for each repo. Default value: none. 273 setting specified for each repo. Default value: none.
270 274
271 275
272EXAMPLE CGITRC FILE 276EXAMPLE CGITRC FILE
273------------------- 277-------------------
274 278
275.... 279....
276# Enable caching of up to 1000 output entriess 280# Enable caching of up to 1000 output entriess
277cache-size=1000 281cache-size=1000
278 282
279 283
280# Specify some default clone prefixes 284# Specify some default clone prefixes
281clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 285clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
282 286
283# Specify the css url 287# Specify the css url
284css=/css/cgit.css 288css=/css/cgit.css
285 289
286 290
287# Show extra links for each repository on the index page 291# Show extra links for each repository on the index page
288enable-index-links=1 292enable-index-links=1
289 293
290 294
291# Show number of affected files per commit on the log pages 295# Show number of affected files per commit on the log pages
292enable-log-filecount=1 296enable-log-filecount=1
293 297
294 298
295# Show number of added/removed lines per commit on the log pages 299# Show number of added/removed lines per commit on the log pages
296enable-log-linecount=1 300enable-log-linecount=1
297 301
298 302
299# Add a cgit favicon 303# Add a cgit favicon
300favicon=/favicon.ico 304favicon=/favicon.ico
301 305
302 306
303# Use a custom logo 307# Use a custom logo
304logo=/img/mylogo.png 308logo=/img/mylogo.png
305 309
306 310
307# Enable statistics per week, month and quarter 311# Enable statistics per week, month and quarter
308max-stats=quarter 312max-stats=quarter
309 313
310 314
311# Set the title and heading of the repository index page 315# Set the title and heading of the repository index page
312root-title=foobar.com git repositories 316root-title=foobar.com git repositories
313 317
314 318
315# Set a subheading for the repository index page 319# Set a subheading for the repository index page
316root-desc=tracking the foobar development 320root-desc=tracking the foobar development
317 321
318 322
319# Include some more info about foobar.com on the index page 323# Include some more info about foobar.com on the index page
320root-readme=/var/www/htdocs/about.html 324root-readme=/var/www/htdocs/about.html
321 325
322 326
323# Allow download of tar.gz, tar.bz2 and zip-files 327# Allow download of tar.gz, tar.bz2 and zip-files
324snapshots=tar.gz tar.bz2 zip 328snapshots=tar.gz tar.bz2 zip
325 329
326 330
327## 331##
332## List of common mimetypes
333##
334
335mimetype.git=image/git
336mimetype.html=text/html
337mimetype.jpg=image/jpeg
338mimetype.jpeg=image/jpeg
339mimetype.pdf=application/pdf
340mimetype.png=image/png
341mimetype.svg=image/svg+xml
342
343
344##
328## List of repositories. 345## List of repositories.
329## PS: Any repositories listed when repo.group is unset will not be 346## PS: Any repositories listed when repo.group is unset will not be
330## displayed under a group heading 347## displayed under a group heading
331## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 348## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
332## and included like this: 349## and included like this:
333## include=/etc/cgitrepos 350## include=/etc/cgitrepos
334## 351##
335 352
336 353
337repo.url=foo 354repo.url=foo
338repo.path=/pub/git/foo.git 355repo.path=/pub/git/foo.git
339repo.desc=the master foo repository 356repo.desc=the master foo repository
340repo.owner=fooman@foobar.com 357repo.owner=fooman@foobar.com
341repo.readme=info/web/about.html 358repo.readme=info/web/about.html
342 359
343 360
344repo.url=bar 361repo.url=bar
345repo.path=/pub/git/bar.git 362repo.path=/pub/git/bar.git
346repo.desc=the bars for your foo 363repo.desc=the bars for your foo
347repo.owner=barman@foobar.com 364repo.owner=barman@foobar.com
348repo.readme=info/web/about.html 365repo.readme=info/web/about.html
349 366
350 367
351# The next repositories will be displayed under the 'extras' heading 368# The next repositories will be displayed under the 'extras' heading
352repo.group=extras 369repo.group=extras
353 370
354 371
355repo.url=baz 372repo.url=baz
356repo.path=/pub/git/baz.git 373repo.path=/pub/git/baz.git
357repo.desc=a set of extensions for bar users 374repo.desc=a set of extensions for bar users
358 375
359repo.url=wiz 376repo.url=wiz
360repo.path=/pub/git/wiz.git 377repo.path=/pub/git/wiz.git
361repo.desc=the wizard of foo 378repo.desc=the wizard of foo
362 379
363 380
364# Add some mirrored repositories 381# Add some mirrored repositories
365repo.group=mirrors 382repo.group=mirrors
366 383
367 384
368repo.url=git 385repo.url=git
369repo.path=/pub/git/git.git 386repo.path=/pub/git/git.git
370repo.desc=the dscm 387repo.desc=the dscm
371 388
372 389
373repo.url=linux 390repo.url=linux
374repo.path=/pub/git/linux.git 391repo.path=/pub/git/linux.git
375repo.desc=the kernel 392repo.desc=the kernel
376 393
377# Disable adhoc downloads of this repo 394# Disable adhoc downloads of this repo
378repo.snapshots=0 395repo.snapshots=0
379 396
380# Disable line-counts for this repo 397# Disable line-counts for this repo
381repo.enable-log-linecount=0 398repo.enable-log-linecount=0
382 399
383# Restrict the max statistics period for this repo 400# Restrict the max statistics period for this repo
384repo.max-stats=month 401repo.max-stats=month
385.... 402....
386 403
387 404
388BUGS 405BUGS
389---- 406----
390Comments currently cannot appear on the same line as a setting; the comment 407Comments currently cannot appear on the same line as a setting; the comment
391will be included as part of the value. E.g. this line: 408will be included as part of the value. E.g. this line: