1:man source:   cgit
  2:man manual:   cgit
  3
  4CGITRC(5)
  5========
  6
  7
  8NAME
  9----
 10cgitrc - runtime configuration for cgit
 11
 12
 13SYNOPSIS
 14--------
 15Cgitrc contains all runtime settings for cgit, including the list of git
 16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 17lines, and lines starting with '#', are ignored.
 18
 19
 20LOCATION
 21--------
 22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
 23runtime, cgit will consult the environment variable CGIT_CONFIG and, if
 24defined, use its value instead.
 25
 26
 27GLOBAL SETTINGS
 28---------------
 29about-filter::
 30	Specifies a command which will be invoked to format the content of
 31	about pages (both top-level and for each repository). The command will
 32	get the content of the about-file on its STDIN, and the STDOUT from the
 33	command will be included verbatim on the about page. Default value:
 34	none.
 35
 36agefile::
 37	Specifies a path, relative to each repository path, which can be used
 38	to specify the date and time of the youngest commit in the repository.
 39	The first line in the file is used as input to the "parse_date"
 40	function in libgit. Recommended timestamp-format is "yyyy-mm-dd
 41	hh:mm:ss". Default value: "info/web/last-modified".
 42
 43cache-root::
 44	Path used to store the cgit cache entries. Default value:
 45	"/var/cache/cgit".
 46
 47cache-dynamic-ttl::
 48	Number which specifies the time-to-live, in minutes, for the cached
 49	version of repository pages accessed without a fixed SHA1. Default
 50	value: "5".
 51
 52cache-repo-ttl::
 53	Number which specifies the time-to-live, in minutes, for the cached
 54	version of the repository summary page. Default value: "5".
 55
 56cache-root-ttl::
 57	Number which specifies the time-to-live, in minutes, for the cached
 58	version of the repository index page. Default value: "5".
 59
 60cache-scanrc-ttl::
 61	Number which specifies the time-to-live, in minutes, for the result
 62	of scanning a path for git repositories. Default value: "15".
 63
 64cache-size::
 65	The maximum number of entries in the cgit cache. Default value: "0"
 66	(i.e. caching is disabled).
 67
 68cache-static-ttl::
 69	Number which specifies the time-to-live, in minutes, for the cached
 70	version of repository pages accessed with a fixed SHA1. Default value:
 71	"5".
 72
 73clone-prefix::
 74	Space-separated list of common prefixes which, when combined with a
 75	repository url, generates valid clone urls for the repository. This
 76	setting is only used if `repo.clone-url` is unspecified. Default value:
 77	none.
 78
 79commit-filter::
 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
 82	command will be included verbatim as the commit message, i.e. this can
 83	be used to implement bugtracker integration. Default value: none.
 84
 85css::
 86	Url which specifies the css document to include in all cgit pages.
 87	Default value: "/cgit.css".
 88
 89embedded::
 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
 92	also: "noheader".
 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
 99enable-filter-overrides::
