-rw-r--r-- | cgitrc.5.txt | 115 |
1 files changed, 107 insertions, 8 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 0c13485..c3698a6 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -88,16 +88,26 @@ css:: | |||
88 | 88 | ||
89 | embedded:: | 89 | embedded:: |
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 | ||
94 | enable-commit-graph:: | ||
95 | Flag which, when set to "1", will make cgit print an ASCII-art commit | ||
96 | history graph to the left of the commit messages in the repository | ||
97 | log page. Default value: "0". | ||
98 | |||
94 | enable-filter-overrides:: | 99 | enable-filter-overrides:: |
95 | Flag which, when set to "1", allows all filter settings to be | 100 | Flag which, when set to "1", allows all filter settings to be |
96 | overridden in repository-specific cgitrc files. Default value: none. | 101 | overridden in repository-specific cgitrc files. Default value: none. |
97 | 102 | ||
103 | enable-gitweb-owner:: | ||
104 | If set to "1" and scan-path is enabled, we first check each repository | ||
105 | for the git config value "gitweb.owner" to determine the owner. | ||
106 | Default value: "1". See also: scan-path. | ||
107 | |||
98 | enable-index-links:: | 108 | enable-index-links:: |
99 | Flag which, when set to "1", will make cgit generate extra links for | 109 | Flag which, when set to "1", will make cgit generate extra links for |
100 | each repo in the repository index (specifically, to the "summary", | 110 | each repo in the repository index (specifically, to the "summary", |
101 | "commit" and "tree" pages). Default value: "0". | 111 | "commit" and "tree" pages). Default value: "0". |
102 | 112 | ||
103 | enable-log-filecount:: | 113 | enable-log-filecount:: |
@@ -107,12 +117,23 @@ enable-log-filecount:: | |||
107 | 117 | ||
108 | enable-log-linecount:: | 118 | enable-log-linecount:: |
109 | Flag which, when set to "1", will make cgit print the number of added | 119 | 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 | 120 | and removed lines for each commit on the repository log page. Default |
111 | value: "0". | 121 | value: "0". |
112 | 122 | ||
123 | enable-remote-branches:: | ||
124 | Flag which, when set to "1", will make cgit display remote branches | ||
125 | in the summary and refs views. Default value: "0". See also: | ||
126 | "repo.enable-remote-branches". | ||
127 | |||
128 | enable-subject-links:: | ||
129 | Flag which, when set to "1", will make cgit use the subject of the | ||
130 | parent commit as link text when generating links to parent commits | ||
131 | in commit view. Default value: "0". See also: | ||
132 | "repo.enable-subject-links". | ||
133 | |||
113 | enable-tree-linenumbers:: | 134 | enable-tree-linenumbers:: |
114 | Flag which, when set to "1", will make cgit generate linenumber links | 135 | Flag which, when set to "1", will make cgit generate linenumber links |
115 | for plaintext blobs printed in the tree view. Default value: "1". | 136 | for plaintext blobs printed in the tree view. Default value: "1". |
116 | 137 | ||
117 | favicon:: | 138 | favicon:: |
118 | Url used as link to a shortcut icon for cgit. If specified, it is | 139 | Url used as link to a shortcut icon for cgit. If specified, it is |
@@ -158,12 +179,16 @@ logo:: | |||
158 | 179 | ||
159 | logo-link:: | 180 | logo-link:: |
160 | Url loaded when clicking on the cgit logo image. If unspecified the | 181 | Url loaded when clicking on the cgit logo image. If unspecified the |
161 | calculated url of the repository index page will be used. Default | 182 | calculated url of the repository index page will be used. Default |
162 | value: none. | 183 | value: none. |
163 | 184 | ||
185 | max-atom-items:: | ||
186 | Specifies the number of items to display in atom feeds view. Default | ||
187 | value: "10". | ||
188 | |||
164 | max-commit-count:: | 189 | max-commit-count:: |
165 | Specifies the number of entries to list per page in "log" view. Default | 190 | Specifies the number of entries to list per page in "log" view. Default |
166 | value: "50". | 191 | value: "50". |
167 | 192 | ||
168 | max-message-length:: | 193 | max-message-length:: |
169 | Specifies the maximum number of commit message characters to display in | 194 | Specifies the maximum number of commit message characters to display in |
@@ -174,12 +199,16 @@ max-repo-count:: | |||
174 | index page. Default value: "50". | 199 | index page. Default value: "50". |
175 | 200 | ||
176 | max-repodesc-length:: | 201 | max-repodesc-length:: |
177 | Specifies the maximum number of repo description characters to display | 202 | Specifies the maximum number of repo description characters to display |
178 | on the repository index page. Default value: "80". | 203 | on the repository index page. Default value: "80". |
179 | 204 | ||
205 | max-blob-size:: | ||
206 | Specifies the maximum size of a blob to display HTML for in KBytes. | ||
207 | Default value: "0" (limit disabled). | ||
208 | |||
180 | max-stats:: | 209 | max-stats:: |
181 | Set the default maximum statistics period. Valid values are "week", | 210 | Set the default maximum statistics period. Valid values are "week", |
182 | "month", "quarter" and "year". If unspecified, statistics are | 211 | "month", "quarter" and "year". If unspecified, statistics are |
183 | disabled. Default value: none. See also: "repo.max-stats". | 212 | disabled. Default value: none. See also: "repo.max-stats". |
184 | 213 | ||
185 | mimetype.<ext>:: | 214 | mimetype.<ext>:: |
@@ -202,12 +231,26 @@ noplainemail:: | |||
202 | Default value: "0". | 231 | Default value: "0". |
203 | 232 | ||
204 | noheader:: | 233 | noheader:: |
205 | Flag which, when set to "1", will make cgit omit the standard header | 234 | Flag which, when set to "1", will make cgit omit the standard header |
206 | on all pages. Default value: none. See also: "embedded". | 235 | on all pages. Default value: none. See also: "embedded". |
207 | 236 | ||
237 | project-list:: | ||
238 | A list of subdirectories inside of scan-path, relative to it, that | ||
239 | should loaded as git repositories. This must be defined prior to | ||
240 | scan-path. Default value: none. See also: scan-path. | ||
241 | |||
242 | readme:: | ||
243 | Text which will be used as default value for "repo.readme". Default | ||
244 | value: none. | ||
245 | |||
246 | remove-suffix:: | ||
247 | If set to "1" and scan-path is enabled, if any repositories are found | ||
248 | with a suffix of ".git", this suffix will be removed for the url and | ||
249 | name. Default value: "0". See also: scan-path. | ||
250 | |||
208 | renamelimit:: | 251 | renamelimit:: |
209 | Maximum number of files to consider when detecting renames. The value | 252 | Maximum number of files to consider when detecting renames. The value |
210 | "-1" uses the compiletime value in git (for further info, look at | 253 | "-1" uses the compiletime value in git (for further info, look at |
211 | `man git-diff`). Default value: "-1". | 254 | `man git-diff`). Default value: "-1". |
212 | 255 | ||
213 | repo.group:: | 256 | repo.group:: |
@@ -228,22 +271,43 @@ root-readme:: | |||
228 | value: none. | 271 | value: none. |
229 | 272 | ||
230 | root-title:: | 273 | root-title:: |
231 | Text printed as heading on the repository index page. Default value: | 274 | Text printed as heading on the repository index page. Default value: |
232 | "Git Repository Browser". | 275 | "Git Repository Browser". |
233 | 276 | ||
277 | scan-hidden-path:: | ||
278 | If set to "1" and scan-path is enabled, scan-path will recurse into | ||
279 | directories whose name starts with a period ('.'). Otherwise, | ||
280 | scan-path will stay away from such directories (considered as | ||
281 | "hidden"). Note that this does not apply to the ".git" directory in | ||
282 | non-bare repos. This must be defined prior to scan-path. | ||
283 | Default value: 0. See also: scan-path. | ||
284 | |||
234 | scan-path:: | 285 | scan-path:: |
235 | A path which will be scanned for repositories. If caching is enabled, | 286 | 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 | 287 | the result will be cached as a cgitrc include-file in the cache |
237 | directory. Default value: none. See also: cache-scanrc-ttl. | 288 | directory. If project-list has been defined prior to scan-path, |
289 | scan-path loads only the directories listed in the file pointed to by | ||
290 | project-list. Default value: none. See also: cache-scanrc-ttl, | ||
291 | project-list. | ||
238 | 292 | ||
239 | section:: | 293 | section:: |
240 | The name of the current repository section - all repositories defined | 294 | The name of the current repository section - all repositories defined |
241 | after this option will inherit the current section name. Default value: | 295 | after this option will inherit the current section name. Default value: |
242 | none. | 296 | none. |
243 | 297 | ||
298 | section-from-path:: | ||
299 | A number which, if specified before scan-path, specifies how many | ||
300 | path elements from each repo path to use as a default section name. | ||
301 | If negative, cgit will discard the specified number of path elements | ||
302 | above the repo directory. Default value: 0. | ||
303 | |||
304 | side-by-side-diffs:: | ||
305 | If set to "1" shows side-by-side diffs instead of unidiffs per | ||
306 | default. Default value: "0". | ||
307 | |||
244 | snapshots:: | 308 | snapshots:: |
245 | Text which specifies the default set of snapshot formats generated by | 309 | 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 | 310 | 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. | 311 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
248 | 312 | ||
249 | source-filter:: | 313 | source-filter:: |
@@ -263,12 +327,19 @@ summary-log:: | |||
263 | "summary" view. Default value: "10". | 327 | "summary" view. Default value: "10". |
264 | 328 | ||
265 | summary-tags:: | 329 | summary-tags:: |
266 | Specifies the number of tags to display in the repository "summary" | 330 | Specifies the number of tags to display in the repository "summary" |
267 | view. Default value: "10". | 331 | view. Default value: "10". |
268 | 332 | ||
333 | strict-export:: | ||
334 | Filename which, if specified, needs to be present within the repository | ||
335 | for cgit to allow access to that repository. This can be used to emulate | ||
336 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | ||
337 | repositories to match those exported by git-daemon. This option MUST come | ||
338 | before 'scan-path'. | ||
339 | |||
269 | virtual-root:: | 340 | virtual-root:: |
270 | Url which, if specified, will be used as root for all cgit links. It | 341 | Url which, if specified, will be used as root for all cgit links. It |
271 | will also cause cgit to generate 'virtual urls', i.e. urls like | 342 | will also cause cgit to generate 'virtual urls', i.e. urls like |
272 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 343 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
273 | value: none. | 344 | value: none. |
274 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 345 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
@@ -293,20 +364,41 @@ repo.defbranch:: | |||
293 | exists in the repository, the first branch name (when sorted) is used | 364 | exists in the repository, the first branch name (when sorted) is used |
294 | as default instead. Default value: "master". | 365 | as default instead. Default value: "master". |
295 | 366 | ||
296 | repo.desc:: | 367 | repo.desc:: |
297 | The value to show as repository description. Default value: none. | 368 | The value to show as repository description. Default value: none. |
298 | 369 | ||
370 | repo.enable-commit-graph:: | ||
371 | A flag which can be used to disable the global setting | ||
372 | `enable-commit-graph'. Default value: none. | ||
373 | |||
299 | repo.enable-log-filecount:: | 374 | repo.enable-log-filecount:: |
300 | A flag which can be used to disable the global setting | 375 | A flag which can be used to disable the global setting |
301 | `enable-log-filecount'. Default value: none. | 376 | `enable-log-filecount'. Default value: none. |
302 | 377 | ||
303 | repo.enable-log-linecount:: | 378 | repo.enable-log-linecount:: |
304 | A flag which can be used to disable the global setting | 379 | A flag which can be used to disable the global setting |
305 | `enable-log-linecount'. Default value: none. | 380 | `enable-log-linecount'. Default value: none. |
306 | 381 | ||
382 | repo.enable-remote-branches:: | ||
383 | Flag which, when set to "1", will make cgit display remote branches | ||
384 | in the summary and refs views. Default value: <enable-remote-branches>. | ||
385 | |||
386 | repo.enable-subject-links:: | ||
387 | A flag which can be used to override the global setting | ||
388 | `enable-subject-links'. Default value: none. | ||
389 | |||
390 | repo.logo:: | ||
391 | Url which specifies the source of an image which will be used as a logo | ||
392 | on this repo's pages. Default value: global logo. | ||
393 | |||
394 | repo.logo-link:: | ||
395 | Url loaded when clicking on the cgit logo image. If unspecified the | ||
396 | calculated url of the repository index page will be used. Default | ||
397 | value: global logo-link. | ||
398 | |||
307 | repo.max-stats:: | 399 | repo.max-stats:: |
308 | Override the default maximum statistics period. Valid values are equal | 400 | Override the default maximum statistics period. Valid values are equal |
309 | to the values specified for the global "max-stats" setting. Default | 401 | to the values specified for the global "max-stats" setting. Default |
310 | value: none. | 402 | value: none. |
311 | 403 | ||
312 | repo.name:: | 404 | repo.name:: |
@@ -319,13 +411,15 @@ repo.owner:: | |||
319 | repo.path:: | 411 | repo.path:: |
320 | An absolute path to the repository directory. For non-bare repositories | 412 | An absolute path to the repository directory. For non-bare repositories |
321 | this is the .git-directory. Default value: none. | 413 | this is the .git-directory. Default value: none. |
322 | 414 | ||
323 | repo.readme:: | 415 | repo.readme:: |
324 | A path (relative to <repo.path>) which specifies a file to include | 416 | A path (relative to <repo.path>) which specifies a file to include |
325 | verbatim as the "About" page for this repo. Default value: none. | 417 | verbatim as the "About" page for this repo. You may also specify a |
418 | git refspec by head or by hash by prepending the refspec followed by | ||
419 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | ||
326 | 420 | ||
327 | repo.snapshots:: | 421 | repo.snapshots:: |
328 | A mask of allowed snapshot-formats for this repo, restricted by the | 422 | A mask of allowed snapshot-formats for this repo, restricted by the |
329 | "snapshots" global setting. Default value: <snapshots>. | 423 | "snapshots" global setting. Default value: <snapshots>. |
330 | 424 | ||
331 | repo.section:: | 425 | repo.section:: |
@@ -360,22 +454,26 @@ EXAMPLE CGITRC FILE | |||
360 | .... | 454 | .... |
361 | # Enable caching of up to 1000 output entriess | 455 | # Enable caching of up to 1000 output entriess |
362 | cache-size=1000 | 456 | cache-size=1000 |
363 | 457 | ||
364 | 458 | ||
365 | # Specify some default clone prefixes | 459 | # Specify some default clone prefixes |
366 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 460 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git |
367 | 461 | ||
368 | # Specify the css url | 462 | # Specify the css url |
369 | css=/css/cgit.css | 463 | css=/css/cgit.css |
370 | 464 | ||
371 | 465 | ||
372 | # Show extra links for each repository on the index page | 466 | # Show extra links for each repository on the index page |
373 | enable-index-links=1 | 467 | enable-index-links=1 |
374 | 468 | ||
375 | 469 | ||
470 | # Enable ASCII art commit history graph on the log pages | ||
471 | enable-commit-graph=1 | ||
472 | |||
473 | |||
376 | # Show number of affected files per commit on the log pages | 474 | # Show number of affected files per commit on the log pages |
377 | enable-log-filecount=1 | 475 | enable-log-filecount=1 |
378 | 476 | ||
379 | 477 | ||
380 | # Show number of added/removed lines per commit on the log pages | 478 | # Show number of added/removed lines per commit on the log pages |
381 | enable-log-linecount=1 | 479 | enable-log-linecount=1 |
@@ -391,32 +489,32 @@ logo=/img/mylogo.png | |||
391 | 489 | ||
392 | # Enable statistics per week, month and quarter | 490 | # Enable statistics per week, month and quarter |
393 | max-stats=quarter | 491 | max-stats=quarter |
394 | 492 | ||
395 | 493 | ||
396 | # Set the title and heading of the repository index page | 494 | # Set the title and heading of the repository index page |
397 | root-title=foobar.com git repositories | 495 | root-title=example.com git repositories |
398 | 496 | ||
399 | 497 | ||
400 | # Set a subheading for the repository index page | 498 | # Set a subheading for the repository index page |
401 | root-desc=tracking the foobar development | 499 | root-desc=tracking the foobar development |
402 | 500 | ||
403 | 501 | ||
404 | # Include some more info about foobar.com on the index page | 502 | # Include some more info about example.com on the index page |
405 | root-readme=/var/www/htdocs/about.html | 503 | root-readme=/var/www/htdocs/about.html |
406 | 504 | ||
407 | 505 | ||
408 | # Allow download of tar.gz, tar.bz2 and zip-files | 506 | # Allow download of tar.gz, tar.bz2 and zip-files |
409 | snapshots=tar.gz tar.bz2 zip | 507 | snapshots=tar.gz tar.bz2 zip |
410 | 508 | ||
411 | 509 | ||
412 | ## | 510 | ## |
413 | ## List of common mimetypes | 511 | ## List of common mimetypes |
414 | ## | 512 | ## |
415 | 513 | ||
416 | mimetype.git=image/git | 514 | mimetype.gif=image/gif |
417 | mimetype.html=text/html | 515 | mimetype.html=text/html |
418 | mimetype.jpg=image/jpeg | 516 | mimetype.jpg=image/jpeg |
419 | mimetype.jpeg=image/jpeg | 517 | mimetype.jpeg=image/jpeg |
420 | mimetype.pdf=application/pdf | 518 | mimetype.pdf=application/pdf |
421 | mimetype.png=image/png | 519 | mimetype.png=image/png |
422 | mimetype.svg=image/svg+xml | 520 | mimetype.svg=image/svg+xml |
@@ -432,20 +530,20 @@ mimetype.svg=image/svg+xml | |||
432 | ## | 530 | ## |
433 | 531 | ||
434 | 532 | ||
435 | repo.url=foo | 533 | repo.url=foo |
436 | repo.path=/pub/git/foo.git | 534 | repo.path=/pub/git/foo.git |
437 | repo.desc=the master foo repository | 535 | repo.desc=the master foo repository |
438 | repo.owner=fooman@foobar.com | 536 | repo.owner=fooman@example.com |
439 | repo.readme=info/web/about.html | 537 | repo.readme=info/web/about.html |
440 | 538 | ||
441 | 539 | ||
442 | repo.url=bar | 540 | repo.url=bar |
443 | repo.path=/pub/git/bar.git | 541 | repo.path=/pub/git/bar.git |
444 | repo.desc=the bars for your foo | 542 | repo.desc=the bars for your foo |
445 | repo.owner=barman@foobar.com | 543 | repo.owner=barman@example.com |
446 | repo.readme=info/web/about.html | 544 | repo.readme=info/web/about.html |
447 | 545 | ||
448 | 546 | ||
449 | # The next repositories will be displayed under the 'extras' heading | 547 | # The next repositories will be displayed under the 'extras' heading |
450 | section=extras | 548 | section=extras |
451 | 549 | ||
@@ -496,6 +594,7 @@ will generate the following html element: | |||
496 | 594 | ||
497 | 595 | ||
498 | 596 | ||
499 | AUTHOR | 597 | AUTHOR |
500 | ------ | 598 | ------ |
501 | Lars Hjemli <hjemli@gmail.com> | 599 | Lars Hjemli <hjemli@gmail.com> |
600 | Jason A. Donenfeld <Jason@zx2c4.com> | ||