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