100	Flag which, when set to "1", allows all filter settings to be
101	overridden in repository-specific cgitrc files. Default value: none.
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
108enable-http-clone::
109	If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
110	If you use an alternate way of serving git repositories, you may wish
111	to disable this. Default value: "1".
112
113enable-index-links::
114	Flag which, when set to "1", will make cgit generate extra links for
115	each repo in the repository index (specifically, to the "summary",
116	"commit" and "tree" pages). Default value: "0".
117
118enable-log-filecount::
119	Flag which, when set to "1", will make cgit print the number of
120	modified files for each commit on the repository log page. Default
121	value: "0".
122
123enable-log-linecount::
124	Flag which, when set to "1", will make cgit print the number of added
125	and removed lines for each commit on the repository log page. Default
126	value: "0".
127
128enable-remote-branches::
129	Flag which, when set to "1", will make cgit display remote branches
130	in the summary and refs views. Default value: "0". See also:
131	"repo.enable-remote-branches".
132
133enable-subject-links::
134	Flag which, when set to "1", will make cgit use the subject of the
135	parent commit as link text when generating links to parent commits
136	in commit view. Default value: "0". See also:
137	"repo.enable-subject-links".
138
139enable-tree-linenumbers::
140	Flag which, when set to "1", will make cgit generate linenumber links
141	for plaintext blobs printed in the tree view. Default value: "1".
142
143favicon::
144	Url used as link to a shortcut icon for cgit. If specified, it is
145	suggested to use the value "/favicon.ico" since certain browsers will
146	ignore other values. Default value: none.
147
148footer::
149	The content of the file specified with this option will be included
150	verbatim at the bottom of all pages (i.e. it replaces the standard
151	"generated by..." message. Default value: none.
152
153head-include::
154	The content of the file specified with this option will be included
155	verbatim in the html HEAD section on all pages. Default value: none.
156
157header::
158	The content of the file specified with this option will be included
159	verbatim at the top of all pages. Default value: none.
160
161include::
162	Name of a configfile to include before the rest of the current config-
163	file is parsed. Default value: none.
164
165index-header::
166	The content of the file specified with this option will be included
167	verbatim above the repository index. This setting is deprecated, and
168	will not be supported by cgit-1.0 (use root-readme instead). Default
169	value: none.
170
171index-info::
172	The content of the file specified with this option will be included
173	verbatim below the heading on the repository index page. This setting
174	is deprecated, and will not be supported by cgit-1.0 (use root-desc
175	instead). Default value: none.
176
177local-time::
178	Flag which, if set to "1", makes cgit print commit and tag times in the
179	servers timezone. Default value: "0".
180
181logo::
182	Url which specifies the source of an image which will be used as a logo
183	on all cgit pages. Default value: "/cgit.png".
184
185logo-link::
186	Url loaded when clicking on the cgit logo image. If unspecified the
187	calculated url of the repository index page will be used. Default
188	value: none.
189
190max-atom-items::
191	Specifies the number of items to display in atom feeds view. Default
192	value: "10".
193
194max-commit-count::
195	Specifies the number of entries to list per page in "log" view. Default
196	value: "50".
197
198max-message-length::
199	Specifies the maximum number of commit message characters to display in
200	"log" view. Default value: "80".
201
202max-repo-count::
203	Specifies the number of entries to list per page on the	repository
204	index page. Default value: "50".
205
206max-repodesc-length::
207	Specifies the maximum number of repo description characters to display
208	on the repository index page. Default value: "80".
209
210max-blob-size::
211	Specifies the maximum size of a blob to display HTML for in KBytes.
212	Default value: "0" (limit disabled).
213
214max-stats::
215	Set the default maximum statistics period. Valid values are "week",
216	"month", "quarter" and "year". If unspecified, statistics are
217	disabled. Default value: none. See also: "repo.max-stats".
218
219mimetype.<ext>::
220	Set the mimetype for the specified filename extension. This is used
221	by the `plain` command when returning blob content.
222
223module-link::
224	Text which will be used as the formatstring for a hyperlink when a
225	submodule is printed in a directory listing. The arguments for the
226	formatstring are the path and SHA1 of the submodule commit. Default
227	value: "./?repo=%s&page=commit&id=%s"
228
229nocache::
230	If set to the value "1" caching will be disabled. This settings is
231	deprecated, and will not be honored starting with cgit-1.0. Default
232	value: "0".
233
234noplainemail::
235	If set to "1" showing full author email adresses will be disabled.
236	Default value: "0".
237
238noheader::
239	Flag which, when set to "1", will make cgit omit the standard header
240	on all pages. Default value: none. See also: "embedded".
241
242project-list::
243	A list of subdirectories inside of scan-path, relative to it, that
244	should loaded as git repositories. This must be defined prior to
245	scan-path. Default value: none. See also: scan-path.
246
247readme::
248	Text which will be used as default value for "repo.readme". Default
249	value: none.
250
251remove-suffix::
252	If set to "1" and scan-path is enabled, if any repositories are found
253	with a suffix of ".git", this suffix will be removed for the url and
254	name. Default value: "0". See also: scan-path.
255
256renamelimit::
257	Maximum number of files to consider when detecting renames. The value
258	 "-1" uses the compiletime value in git (for further info, look at
259	  `man git-diff`). Default value: "-1".
260
261repo.group::
262	Legacy alias for "section". This option is deprecated and will not be
263	supported in cgit-1.0.
264
265robots::
266	Text used as content for the "robots" meta-tag. Default value:
267	"index, nofollow".
268
269root-desc::
270	Text printed below the heading on the repository index page. Default
271	value: "a fast webinterface for the git dscm".
272
273root-readme::
274	The content of the file specified with this option will be included
275	verbatim below the "about" link on the repository index page. Default
276	value: none.
277
278root-title::
279	Text printed as heading on the repository index page. Default value:
280	"Git Repository Browser".
281
282scan-hidden-path::
283	If set to "1" and scan-path is enabled, scan-path will recurse into
284	directories whose name starts with a period ('.'). Otherwise,
285	scan-path will stay away from such directories (considered as
286	"hidden"). Note that this does not apply to the ".git" directory in
287	non-bare repos. This must be defined prior to scan-path.
288	Default value: 0. See also: scan-path.
289
290scan-path::
291	A path which will be scanned for repositories. If caching is enabled,
292	the result will be cached as a cgitrc include-file in the cache
293	directory. If project-list has been defined prior to scan-path,
294	scan-path loads only the directories listed in the file pointed to by
295	project-list. Be advised that only the global settings taken
296	before the scan-path directive will be applied to each repository.
297	Default value: none. See also: cache-scanrc-ttl, project-list.
298
299section::
300	The name of the current repository section - all repositories defined
301	after this option will inherit the current section name. Default value:
302	none.
303
304section-from-path::
305	A number which, if specified before scan-path, specifies how many
306	path elements from each repo path to use as a default section name.
307	If negative, cgit will discard the specified number of path elements
308	above the repo directory. Default value: 0.
309
310side-by-side-diffs::
311	If set to "1" shows side-by-side diffs instead of unidiffs per
312	default. Default value: "0".
313
314snapshots::
315	Text which specifies the default set of snapshot formats generated by
316	cgit. The value is a space-separated list of zero or more of the
317	values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
318	none.
319
320source-filter::
321	Specifies a command which will be invoked to format plaintext blobs
322	in the tree view. The command will get the blob content on its STDIN
323	and the name of the blob as its only command line argument. The STDOUT
324	from the command will be included verbatim as the blob contents, i.e.
325	this can be used to implement e.g. syntax highlighting. Default value:
326	none.
327
328summary-branches::
329	Specifies the number of branches to display in the repository "summary"
330	view. Default value: "10".
331
332summary-log::
333	Specifies the number of log entries to display in the repository
334	"summary" view. Default value: "10".
335
336summary-tags::
337	Specifies the number of tags to display in the repository "summary"
338	view. Default value: "10".
339
340strict-export::
341	Filename which, if specified, needs to be present within the repository
342	for cgit to allow access to that repository. This can be used to emulate
343	gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
344	repositories to match those exported by git-daemon. This option MUST come
345	before 'scan-path'.
346
347virtual-root::
348	Url which, if specified, will be used as root for all cgit links. It
349	will also cause cgit to generate 'virtual urls', i.e. urls like
350	'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
351	value: none.
352	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
353	same kind of virtual urls, so this option will probably be deprecated.
354
355REPOSITORY SETTINGS
356-------------------
357repo.about-filter::
358	Override the default about-filter. Default value: none. See also:
359	"enable-filter-overrides".
360
361repo.clone-url::
362	A list of space-separated urls which can be used to clone this repo.
363	Default value: none.
364
365repo.commit-filter::
366	Override the default commit-filter. Default value: none. See also:
367	"enable-filter-overrides".
368
369repo.defbranch::
370	The name of the default branch for this repository. If no such branch
371	exists in the repository, the first branch name (when sorted) is used
372	as default instead. Default value: "master".
373
374repo.desc::
375	The value to show as repository description. Default value: none.
376
377repo.enable-commit-graph::
378	A flag which can be used to disable the global setting
379	`enable-commit-graph'. Default value: none.
380
381repo.enable-log-filecount::
382	A flag which can be used to disable the global setting
383	`enable-log-filecount'. Default value: none.
384
385repo.enable-log-linecount::
386	A flag which can be used to disable the global setting
387	`enable-log-linecount'. Default value: none.
388
389repo.enable-remote-branches::
390	Flag which, when set to "1", will make cgit display remote branches
391	in the summary and refs views. Default value: <enable-remote-branches>.
392
393repo.enable-subject-links::
394	A flag which can be used to override the global setting
395	`enable-subject-links'. Default value: none.
396
397repo.logo::
398	Url which specifies the source of an image which will be used as a logo
399	on this repo's pages. Default value: global logo.
400
401repo.logo-link::
402	Url loaded when clicking on the cgit logo image. If unspecified the
403	calculated url of the repository index page will be used. Default
404	value: global logo-link.
405
406repo.max-stats::
407	Override the default maximum statistics period. Valid values are equal
408	to the values specified for the global "max-stats" setting. Default
409	value: none.
410
411repo.name::
412	The value to show as repository name. Default value: <repo.url>.
413
414repo.owner::
415	A value used to identify the owner of the repository. Default value:
416	none.
417
418repo.path::
419	An absolute path to the repository directory. For non-bare repositories
420	this is the .git-directory. Default value: none.
421
422repo.readme::
423	A path (relative to <repo.path>) which specifies a file to include
424	verbatim as the "About" page for this repo. You may also specify a
425	git refspec by head or by hash by prepending the refspec followed by
426	a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
427
428repo.snapshots::
429	A mask of allowed snapshot-formats for this repo, restricted by the
430	"snapshots" global setting. Default value: <snapshots>.
431
432repo.section::
433	Override the current section name for this repository. Default value:
434	none.
435
436repo.source-filter::
437	Override the default source-filter. Default value: none. See also:
438	"enable-filter-overrides".
439
440repo.url::
441	The relative url used to access the repository. This must be the first
442	setting specified for each repo. Default value: none.
443
444
445REPOSITORY-SPECIFIC CGITRC FILE
446-------------------------------
447When the option "scan-path" is used to auto-discover git repositories, cgit
448will try to parse the file "cgitrc" within any found repository. Such a
449repo-specific config file may contain any of the repo-specific options
450described above, except "repo.url" and "repo.path". Additionally, the "filter"
451options are only acknowledged in repo-specific config files when
452"enable-filter-overrides" is set to "1".
453
454Note: the "repo." prefix is dropped from the option names in repo-specific
455config files, e.g. "repo.desc" becomes "desc".
456
457
458EXAMPLE CGITRC FILE
459-------------------
460
461....
462# Enable caching of up to 1000 output entriess
463cache-size=1000
464
465
466# Specify some default clone prefixes
467clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
468
469# Specify the css url
470css=/css/cgit.css
471
472
473# Show extra links for each repository on the index page
474enable-index-links=1
475
476
477# Enable ASCII art commit history graph on the log pages
478enable-commit-graph=1
479
480
481# Show number of affected files per commit on the log pages
482enable-log-filecount=1
483
484
485# Show number of added/removed lines per commit on the log pages
486enable-log-linecount=1
487
488
489# Add a cgit favicon
490favicon=/favicon.ico
491
492
493# Use a custom logo
494logo=/img/mylogo.png
495
496
497# Enable statistics per week, month and quarter
498max-stats=quarter
499
500
501# Set the title and heading of the repository index page
502root-title=example.com git repositories
503
504
505# Set a subheading for the repository index page
506root-desc=tracking the foobar development
507
508
509# Include some more info about example.com on the index page
510root-readme=/var/www/htdocs/about.html
511
512
513# Allow download of tar.gz, tar.bz2 and zip-files
514snapshots=tar.gz tar.bz2 zip
515
516
517##
518## List of common mimetypes
519##
520
521mimetype.gif=image/gif
522mimetype.html=text/html
523mimetype.jpg=image/jpeg
524mimetype.jpeg=image/jpeg
525mimetype.pdf=application/pdf
526mimetype.png=image/png
527mimetype.svg=image/svg+xml
528
529
530##
531## List of repositories.
532## PS: Any repositories listed when section is unset will not be
533##     displayed under a section heading
534## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
535##      and included like this:
536##        include=/etc/cgitrepos
537##
538
539
540repo.url=foo
541repo.path=/pub/git/foo.git
542repo.desc=the master foo repository
543repo.owner=fooman@example.com
544repo.readme=info/web/about.html
545
546
547repo.url=bar
548repo.path=/pub/git/bar.git
549repo.desc=the bars for your foo
550repo.owner=barman@example.com
551repo.readme=info/web/about.html
552
553
554# The next repositories will be displayed under the 'extras' heading
555section=extras
556
557
558repo.url=baz
559repo.path=/pub/git/baz.git
560repo.desc=a set of extensions for bar users
561
562repo.url=wiz
563repo.path=/pub/git/wiz.git
564repo.desc=the wizard of foo
565
566
567# Add some mirrored repositories
568section=mirrors
569
570
571repo.url=git
572repo.path=/pub/git/git.git
573repo.desc=the dscm
574
575
576repo.url=linux
577repo.path=/pub/git/linux.git
578repo.desc=the kernel
579
580# Disable adhoc downloads of this repo
581repo.snapshots=0
582
583# Disable line-counts for this repo
584repo.enable-log-linecount=0
585
586# Restrict the max statistics period for this repo
587repo.max-stats=month
588....
589
590
591BUGS
592----
593Comments currently cannot appear on the same line as a setting; the comment
594will be included as part of the value. E.g. this line:
595
596	robots=index  # allow indexing
597
598will generate the following html element:
599
600	<meta name='robots' content='index  # allow indexing'/>
601
602
603
604AUTHOR
605------
606Lars Hjemli <hjemli@gmail.com>
607Jason A. Donenfeld <Jason@zx2c4.com>