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-filter-overrides::
 95	Flag which, when set to "1", allows all filter settings to be
 96	overridden in repository-specific cgitrc files. Default value: none.
 97
 98enable-index-links::
 99	Flag which, when set to "1", will make cgit generate extra links for
100	each repo in the repository index (specifically, to the "summary",
101	"commit" and "tree" pages). Default value: "0".
102
103enable-log-filecount::
104	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
106	value: "0".
107
108enable-log-linecount::
109	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
111	value: "0".
112
113enable-remote-branches::
114	Flag which, when set to "1", will make cgit display remote branches
115	in the summary and refs views. Default value: "0". See also:
116	"repo.enable-remote-branches".
117
118enable-tree-linenumbers::
119	Flag which, when set to "1", will make cgit generate linenumber links
120	for plaintext blobs printed in the tree view. Default value: "1".
121
122favicon::
123	Url used as link to a shortcut icon for cgit. If specified, it is
124	suggested to use the value "/favicon.ico" since certain browsers will
125	ignore other values. Default value: none.
126
127footer::
128	The content of the file specified with this option will be included
129	verbatim at the bottom of all pages (i.e. it replaces the standard
130	"generated by..." message. Default value: none.
131
132head-include::
133	The content of the file specified with this option will be included
134	verbatim in the html HEAD section on all pages. Default value: none.
135
136header::
137	The content of the file specified with this option will be included
138	verbatim at the top of all pages. Default value: none.
139
140include::
141	Name of a configfile to include before the rest of the current config-
142	file is parsed. Default value: none.
143
144index-header::
145	The content of the file specified with this option will be included
146	verbatim above the repository index. This setting is deprecated, and
147	will not be supported by cgit-1.0 (use root-readme instead). Default
148	value: none.
149
150index-info::
151	The content of the file specified with this option will be included
152	verbatim below the heading on the repository index page. This setting
153	is deprecated, and will not be supported by cgit-1.0 (use root-desc
154	instead). Default value: none.
155
156local-time::
157	Flag which, if set to "1", makes cgit print commit and tag times in the
158	servers timezone. Default value: "0".
159
160logo::
161	Url which specifies the source of an image which will be used as a logo
162	on all cgit pages. Default value: "/cgit.png".
163
164logo-link::
165	Url loaded when clicking on the cgit logo image. If unspecified the
166	calculated url of the repository index page will be used. Default
167	value: none.
168
169max-commit-count::
170	Specifies the number of entries to list per page in "log" view. Default
171	value: "50".
172
173max-message-length::
174	Specifies the maximum number of commit message characters to display in
175	"log" view. Default value: "80".
176
177max-repo-count::
178	Specifies the number of entries to list per page on the	repository
179	index page. Default value: "50".
180
181max-repodesc-length::
182	Specifies the maximum number of repo description characters to display
183	on the repository index page. Default value: "80".
184
185max-blob-size::
186	Specifies the maximum size of a blob to display HTML for in KBytes.
187	Default value: "0" (limit disabled).
188
189max-stats::
190	Set the default maximum statistics period. Valid values are "week",
191	"month", "quarter" and "year". If unspecified, statistics are
192	disabled. Default value: none. See also: "repo.max-stats".
193
194mimetype.<ext>::
195	Set the mimetype for the specified filename extension. This is used
196	by the `plain` command when returning blob content.
197
198module-link::
199	Text which will be used as the formatstring for a hyperlink when a
200	submodule is printed in a directory listing. The arguments for the
201	formatstring are the path and SHA1 of the submodule commit. Default
202	value: "./?repo=%s&page=commit&id=%s"
203
204nocache::
205	If set to the value "1" caching will be disabled. This settings is
206	deprecated, and will not be honored starting with cgit-1.0. Default
207	value: "0".
208
209noplainemail::
210	If set to "1" showing full author email adresses will be disabled.
211	Default value: "0".
212
213noheader::
214	Flag which, when set to "1", will make cgit omit the standard header
215	on all pages. Default value: none. See also: "embedded".
216
217renamelimit::
218	Maximum number of files to consider when detecting renames. The value
219	 "-1" uses the compiletime value in git (for further info, look at
220	  `man git-diff`). Default value: "-1".
221
222repo.group::
223	Legacy alias for "section". This option is deprecated and will not be
224	supported in cgit-1.0.
225
226robots::
227	Text used as content for the "robots" meta-tag. Default value:
228	"index, nofollow".
229
230root-desc::
231	Text printed below the heading on the repository index page. Default
232	value: "a fast webinterface for the git dscm".
233
234root-readme::
235	The content of the file specified with this option will be included
236	verbatim below the "about" link on the repository index page. Default
237	value: none.
238
239root-title::
240	Text printed as heading on the repository index page. Default value:
241	"Git Repository Browser".
242
243scan-path::
244	A path which will be scanned for repositories. If caching is enabled,
245	the result will be cached as a cgitrc include-file in the cache
246	directory. Default value: none. See also: cache-scanrc-ttl.
247
248section::
249	The name of the current repository section - all repositories defined
250	after this option will inherit the current section name. Default value:
251	none.
252
253side-by-side-diffs::
254	If set to "1" shows side-by-side diffs instead of unidiffs per
255	default. Default value: "0".
256
257snapshots::
258	Text which specifies the default set of snapshot formats generated by
259	cgit. The value is a space-separated list of zero or more of the
260	values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
261
262source-filter::
263	Specifies a command which will be invoked to format plaintext blobs
264	in the tree view. The command will get the blob content on its STDIN
265	and the name of the blob as its only command line argument. The STDOUT
266	from the command will be included verbatim as the blob contents, i.e.
267	this can be used to implement e.g. syntax highlighting. Default value:
268	none.
269
270summary-branches::
271	Specifies the number of branches to display in the repository "summary"
272	view. Default value: "10".
273
274summary-log::
275	Specifies the number of log entries to display in the repository
276	"summary" view. Default value: "10".
277
278summary-tags::
279	Specifies the number of tags to display in the repository "summary"
280	view. Default value: "10".
281
282virtual-root::
283	Url which, if specified, will be used as root for all cgit links. It
284	will also cause cgit to generate 'virtual urls', i.e. urls like
285	'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
286	value: none.
287	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
288	same kind of virtual urls, so this option will probably be deprecated.
289
290REPOSITORY SETTINGS
291-------------------
292repo.about-filter::
293	Override the default about-filter. Default value: none. See also:
294	"enable-filter-overrides".
295
296repo.clone-url::
297	A list of space-separated urls which can be used to clone this repo.
298	Default value: none.
299
300repo.commit-filter::
301	Override the default commit-filter. Default value: none. See also:
302	"enable-filter-overrides".
303
304repo.defbranch::
305	The name of the default branch for this repository. If no such branch
306	exists in the repository, the first branch name (when sorted) is used
307	as default instead. Default value: "master".
308
309repo.desc::
310	The value to show as repository description. Default value: none.
311
312repo.enable-log-filecount::
313	A flag which can be used to disable the global setting
314	`enable-log-filecount'. Default value: none.
315
316repo.enable-log-linecount::
317	A flag which can be used to disable the global setting
318	`enable-log-linecount'. Default value: none.
319
320repo.enable-remote-branches::
321	Flag which, when set to "1", will make cgit display remote branches
322	in the summary and refs views. Default value: <enable-remote-branches>.
323
324repo.max-stats::
325	Override the default maximum statistics period. Valid values are equal
326	to the values specified for the global "max-stats" setting. Default
327	value: none.
328
329repo.name::
330	The value to show as repository name. Default value: <repo.url>.
331
332repo.owner::
333	A value used to identify the owner of the repository. Default value:
334	none.
335
336repo.path::
337	An absolute path to the repository directory. For non-bare repositories
338	this is the .git-directory. Default value: none.
339
340repo.readme::
341	A path (relative to <repo.path>) which specifies a file to include
342	verbatim as the "About" page for this repo. Default value: none.
343
344repo.snapshots::
345	A mask of allowed snapshot-formats for this repo, restricted by the
346	"snapshots" global setting. Default value: <snapshots>.
347
348repo.section::
349	Override the current section name for this repository. Default value:
350	none.
351
352repo.source-filter::
353	Override the default source-filter. Default value: none. See also:
354	"enable-filter-overrides".
355
356repo.url::
357	The relative url used to access the repository. This must be the first
358	setting specified for each repo. Default value: none.
359
360
361REPOSITORY-SPECIFIC CGITRC FILE
362-------------------------------
363When the option "scan-path" is used to auto-discover git repositories, cgit
364will try to parse the file "cgitrc" within any found repository. Such a
365repo-specific config file may contain any of the repo-specific options
366described above, except "repo.url" and "repo.path". Additionally, the "filter"
367options are only acknowledged in repo-specific config files when
368"enable-filter-overrides" is set to "1".
369
370Note: the "repo." prefix is dropped from the option names in repo-specific
371config files, e.g. "repo.desc" becomes "desc".
372
373
374EXAMPLE CGITRC FILE
375-------------------
376
377....
378# Enable caching of up to 1000 output entriess
379cache-size=1000
380
381
382# Specify some default clone prefixes
383clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
384
385# Specify the css url
386css=/css/cgit.css
387
388
389# Show extra links for each repository on the index page
390enable-index-links=1
391
392
393# Show number of affected files per commit on the log pages
394enable-log-filecount=1
395
396
397# Show number of added/removed lines per commit on the log pages
398enable-log-linecount=1
399
400
401# Add a cgit favicon
402favicon=/favicon.ico
403
404
405# Use a custom logo
406logo=/img/mylogo.png
407
408
409# Enable statistics per week, month and quarter
410max-stats=quarter
411
412
413# Set the title and heading of the repository index page
414root-title=foobar.com git repositories
415
416
417# Set a subheading for the repository index page
418root-desc=tracking the foobar development
419
420
421# Include some more info about foobar.com on the index page
422root-readme=/var/www/htdocs/about.html
423
424
425# Allow download of tar.gz, tar.bz2 and zip-files
426snapshots=tar.gz tar.bz2 zip
427
428
429##
430## List of common mimetypes
431##
432
433mimetype.gif=image/gif
434mimetype.html=text/html
435mimetype.jpg=image/jpeg
436mimetype.jpeg=image/jpeg
437mimetype.pdf=application/pdf
438mimetype.png=image/png
439mimetype.svg=image/svg+xml
440
441
442##
443## List of repositories.
444## PS: Any repositories listed when section is unset will not be
445##     displayed under a section heading
446## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
447##      and included like this:
448##        include=/etc/cgitrepos
449##
450
451
452repo.url=foo
453repo.path=/pub/git/foo.git
454repo.desc=the master foo repository
455repo.owner=fooman@foobar.com
456repo.readme=info/web/about.html
457
458
459repo.url=bar
460repo.path=/pub/git/bar.git
461repo.desc=the bars for your foo
462repo.owner=barman@foobar.com
463repo.readme=info/web/about.html
464
465
466# The next repositories will be displayed under the 'extras' heading
467section=extras
468
469
470repo.url=baz
471repo.path=/pub/git/baz.git
472repo.desc=a set of extensions for bar users
473
474repo.url=wiz
475repo.path=/pub/git/wiz.git
476repo.desc=the wizard of foo
477
478
479# Add some mirrored repositories
480section=mirrors
481
482
483repo.url=git
484repo.path=/pub/git/git.git
485repo.desc=the dscm
486
487
488repo.url=linux
489repo.path=/pub/git/linux.git
490repo.desc=the kernel
491
492# Disable adhoc downloads of this repo
493repo.snapshots=0
494
495# Disable line-counts for this repo
496repo.enable-log-linecount=0
497
498# Restrict the max statistics period for this repo
499repo.max-stats=month
500....
501
502
503BUGS
504----
505Comments currently cannot appear on the same line as a setting; the comment
506will be included as part of the value. E.g. this line:
507
508	robots=index  # allow indexing
509
510will generate the following html element:
511
512	<meta name='robots' content='index  # allow indexing'/>
513
514
515
516AUTHOR
517------
518Lars Hjemli <hjemli@gmail.com>