summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (show whitespace changes)
-rw-r--r--cgitrc.5.txt68
1 files changed, 65 insertions, 3 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..ce78d41 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -74,63 +74,79 @@ clone-prefix::
74 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
76 setting is only used if `repo.clone-url` is unspecified. Default value: 76 setting is only used if `repo.clone-url` is unspecified. Default value:
77 none. 77 none.
78 78
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
82 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-filter-overrides:: 94enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-gitweb-owner::
99 If set to "1" and scan-path is enabled, we first check each repository
100 for the git config value "gitweb.owner" to determine the owner.
101 Default value: "1". See also: scan-path.
102
98enable-index-links:: 103enable-index-links::
99 Flag which, when set to "1", will make cgit generate extra links for 104 Flag which, when set to "1", will make cgit generate extra links for
100 each repo in the repository index (specifically, to the "summary", 105 each repo in the repository index (specifically, to the "summary",
101 "commit" and "tree" pages). Default value: "0". 106 "commit" and "tree" pages). Default value: "0".
102 107
103enable-log-filecount:: 108enable-log-filecount::
104 Flag which, when set to "1", will make cgit print the number of 109 Flag which, when set to "1", will make cgit print the number of
105 modified files for each commit on the repository log page. Default 110 modified files for each commit on the repository log page. Default
106 value: "0". 111 value: "0".
107 112
108enable-log-linecount:: 113enable-log-linecount::
109 Flag which, when set to "1", will make cgit print the number of added 114 Flag which, when set to "1", will make cgit print the number of added
110 and removed lines for each commit on the repository log page. Default 115 and removed lines for each commit on the repository log page. Default
111 value: "0". 116 value: "0".
112 117
118enable-remote-branches::
119 Flag which, when set to "1", will make cgit display remote branches
120 in the summary and refs views. Default value: "0". See also:
121 "repo.enable-remote-branches".
122
123enable-subject-links::
124 Flag which, when set to "1", will make cgit use the subject of the
125 parent commit as link text when generating links to parent commits
126 in commit view. Default value: "0". See also:
127 "repo.enable-subject-links".
128
113enable-tree-linenumbers:: 129enable-tree-linenumbers::
114 Flag which, when set to "1", will make cgit generate linenumber links 130 Flag which, when set to "1", will make cgit generate linenumber links
115 for plaintext blobs printed in the tree view. Default value: "1". 131 for plaintext blobs printed in the tree view. Default value: "1".
116 132
117favicon:: 133favicon::
118 Url used as link to a shortcut icon for cgit. If specified, it is 134 Url used as link to a shortcut icon for cgit. If specified, it is
119 suggested to use the value "/favicon.ico" since certain browsers will 135 suggested to use the value "/favicon.ico" since certain browsers will
120 ignore other values. Default value: none. 136 ignore other values. Default value: none.
121 137
122footer:: 138footer::
123 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
124 verbatim at the bottom of all pages (i.e. it replaces the standard 140 verbatim at the bottom of all pages (i.e. it replaces the standard
125 "generated by..." message. Default value: none. 141 "generated by..." message. Default value: none.
126 142
127head-include:: 143head-include::
128 The content of the file specified with this option will be included 144 The content of the file specified with this option will be included
129 verbatim in the html HEAD section on all pages. Default value: none. 145 verbatim in the html HEAD section on all pages. Default value: none.
130 146
131header:: 147header::
132 The content of the file specified with this option will be included 148 The content of the file specified with this option will be included
133 verbatim at the top of all pages. Default value: none. 149 verbatim at the top of all pages. Default value: none.
134 150
135include:: 151include::
136 Name of a configfile to include before the rest of the current config- 152 Name of a configfile to include before the rest of the current config-
@@ -140,128 +156,163 @@ index-header::
140 The content of the file specified with this option will be included 156 The content of the file specified with this option will be included
141 verbatim above the repository index. This setting is deprecated, and 157 verbatim above the repository index. This setting is deprecated, and
142 will not be supported by cgit-1.0 (use root-readme instead). Default 158 will not be supported by cgit-1.0 (use root-readme instead). Default
143 value: none. 159 value: none.
144 160
145index-info:: 161index-info::
146 The content of the file specified with this option will be included 162 The content of the file specified with this option will be included
147 verbatim below the heading on the repository index page. This setting 163 verbatim below the heading on the repository index page. This setting
148 is deprecated, and will not be supported by cgit-1.0 (use root-desc 164 is deprecated, and will not be supported by cgit-1.0 (use root-desc
149 instead). Default value: none. 165 instead). Default value: none.
150 166
151local-time:: 167local-time::
152 Flag which, if set to "1", makes cgit print commit and tag times in the 168 Flag which, if set to "1", makes cgit print commit and tag times in the
153 servers timezone. Default value: "0". 169 servers timezone. Default value: "0".
154 170
155logo:: 171logo::
156 Url which specifies the source of an image which will be used as a logo 172 Url which specifies the source of an image which will be used as a logo
157 on all cgit pages. Default value: "/cgit.png". 173 on all cgit pages. Default value: "/cgit.png".
158 174
159logo-link:: 175logo-link::
160 Url loaded when clicking on the cgit logo image. If unspecified the 176 Url loaded when clicking on the cgit logo image. If unspecified the
161 calculated url of the repository index page will be used. Default 177 calculated url of the repository index page will be used. Default
162 value: none. 178 value: none.
163 179
180max-atom-items::
181 Specifies the number of items to display in atom feeds view. Default
182 value: "10".
183
164max-commit-count:: 184max-commit-count::
165 Specifies the number of entries to list per page in "log" view. Default 185 Specifies the number of entries to list per page in "log" view. Default
166 value: "50". 186 value: "50".
167 187
168max-message-length:: 188max-message-length::
169 Specifies the maximum number of commit message characters to display in 189 Specifies the maximum number of commit message characters to display in
170 "log" view. Default value: "80". 190 "log" view. Default value: "80".
171 191
172max-repo-count:: 192max-repo-count::
173 Specifies the number of entries to list per page on therepository 193 Specifies the number of entries to list per page on therepository
174 index page. Default value: "50". 194 index page. Default value: "50".
175 195
176max-repodesc-length:: 196max-repodesc-length::
177 Specifies the maximum number of repo description characters to display 197 Specifies the maximum number of repo description characters to display
178 on the repository index page. Default value: "80". 198 on the repository index page. Default value: "80".
179 199
200max-blob-size::
201 Specifies the maximum size of a blob to display HTML for in KBytes.
202 Default value: "0" (limit disabled).
203
180max-stats:: 204max-stats::
181 Set the default maximum statistics period. Valid values are "week", 205 Set the default maximum statistics period. Valid values are "week",
182 "month", "quarter" and "year". If unspecified, statistics are 206 "month", "quarter" and "year". If unspecified, statistics are
183 disabled. Default value: none. See also: "repo.max-stats". 207 disabled. Default value: none. See also: "repo.max-stats".
184 208
185mimetype.<ext>:: 209mimetype.<ext>::
186 Set the mimetype for the specified filename extension. This is used 210 Set the mimetype for the specified filename extension. This is used
187 by the `plain` command when returning blob content. 211 by the `plain` command when returning blob content.
188 212
189module-link:: 213module-link::
190 Text which will be used as the formatstring for a hyperlink when a 214 Text which will be used as the formatstring for a hyperlink when a
191 submodule is printed in a directory listing. The arguments for the 215 submodule is printed in a directory listing. The arguments for the
192 formatstring are the path and SHA1 of the submodule commit. Default 216 formatstring are the path and SHA1 of the submodule commit. Default
193 value: "./?repo=%s&page=commit&id=%s" 217 value: "./?repo=%s&page=commit&id=%s"
194 218
195nocache:: 219nocache::
196 If set to the value "1" caching will be disabled. This settings is 220 If set to the value "1" caching will be disabled. This settings is
197 deprecated, and will not be honored starting with cgit-1.0. Default 221 deprecated, and will not be honored starting with cgit-1.0. Default
198 value: "0". 222 value: "0".
199 223
200noplainemail:: 224noplainemail::
201 If set to "1" showing full author email adresses will be disabled. 225 If set to "1" showing full author email adresses will be disabled.
202 Default value: "0". 226 Default value: "0".
203 227
204noheader:: 228noheader::
205 Flag which, when set to "1", will make cgit omit the standard header 229 Flag which, when set to "1", will make cgit omit the standard header
206 on all pages. Default value: none. See also: "embedded". 230 on all pages. Default value: none. See also: "embedded".
207 231
232project-list::
233 A list of subdirectories inside of scan-path, relative to it, that
234 should loaded as git repositories. This must be defined prior to
235 scan-path. Default value: none. See also: scan-path.
236
237readme::
238 Text which will be used as default value for "repo.readme". Default
239 value: none.
240
241remove-suffix::
242 If set to "1" and scan-path is enabled, if any repositories are found
243 with a suffix of ".git", this suffix will be removed for the url and
244 name. Default value: "0". See also: scan-path.
245
208renamelimit:: 246renamelimit::
209 Maximum number of files to consider when detecting renames. The value 247 Maximum number of files to consider when detecting renames. The value
210 "-1" uses the compiletime value in git (for further info, look at 248 "-1" uses the compiletime value in git (for further info, look at
211 `man git-diff`). Default value: "-1". 249 `man git-diff`). Default value: "-1".
212 250
213repo.group:: 251repo.group::
214 Legacy alias for "section". This option is deprecated and will not be 252 Legacy alias for "section". This option is deprecated and will not be
215 supported in cgit-1.0. 253 supported in cgit-1.0.
216 254
217robots:: 255robots::
218 Text used as content for the "robots" meta-tag. Default value: 256 Text used as content for the "robots" meta-tag. Default value:
219 "index, nofollow". 257 "index, nofollow".
220 258
221root-desc:: 259root-desc::
222 Text printed below the heading on the repository index page. Default 260 Text printed below the heading on the repository index page. Default
223 value: "a fast webinterface for the git dscm". 261 value: "a fast webinterface for the git dscm".
224 262
225root-readme:: 263root-readme::
226 The content of the file specified with this option will be included 264 The content of the file specified with this option will be included
227 verbatim below the "about" link on the repository index page. Default 265 verbatim below the "about" link on the repository index page. Default
228 value: none. 266 value: none.
229 267
230root-title:: 268root-title::
231 Text printed as heading on the repository index page. Default value: 269 Text printed as heading on the repository index page. Default value:
232 "Git Repository Browser". 270 "Git Repository Browser".
233 271
234scan-path:: 272scan-path::
235 A path which will be scanned for repositories. If caching is enabled, 273 A path which will be scanned for repositories. If caching is enabled,
236 the result will be cached as a cgitrc include-file in the cache 274 the result will be cached as a cgitrc include-file in the cache
237 directory. Default value: none. See also: cache-scanrc-ttl. 275 directory. If project-list has been defined prior to scan-path,
276 scan-path loads only the directories listed in the file pointed to by
277 project-list. Default value: none. See also: cache-scanrc-ttl,
278 project-list.
238 279
239section:: 280section::
240 The name of the current repository section - all repositories defined 281 The name of the current repository section - all repositories defined
241 after this option will inherit the current section name. Default value: 282 after this option will inherit the current section name. Default value:
242 none. 283 none.
243 284
285section-from-path::
286 A number which, if specified before scan-path, specifies how many
287 path elements from each repo path to use as a default section name.
288 If negative, cgit will discard the specified number of path elements
289 above the repo directory. Default value: 0.
290
291side-by-side-diffs::
292 If set to "1" shows side-by-side diffs instead of unidiffs per
293 default. Default value: "0".
294
244snapshots:: 295snapshots::
245 Text which specifies the default set of snapshot formats generated by 296 Text which specifies the default set of snapshot formats generated by
246 cgit. The value is a space-separated list of zero or more of the 297 cgit. The value is a space-separated list of zero or more of the
247 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 298 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
248 299
249source-filter:: 300source-filter::
250 Specifies a command which will be invoked to format plaintext blobs 301 Specifies a command which will be invoked to format plaintext blobs
251 in the tree view. The command will get the blob content on its STDIN 302 in the tree view. The command will get the blob content on its STDIN
252 and the name of the blob as its only command line argument. The STDOUT 303 and the name of the blob as its only command line argument. The STDOUT
253 from the command will be included verbatim as the blob contents, i.e. 304 from the command will be included verbatim as the blob contents, i.e.
254 this can be used to implement e.g. syntax highlighting. Default value: 305 this can be used to implement e.g. syntax highlighting. Default value:
255 none. 306 none.
256 307
257summary-branches:: 308summary-branches::
258 Specifies the number of branches to display in the repository "summary" 309 Specifies the number of branches to display in the repository "summary"
259 view. Default value: "10". 310 view. Default value: "10".
260 311
261summary-log:: 312summary-log::
262 Specifies the number of log entries to display in the repository 313 Specifies the number of log entries to display in the repository
263 "summary" view. Default value: "10". 314 "summary" view. Default value: "10".
264 315
265summary-tags:: 316summary-tags::
266 Specifies the number of tags to display in the repository "summary" 317 Specifies the number of tags to display in the repository "summary"
267 view. Default value: "10". 318 view. Default value: "10".
@@ -283,67 +334,77 @@ repo.about-filter::
283repo.clone-url:: 334repo.clone-url::
284 A list of space-separated urls which can be used to clone this repo. 335 A list of space-separated urls which can be used to clone this repo.
285 Default value: none. 336 Default value: none.
286 337
287repo.commit-filter:: 338repo.commit-filter::
288 Override the default commit-filter. Default value: none. See also: 339 Override the default commit-filter. Default value: none. See also:
289 "enable-filter-overrides". 340 "enable-filter-overrides".
290 341
291repo.defbranch:: 342repo.defbranch::
292 The name of the default branch for this repository. If no such branch 343 The name of the default branch for this repository. If no such branch
293 exists in the repository, the first branch name (when sorted) is used 344 exists in the repository, the first branch name (when sorted) is used
294 as default instead. Default value: "master". 345 as default instead. Default value: "master".
295 346
296repo.desc:: 347repo.desc::
297 The value to show as repository description. Default value: none. 348 The value to show as repository description. Default value: none.
298 349
299repo.enable-log-filecount:: 350repo.enable-log-filecount::
300 A flag which can be used to disable the global setting 351 A flag which can be used to disable the global setting
301 `enable-log-filecount'. Default value: none. 352 `enable-log-filecount'. Default value: none.
302 353
303repo.enable-log-linecount:: 354repo.enable-log-linecount::
304 A flag which can be used to disable the global setting 355 A flag which can be used to disable the global setting
305 `enable-log-linecount'. Default value: none. 356 `enable-log-linecount'. Default value: none.
306 357
358repo.enable-remote-branches::
359 Flag which, when set to "1", will make cgit display remote branches
360 in the summary and refs views. Default value: <enable-remote-branches>.
361
362repo.enable-subject-links::
363 A flag which can be used to override the global setting
364 `enable-subject-links'. Default value: none.
365
307repo.max-stats:: 366repo.max-stats::
308 Override the default maximum statistics period. Valid values are equal 367 Override the default maximum statistics period. Valid values are equal
309 to the values specified for the global "max-stats" setting. Default 368 to the values specified for the global "max-stats" setting. Default
310 value: none. 369 value: none.
311 370
312repo.name:: 371repo.name::
313 The value to show as repository name. Default value: <repo.url>. 372 The value to show as repository name. Default value: <repo.url>.
314 373
315repo.owner:: 374repo.owner::
316 A value used to identify the owner of the repository. Default value: 375 A value used to identify the owner of the repository. Default value:
317 none. 376 none.
318 377
319repo.path:: 378repo.path::
320 An absolute path to the repository directory. For non-bare repositories 379 An absolute path to the repository directory. For non-bare repositories
321 this is the .git-directory. Default value: none. 380 this is the .git-directory. Default value: none.
322 381
323repo.readme:: 382repo.readme::
324 A path (relative to <repo.path>) which specifies a file to include 383 A path (relative to <repo.path>) which specifies a file to include
325 verbatim as the "About" page for this repo. Default value: none. 384 verbatim as the "About" page for this repo. You may also specify a
385 git refspec by head or by hash by prepending the refspec followed by
386 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
326 387
327repo.snapshots:: 388repo.snapshots::
328 A mask of allowed snapshot-formats for this repo, restricted by the 389 A mask of allowed snapshot-formats for this repo, restricted by the
329 "snapshots" global setting. Default value: <snapshots>. 390 "snapshots" global setting. Default value: <snapshots>.
330 391
331repo.section:: 392repo.section::
332 Override the current section name for this repository. Default value: 393 Override the current section name for this repository. Default value:
333 none. 394 none.
334 395
335repo.source-filter:: 396repo.source-filter::
336 Override the default source-filter. Default value: none. See also: 397 Override the default source-filter. Default value: none. See also:
337 "enable-filter-overrides". 398 "enable-filter-overrides".
338 399
339repo.url:: 400repo.url::
340 The relative url used to access the repository. This must be the first 401 The relative url used to access the repository. This must be the first
341 setting specified for each repo. Default value: none. 402 setting specified for each repo. Default value: none.
342 403
343 404
344REPOSITORY-SPECIFIC CGITRC FILE 405REPOSITORY-SPECIFIC CGITRC FILE
345------------------------------- 406-------------------------------
346When the option "scan-path" is used to auto-discover git repositories, cgit 407When the option "scan-path" is used to auto-discover git repositories, cgit
347will try to parse the file "cgitrc" within any found repository. Such a 408will try to parse the file "cgitrc" within any found repository. Such a
348repo-specific config file may contain any of the repo-specific options 409repo-specific config file may contain any of the repo-specific options
349described above, except "repo.url" and "repo.path". Additionally, the "filter" 410described above, except "repo.url" and "repo.path". Additionally, the "filter"
@@ -392,49 +453,49 @@ logo=/img/mylogo.png
392# Enable statistics per week, month and quarter 453# Enable statistics per week, month and quarter
393max-stats=quarter 454max-stats=quarter
394 455
395 456
396# Set the title and heading of the repository index page 457# Set the title and heading of the repository index page
397root-title=foobar.com git repositories 458root-title=foobar.com git repositories
398 459
399 460
400# Set a subheading for the repository index page 461# Set a subheading for the repository index page
401root-desc=tracking the foobar development 462root-desc=tracking the foobar development
402 463
403 464
404# Include some more info about foobar.com on the index page 465# Include some more info about foobar.com on the index page
405root-readme=/var/www/htdocs/about.html 466root-readme=/var/www/htdocs/about.html
406 467
407 468
408# Allow download of tar.gz, tar.bz2 and zip-files 469# Allow download of tar.gz, tar.bz2 and zip-files
409snapshots=tar.gz tar.bz2 zip 470snapshots=tar.gz tar.bz2 zip
410 471
411 472
412## 473##
413## List of common mimetypes 474## List of common mimetypes
414## 475##
415 476
416mimetype.git=image/git 477mimetype.gif=image/gif
417mimetype.html=text/html 478mimetype.html=text/html
418mimetype.jpg=image/jpeg 479mimetype.jpg=image/jpeg
419mimetype.jpeg=image/jpeg 480mimetype.jpeg=image/jpeg
420mimetype.pdf=application/pdf 481mimetype.pdf=application/pdf
421mimetype.png=image/png 482mimetype.png=image/png
422mimetype.svg=image/svg+xml 483mimetype.svg=image/svg+xml
423 484
424 485
425## 486##
426## List of repositories. 487## List of repositories.
427## PS: Any repositories listed when section is unset will not be 488## PS: Any repositories listed when section is unset will not be
428## displayed under a section heading 489## displayed under a section heading
429## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 490## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
430## and included like this: 491## and included like this:
431## include=/etc/cgitrepos 492## include=/etc/cgitrepos
432## 493##
433 494
434 495
435repo.url=foo 496repo.url=foo
436repo.path=/pub/git/foo.git 497repo.path=/pub/git/foo.git
437repo.desc=the master foo repository 498repo.desc=the master foo repository
438repo.owner=fooman@foobar.com 499repo.owner=fooman@foobar.com
439repo.readme=info/web/about.html 500repo.readme=info/web/about.html
440 501
@@ -478,24 +539,25 @@ repo.snapshots=0
478# Disable line-counts for this repo 539# Disable line-counts for this repo
479repo.enable-log-linecount=0 540repo.enable-log-linecount=0
480 541
481# Restrict the max statistics period for this repo 542# Restrict the max statistics period for this repo
482repo.max-stats=month 543repo.max-stats=month
483.... 544....
484 545
485 546
486BUGS 547BUGS
487---- 548----
488Comments currently cannot appear on the same line as a setting; the comment 549Comments currently cannot appear on the same line as a setting; the comment
489will be included as part of the value. E.g. this line: 550will be included as part of the value. E.g. this line:
490 551
491 robots=index # allow indexing 552 robots=index # allow indexing
492 553
493will generate the following html element: 554will generate the following html element:
494 555
495 <meta name='robots' content='index # allow indexing'/> 556 <meta name='robots' content='index # allow indexing'/>
496 557
497 558
498 559
499AUTHOR 560AUTHOR
500------ 561------
501Lars Hjemli <hjemli@gmail.com> 562Lars Hjemli <hjemli@gmail.com>
563Jason A. Donenfeld <Jason@zx2c4.com>