aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt117
1 files changed, 108 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..c3698a6 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -90,11 +90,21 @@ 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
94enable-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
94enable-filter-overrides:: 99enable-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
103enable-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
98enable-index-links:: 108enable-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",
@@ -110,6 +120,17 @@ enable-log-linecount::
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
123enable-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
128enable-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
113enable-tree-linenumbers:: 134enable-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".
@@ -161,6 +182,10 @@ logo-link::
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
185max-atom-items::
186 Specifies the number of items to display in atom feeds view. Default
187 value: "10".
188
164max-commit-count:: 189max-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".
@@ -177,6 +202,10 @@ 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
205max-blob-size::
206 Specifies the maximum size of a blob to display HTML for in KBytes.
207 Default value: "0" (limit disabled).
208
180max-stats:: 209max-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
@@ -205,6 +234,20 @@ 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
237project-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
242readme::
243 Text which will be used as default value for "repo.readme". Default
244 value: none.
245
246remove-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
208renamelimit:: 251renamelimit::
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
@@ -231,16 +274,37 @@ 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
277scan-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
234scan-path:: 285scan-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
239section:: 293section::
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
298section-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
304side-by-side-diffs::
305 If set to "1" shows side-by-side diffs instead of unidiffs per
306 default. Default value: "0".
307
244snapshots:: 308snapshots::
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
@@ -266,6 +330,13 @@ 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
333strict-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
269virtual-root:: 340virtual-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
@@ -296,6 +367,10 @@ repo.defbranch::
296repo.desc:: 367repo.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
370repo.enable-commit-graph::
371 A flag which can be used to disable the global setting
372 `enable-commit-graph'. Default value: none.
373
299repo.enable-log-filecount:: 374repo.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.
@@ -304,6 +379,23 @@ 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
382repo.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
386repo.enable-subject-links::
387 A flag which can be used to override the global setting
388 `enable-subject-links'. Default value: none.
389
390repo.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
394repo.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
307repo.max-stats:: 399repo.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
@@ -322,7 +414,9 @@ repo.path::
322 414
323repo.readme:: 415repo.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
327repo.snapshots:: 421repo.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
@@ -363,7 +457,7 @@ cache-size=1000
363 457
364 458
365# Specify some default clone prefixes 459# Specify some default clone prefixes
366clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 460clone-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
369css=/css/cgit.css 463css=/css/cgit.css
@@ -373,6 +467,10 @@ css=/css/cgit.css
373enable-index-links=1 467enable-index-links=1
374 468
375 469
470# Enable ASCII art commit history graph on the log pages
471enable-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
377enable-log-filecount=1 475enable-log-filecount=1
378 476
@@ -394,14 +492,14 @@ 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
397root-title=foobar.com git repositories 495root-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
401root-desc=tracking the foobar development 499root-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
405root-readme=/var/www/htdocs/about.html 503root-readme=/var/www/htdocs/about.html
406 504
407 505
@@ -413,7 +511,7 @@ snapshots=tar.gz tar.bz2 zip
413## List of common mimetypes 511## List of common mimetypes
414## 512##
415 513
416mimetype.git=image/git 514mimetype.gif=image/gif
417mimetype.html=text/html 515mimetype.html=text/html
418mimetype.jpg=image/jpeg 516mimetype.jpg=image/jpeg
419mimetype.jpeg=image/jpeg 517mimetype.jpeg=image/jpeg
@@ -435,14 +533,14 @@ mimetype.svg=image/svg+xml
435repo.url=foo 533repo.url=foo
436repo.path=/pub/git/foo.git 534repo.path=/pub/git/foo.git
437repo.desc=the master foo repository 535repo.desc=the master foo repository
438repo.owner=fooman@foobar.com 536repo.owner=fooman@example.com
439repo.readme=info/web/about.html 537repo.readme=info/web/about.html
440 538
441 539
442repo.url=bar 540repo.url=bar
443repo.path=/pub/git/bar.git 541repo.path=/pub/git/bar.git
444repo.desc=the bars for your foo 542repo.desc=the bars for your foo
445repo.owner=barman@foobar.com 543repo.owner=barman@example.com
446repo.readme=info/web/about.html 544repo.readme=info/web/about.html
447 545
448 546
@@ -499,3 +597,4 @@ will generate the following html element:
499AUTHOR 597AUTHOR
500------ 598------
501Lars Hjemli <hjemli@gmail.com> 599Lars Hjemli <hjemli@gmail.com>
600Jason A. Donenfeld <Jason@zx2c4.com>