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. See also: "FILTER API".
 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". See also: "MACRO EXPANSION".
 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
 79clone-url::
 80	Space-separated list of clone-url templates. This setting is only
 81	used if `repo.clone-url` is unspecified. Default value: none. See
 82	also: "MACRO EXPANSION", "FILTER API".
 83
 84commit-filter::
 85	Specifies a command which will be invoked to format commit messages.
 86	The command will get the message on its STDIN, and the STDOUT from the
 87	command will be included verbatim as the commit message, i.e. this can
 88	be used to implement bugtracker integration. Default value: none.
 89	See also: "FILTER API".
 90
 91css::
 92	Url which specifies the css document to include in all cgit pages.
 93	Default value: "/cgit.css".
 94
 95embedded::
 96	Flag which, when set to "1", will make cgit generate a html fragment
 97	suitable for embedding in other html pages. Default value: none. See
 98	also: "noheader".
 99
100enable-commit-graph::
101	Flag which, when set to "1", will make cgit print an ASCII-art commit
102	history graph to the left of the commit messages in the repository
103	log page. Default value: "0".
104
105enable-filter-overrides::
106	Flag which, when set to "1", allows all filter settings to be
107	overridden in repository-specific cgitrc files. Default value: none.
108
109enable-gitweb-owner::
110	If set to "1" and scan-path is enabled, we first check each repository
111	for the git config value "gitweb.owner" to determine the owner.
112	Default value: "1". See also: scan-path.
113
114enable-http-clone::
115	If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
116	If you use an alternate way of serving git repositories, you may wish
117	to disable this. Default value: "1".
118
119enable-index-links::
120	Flag which, when set to "1", will make cgit generate extra links for
121	each repo in the repository index (specifically, to the "summary",
122	"commit" and "tree" pages). Default value: "0".
123
124enable-log-filecount::
125	Flag which, when set to "1", will make cgit print the number of
126	modified files for each commit on the repository log page. Default
127	value: "0".
128
129enable-log-linecount::
130	Flag which, when set to "1", will make cgit print the number of added
131	and removed lines for each commit on the repository log page. Default
132	value: "0".
133
134enable-remote-branches::
135	Flag which, when set to "1", will make cgit display remote branches
136	in the summary and refs views. Default value: "0". See also:
137	"repo.enable-remote-branches".
138
139enable-subject-links::
140	Flag which, when set to "1", will make cgit use the subject of the
141	parent commit as link text when generating links to parent commits
142	in commit view. Default value: "0". See also:
143	"repo.enable-subject-links".
144
145enable-tree-linenumbers::
146	Flag which, when set to "1", will make cgit generate linenumber links
147	for plaintext blobs printed in the tree view. Default value: "1".
148
149favicon::
150	Url used as link to a shortcut icon for cgit. If specified, it is
151	suggested to use the value "/favicon.ico" since certain browsers will
152	ignore other values. Default value: none.
153
154footer::
155	The content of the file specified with this option will be included
156	verbatim at the bottom of all pages (i.e. it replaces the standard
157	"generated by..." message. Default value: none.
158
159head-include::
160	The content of the file specified with this option will be included
161	verbatim in the html HEAD section on all pages. Default value: none.
162
163header::
164	The content of the file specified with this option will be included
165	verbatim at the top of all pages. Default value: none.
166
167include::
168	Name of a configfile to include before the rest of the current config-
169	file is parsed. Default value: none. See also: "MACRO EXPANSION".
170
171index-header::
172	The content of the file specified with this option will be included
173	verbatim above the repository index. This setting is deprecated, and
174	will not be supported by cgit-1.0 (use root-readme instead). Default
175	value: none.
176
177index-info::
178	The content of the file specified with this option will be included
179	verbatim below the heading on the repository index page. This setting
180	is deprecated, and will not be supported by cgit-1.0 (use root-desc
181	instead). Default value: none.
182
183local-time::
184	Flag which, if set to "1", makes cgit print commit and tag times in the
185	servers timezone. Default value: "0".
186
187logo::
188	Url which specifies the source of an image which will be used as a logo
189	on all cgit pages. Default value: "/cgit.png".
190
191logo-link::
192	Url loaded when clicking on the cgit logo image. If unspecified the
193	calculated url of the repository index page will be used. Default
194	value: none.
195
196max-atom-items::
197	Specifies the number of items to display in atom feeds view. Default
198	value: "10".
199
200max-commit-count::
201	Specifies the number of entries to list per page in "log" view. Default
202	value: "50".
203
204max-message-length::
205	Specifies the maximum number of commit message characters to display in
206	"log" view. Default value: "80".
207
208max-repo-count::
209	Specifies the number of entries to list per page on the	repository
210	index page. Default value: "50".
211
212max-repodesc-length::
213	Specifies the maximum number of repo description characters to display
214	on the repository index page. Default value: "80".
215
216max-blob-size::
217	Specifies the maximum size of a blob to display HTML for in KBytes.
218	Default value: "0" (limit disabled).
219
220max-stats::
221	Set the default maximum statistics period. Valid values are "week",
222	"month", "quarter" and "year". If unspecified, statistics are
223	disabled. Default value: none. See also: "repo.max-stats".
224
225mimetype.<ext>::
226	Set the mimetype for the specified filename extension. This is used
227	by the `plain` command when returning blob content.
228
229module-link::
230	Text which will be used as the formatstring for a hyperlink when a
231	submodule is printed in a directory listing. The arguments for the
232	formatstring are the path and SHA1 of the submodule commit. Default
233	value: "./?repo=%s&page=commit&id=%s"
234
235nocache::
236	If set to the value "1" caching will be disabled. This settings is
237	deprecated, and will not be honored starting with cgit-1.0. Default
238	value: "0".
239
240noplainemail::
241	If set to "1" showing full author email adresses will be disabled.
242	Default value: "0".
243
244noheader::
245	Flag which, when set to "1", will make cgit omit the standard header
246	on all pages. Default value: none. See also: "embedded".
247
248project-list::
249	A list of subdirectories inside of scan-path, relative to it, that
250	should loaded as git repositories. This must be defined prior to
251	scan-path. Default value: none. See also: scan-path, "MACRO
252	EXPANSION".
253
254readme::
255	Text which will be used as default value for "repo.readme". Default
256	value: none.
257
258remove-suffix::
259	If set to "1" and scan-path is enabled, if any repositories are found
260	with a suffix of ".git", this suffix will be removed for the url and
261	name. Default value: "0". See also: scan-path.
262
263renamelimit::
264	Maximum number of files to consider when detecting renames. The value
265	 "-1" uses the compiletime value in git (for further info, look at
266	  `man git-diff`). Default value: "-1".
267
268repo.group::
269	Legacy alias for "section". This option is deprecated and will not be
270	supported in cgit-1.0.
271
272robots::
273	Text used as content for the "robots" meta-tag. Default value:
274	"index, nofollow".
275
276root-desc::
277	Text printed below the heading on the repository index page. Default
278	value: "a fast webinterface for the git dscm".
279
280root-readme::
281	The content of the file specified with this option will be included
282	verbatim below the "about" link on the repository index page. Default
283	value: none.
284
285root-title::
286	Text printed as heading on the repository index page. Default value:
287	"Git Repository Browser".
288
289scan-hidden-path::
290	If set to "1" and scan-path is enabled, scan-path will recurse into
291	directories whose name starts with a period ('.'). Otherwise,
292	scan-path will stay away from such directories (considered as
293	"hidden"). Note that this does not apply to the ".git" directory in
294	non-bare repos. This must be defined prior to scan-path.
295	Default value: 0. See also: scan-path.
296
297scan-path::
298	A path which will be scanned for repositories. If caching is enabled,
299	the result will be cached as a cgitrc include-file in the cache
300	directory. If project-list has been defined prior to scan-path,
301	scan-path loads only the directories listed in the file pointed to by
302	project-list. Be advised that only the global settings taken
303	before the scan-path directive will be applied to each repository.
304	Default value: none. See also: cache-scanrc-ttl, project-list,
305	"MACRO EXPANSION".
306
307section::
308	The name of the current repository section - all repositories defined
309	after this option will inherit the current section name. Default value:
310	none.
311
312section-from-path::
313	A number which, if specified before scan-path, specifies how many
314	path elements from each repo path to use as a default section name.
315	If negative, cgit will discard the specified number of path elements
316	above the repo directory. Default value: 0.
317
318side-by-side-diffs::
319	If set to "1" shows side-by-side diffs instead of unidiffs per
320	default. Default value: "0".
321
322snapshots::
323	Text which specifies the default set of snapshot formats generated by
324	cgit. The value is a space-separated list of zero or more of the
325	values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
326	none.
327
328source-filter::
329	Specifies a command which will be invoked to format plaintext blobs
330	in the tree view. The command will get the blob content on its STDIN
331	and the name of the blob as its only command line argument. The STDOUT
332	from the command will be included verbatim as the blob contents, i.e.
333	this can be used to implement e.g. syntax highlighting. Default value:
334	none. See also: "FILTER API".
335
336summary-branches::
337	Specifies the number of branches to display in the repository "summary"
338	view. Default value: "10".
339
340summary-log::
341	Specifies the number of log entries to display in the repository
342	"summary" view. Default value: "10".
343
344summary-tags::
345	Specifies the number of tags to display in the repository "summary"
346	view. Default value: "10".
347
348strict-export::
349	Filename which, if specified, needs to be present within the repository
350	for cgit to allow access to that repository. This can be used to emulate
351	gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
352	repositories to match those exported by git-daemon. This option MUST come
353	before 'scan-path'.
354
355virtual-root::
356	Url which, if specified, will be used as root for all cgit links. It
357	will also cause cgit to generate 'virtual urls', i.e. urls like
358	'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
359	value: none.
360	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
361	same kind of virtual urls, so this option will probably be deprecated.
362
363REPOSITORY SETTINGS
364-------------------
365repo.about-filter::
366	Override the default about-filter. Default value: none. See also:
367	"enable-filter-overrides". See also: "FILTER API".
368
369repo.clone-url::
370	A list of space-separated urls which can be used to clone this repo.
371	Default value: none. See also: "MACRO EXPANSION".
372
373repo.commit-filter::
374	Override the default commit-filter. Default value: none. See also:
375	"enable-filter-overrides". See also: "FILTER API".
376
377repo.defbranch::
378	The name of the default branch for this repository. If no such branch
379	exists in the repository, the first branch name (when sorted) is used
380	as default instead. Default value: "master".
381
382repo.desc::
383	The value to show as repository description. Default value: none.
384
385repo.enable-commit-graph::
386	A flag which can be used to disable the global setting
387	`enable-commit-graph'. Default value: none.
388
389repo.enable-log-filecount::
390	A flag which can be used to disable the global setting
391	`enable-log-filecount'. Default value: none.
392
393repo.enable-log-linecount::
394	A flag which can be used to disable the global setting
395	`enable-log-linecount'. Default value: none.
396
397repo.enable-remote-branches::
398	Flag which, when set to "1", will make cgit display remote branches
399	in the summary and refs views. Default value: <enable-remote-branches>.
400
401repo.enable-subject-links::
402	A flag which can be used to override the global setting
403	`enable-subject-links'. Default value: none.
404
405repo.logo::
406	Url which specifies the source of an image which will be used as a logo
407	on this repo's pages. Default value: global logo.
408
409repo.logo-link::
410	Url loaded when clicking on the cgit logo image. If unspecified the
411	calculated url of the repository index page will be used. Default
412	value: global logo-link.
413
414repo.module-link::
415	Text which will be used as the formatstring for a hyperlink when a
416	submodule is printed in a directory listing. The arguments for the
417	formatstring are the path and SHA1 of the submodule commit. Default
418	value: <module-link>
419
420repo.module-link.<path>::
421	Text which will be used as the formatstring for a hyperlink when a
422	submodule with the specified subdirectory path is printed in a
423	directory listing. The only argument for the formatstring is the SHA1
424	of the submodule commit. Default value: none.
425
426repo.max-stats::
427	Override the default maximum statistics period. Valid values are equal
428	to the values specified for the global "max-stats" setting. Default
429	value: none.
430
431repo.name::
432	The value to show as repository name. Default value: <repo.url>.
433
434repo.owner::
435	A value used to identify the owner of the repository. Default value:
436	none.
437
438repo.path::
439	An absolute path to the repository directory. For non-bare repositories
440	this is the .git-directory. Default value: none.
441
442repo.readme::
443	A path (relative to <repo.path>) which specifies a file to include
444	verbatim as the "About" page for this repo. You may also specify a
445	git refspec by head or by hash by prepending the refspec followed by
446	a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
447
448repo.snapshots::
449	A mask of allowed snapshot-formats for this repo, restricted by the
450	"snapshots" global setting. Default value: <snapshots>.
451
452repo.section::
453	Override the current section name for this repository. Default value:
454	none.
455
456repo.source-filter::
457	Override the default source-filter. Default value: none. See also:
458	"enable-filter-overrides". See also: "FILTER API".
459
460repo.url::
461	The relative url used to access the repository. This must be the first
462	setting specified for each repo. Default value: none.
463
464
465REPOSITORY-SPECIFIC CGITRC FILE
466-------------------------------
467When the option "scan-path" is used to auto-discover git repositories, cgit
468will try to parse the file "cgitrc" within any found repository. Such a
469repo-specific config file may contain any of the repo-specific options
470described above, except "repo.url" and "repo.path". Additionally, the "filter"
471options are only acknowledged in repo-specific config files when
472"enable-filter-overrides" is set to "1".
473
474Note: the "repo." prefix is dropped from the option names in repo-specific
475config files, e.g. "repo.desc" becomes "desc".
476
477
478FILTER API
479----------
480about filter::
481	This filter is given no arguments. The about text that is to be
482	filtered is available on standard input and the filtered text is
483	expected on standard output.
484
485commit filter::
486	This filter is given no arguments. The commit message text that is to
487	be filtered is available on standard input and the filtered text is
488	expected on standard output.
489
490source filter::
491	This filter is given a single parameter: the filename of the source
492	file to filter. The filter can use the filename to determine (for
493	example) the syntax highlighting mode. The contents of the source
494	file that is to be filtered is available on standard input and the
495	filtered contents is expected on standard output.
496
497Also, all filters are handed the following environment variables:
498
499- CGIT_REPO_URL (from repo.url)
500- CGIT_REPO_NAME (from repo.name)
501- CGIT_REPO_PATH (from repo.path)
502- CGIT_REPO_OWNER (from repo.owner)
503- CGIT_REPO_DEFBRANCH (from repo.defbranch)
504- CGIT_REPO_SECTION (from repo.section)
505- CGIT_REPO_CLONE_URL (from repo.clone-url)
506
507If a setting is not defined for a repository and the corresponding global
508setting is also not defined (if applicable), then the corresponding
509environment variable will be an empty string.
510
511
512MACRO EXPANSION
513---------------
514The following cgitrc options supports a simple macro expansion feature,
515where tokens prefixed with "$" are replaced with the value of a similary
516named environment variable:
517
518- cache-root
519- include
520- project-list
521- scan-path
522
523Macro expansion will also happen on the content of $CGIT_CONFIG, if
524defined.
525
526One usage of this feature is virtual hosting, which in its simplest form
527can be accomplished by adding the following line to /etc/cgitrc:
528
529	include=/etc/cgitrc.d/$HTTP_HOST
530
531The following options are expanded during request processing, and support
532the environment variables defined in "FILTER API":
533
534- clone-url
535- repo.clone-url
536
537
538EXAMPLE CGITRC FILE
539-------------------
540
541....
542# Enable caching of up to 1000 output entriess
543cache-size=1000
544
545
546# Specify some default clone urls using macro expansion
547clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
548
549# Specify the css url
550css=/css/cgit.css
551
552
553# Show extra links for each repository on the index page
554enable-index-links=1
555
556
557# Enable ASCII art commit history graph on the log pages
558enable-commit-graph=1
559
560
561# Show number of affected files per commit on the log pages
562enable-log-filecount=1
563
564
565# Show number of added/removed lines per commit on the log pages
566enable-log-linecount=1
567
568
569# Add a cgit favicon
570favicon=/favicon.ico
571
572
573# Use a custom logo
574logo=/img/mylogo.png
575
576
577# Enable statistics per week, month and quarter
578max-stats=quarter
579
580
581# Set the title and heading of the repository index page
582root-title=example.com git repositories
583
584
585# Set a subheading for the repository index page
586root-desc=tracking the foobar development
587
588
589# Include some more info about example.com on the index page
590root-readme=/var/www/htdocs/about.html
591
592
593# Allow download of tar.gz, tar.bz2 and zip-files
594snapshots=tar.gz tar.bz2 zip
595
596
597##
598## List of common mimetypes
599##
600
601mimetype.gif=image/gif
602mimetype.html=text/html
603mimetype.jpg=image/jpeg
604mimetype.jpeg=image/jpeg
605mimetype.pdf=application/pdf
606mimetype.png=image/png
607mimetype.svg=image/svg+xml
608
609
610##
611## List of repositories.
612## PS: Any repositories listed when section is unset will not be
613##     displayed under a section heading
614## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
615##      and included like this:
616##        include=/etc/cgitrepos
617##
618
619
620repo.url=foo
621repo.path=/pub/git/foo.git
622repo.desc=the master foo repository
623repo.owner=fooman@example.com
624repo.readme=info/web/about.html
625
626
627repo.url=bar
628repo.path=/pub/git/bar.git
629repo.desc=the bars for your foo
630repo.owner=barman@example.com
631repo.readme=info/web/about.html
632
633
634# The next repositories will be displayed under the 'extras' heading
635section=extras
636
637
638repo.url=baz
639repo.path=/pub/git/baz.git
640repo.desc=a set of extensions for bar users
641
642repo.url=wiz
643repo.path=/pub/git/wiz.git
644repo.desc=the wizard of foo
645
646
647# Add some mirrored repositories
648section=mirrors
649
650
651repo.url=git
652repo.path=/pub/git/git.git
653repo.desc=the dscm
654
655
656repo.url=linux
657repo.path=/pub/git/linux.git
658repo.desc=the kernel
659
660# Disable adhoc downloads of this repo
661repo.snapshots=0
662
663# Disable line-counts for this repo
664repo.enable-log-linecount=0
665
666# Restrict the max statistics period for this repo
667repo.max-stats=month
668....
669
670
671BUGS
672----
673Comments currently cannot appear on the same line as a setting; the comment
674will be included as part of the value. E.g. this line:
675
676	robots=index  # allow indexing
677
678will generate the following html element:
679
680	<meta name='robots' content='index  # allow indexing'/>
681
682
683
684AUTHOR
685------
686Lars Hjemli <hjemli@gmail.com>
687Jason A. Donenfeld <Jason@zx2c4.com>