1CGITRC
  2======
  3
  4
  5NAME
  6----
  7	cgitrc - runtime configuration for cgit
  8
  9
 10DESCRIPTION
 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
 17GLOBAL SETTINGS
 18---------------
 19agefile
 20	Specifies a path, relative to each repository path, which can be used
 21	to specify the date and time of the youngest commit in the repository.
 22	The first line in the file is used as input to the "parse_date"
 23	function in libgit. Recommended timestamp-format is "yyyy-mm-dd
 24	hh:mm:ss". Default value: "info/web/last-modified".
 25
 26cache-root
 27	Path used to store the cgit cache entries. Default value:
 28	"/var/cache/cgit".
 29
 30cache-dynamic-ttl
 31	Number which specifies the time-to-live, in minutes, for the cached
 32	version of repository pages accessed without a fixed SHA1. Default
 33	value: "5".
 34
 35cache-repo-ttl
 36	Number which specifies the time-to-live, in minutes, for the cached
 37	version of the repository summary page. Default value: "5".
 38
 39cache-root-ttl
 40	Number which specifies the time-to-live, in minutes, for the cached
 41	version of the repository index page. Default value: "5".
 42
 43cache-size
 44	The maximum number of entries in the cgit cache. Default value: "0"
 45	(i.e. caching is disabled).
 46
 47cache-static-ttl
 48	Number which specifies the time-to-live, in minutes, for the cached
 49	version of repository pages accessed with a fixed SHA1. Default value:
 50	"5".
 51
 52clone-prefix
 53	Space-separated list of common prefixes which, when combined with a
 54	repository url, generates valid clone urls for the repository. This
 55	setting is only used if `repo.clone-url` is unspecified. Default value:
 56	none.
 57
 58css
 59	Url which specifies the css document to include in all cgit pages.
 60	Default value: "/cgit.css".
 61
 62enable-index-links
 63	Flag which, when set to "1", will make cgit generate extra links for
 64	each repo in the repository index (specifically, to the "summary",
 65	"commit" and "tree" pages). Default value: "0".
 66
 67enable-log-filecount
 68	Flag which, when set to "1", will make cgit print the number of
 69	modified files for each commit on the repository log page. Default
 70	value: "0".
 71
 72enable-log-linecount
 73	Flag which, when set to "1", will make cgit print the number of added
 74	and removed lines for each commit on the repository log page. Default
 75	value: "0".
 76
 77favicon
 78	Url used as link to a shortcut icon for cgit. If specified, it is
 79	suggested to use the value "/favicon.ico" since certain browsers will
 80	ignore other values. Default value: none.
 81
 82footer
 83	The content of the file specified with this option will be included
 84	verbatim at the bottom of all pages (i.e. it replaces the standard
 85	"generated by..." message. Default value: none.
 86
 87header
 88	The content of the file specified with this option will be included
 89	verbatim at the top of all pages. Default value: none.
 90
 91include
 92	Name of a configfile to include before the rest of the current config-
 93	file is parsed. Default value: none.
 94
 95index-header
 96	The content of the file specified with this option will be included
 97	verbatim above the repository index. This setting is deprecated, and
 98	will not be supported by cgit-1.0 (use root-readme instead). Default
 99	value: none.
100
101index-info
102	The content of the file specified with this option will be included
103	verbatim below the heading on the repository index page. This setting
104	is deprecated, and will not be supported by cgit-1.0 (use root-desc
105	instead). Default value: none.
106
107local-time
108	Flag which, if set to "1", makes cgit print commit and tag times in the
109	servers timezone. Default value: "0".
110
111logo
112	Url which specifies the source of an image which will be used as a logo
113	on all cgit pages.
114
115logo-link
116	Url loaded when clicking on the cgit logo image. If unspecified the
117	calculated url of the repository index page will be used. Default
118	value: none.
119
120max-commit-count
121	Specifies the number of entries to list per page in "log" view. Default
122	value: "50".
123
124max-message-length
125	Specifies the maximum number of commit message characters to display in
126	"log" view. Default value: "80".
127
128max-repo-count
129	Specifies the number of entries to list per page on the	repository
130	index page. Default value: "50".
131
132max-repodesc-length
133	Specifies the maximum number of repo description characters to display
134	on the repository index page. Default value: "80".
135
136max-stats
137	Set the default maximum statistics period. Valid values are "week",
138	"month", "quarter" and "year". If unspecified, statistics are
139	disabled. Default value: none. See also: "repo.max-stats".
140
141module-link
142	Text which will be used as the formatstring for a hyperlink when a
143	submodule is printed in a directory listing. The arguments for the
144	formatstring are the path and SHA1 of the submodule commit. Default
145	value: "./?repo=%s&page=commit&id=%s"
146
147nocache
148	If set to the value "1" caching will be disabled. This settings is
149	deprecated, and will not be honored starting with cgit-1.0. Default
150	value: "0".
151
152renamelimit
153	Maximum number of files to consider when detecting renames. The value
154	 "-1" uses the compiletime value in git (for further info, look at
155	  `man git-diff`). Default value: "-1".
156
157repo.group
158	A value for the current repository group, which all repositories
159	specified after this setting will inherit. Default value: none.
160
161robots
162	Text used as content for the "robots" meta-tag. Default value:
163	"index, nofollow".
164
165root-desc
166	Text printed below the heading on the repository index page. Default
167	value: "a fast webinterface for the git dscm".
168
169root-readme:
170	The content of the file specified with this option will be included
171	verbatim below the "about" link on the repository index page. Default
172	value: none.
173
174root-title
175	Text printed as heading on the repository index page. Default value:
176	"Git Repository Browser".
177
178snapshots
179	Text which specifies the default (and allowed) set of snapshot formats
180	supported by cgit. The value is a space-separated list of zero or more
181	of the following values:
182		"tar"		uncompressed tar-file
183		"tar.gz"	gzip-compressed tar-file
184		"tar.bz2"	bzip-compressed tar-file
185		"zip"		zip-file
186	Default value: none.
187
188summary-branches
189	Specifies the number of branches to display in the repository "summary"
190	view. Default value: "10".
191
192summary-log
193	Specifies the number of log entries to display in the repository
194	"summary" view. Default value: "10".
195
196summary-tags
197	Specifies the number of tags to display in the repository "summary"
198	view. Default value: "10".
199
200virtual-root
201	Url which, if specified, will be used as root for all cgit links. It
202	will also cause cgit to generate 'virtual urls', i.e. urls like
203	'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
204	value: none.
205	NOTE: cgit has recently learned how to use PATH_INFO to achieve the
206	same kind of virtual urls, so this option will probably be deprecated.
207
208REPOSITORY SETTINGS
209-------------------
210repo.clone-url
211	A list of space-separated urls which can be used to clone this repo.
212	Default value: none.
213
214repo.defbranch
215	The name of the default branch for this repository. If no such branch
216	exists in the repository, the first branch name (when sorted) is used
217	as default instead. Default value: "master".
218
219repo.desc
220	The value to show as repository description. Default value: none.
221
222repo.enable-log-filecount
223	A flag which can be used to disable the global setting
224	`enable-log-filecount'. Default value: none.
225
226repo.enable-log-linecount
227	A flag which can be used to disable the global setting
228	`enable-log-linecount'. Default value: none.
229
230repo.max-stats
231	Override the default maximum statistics period. Valid values are equal
232	to the values specified for the global "max-stats" setting. Default
233	value: none.
234
235repo.name
236	The value to show as repository name. Default value: <repo.url>.
237
238repo.owner
239	A value used to identify the owner of the repository. Default value:
240	none.
241
242repo.path
243	An absolute path to the repository directory. For non-bare repositories
244	this is the .git-directory. Default value: none.
245
246repo.readme
247	A path (relative to <repo.path>) which specifies a file to include
248	verbatim as the "About" page for this repo. Default value: none.
249
250repo.snapshots
251	A mask of allowed snapshot-formats for this repo, restricted by the
252	"snapshots" global setting. Default value: <snapshots>.
253
254repo.url
255	The relative url used to access the repository. This must be the first
256	setting specified for each repo. Default value: none.
257
258
259EXAMPLE CGITRC FILE
260-------------------
261
262# Enable caching of up to 1000 output entriess
263cache-size=1000
264
265
266# Specify some default clone prefixes
267clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
268
269# Specify the css url
270css=/css/cgit.css
271
272
273# Show extra links for each repository on the index page
274enable-index-links=1
275
276
277# Show number of affected files per commit on the log pages
278enable-log-filecount=1
279
280
281# Show number of added/removed lines per commit on the log pages
282enable-log-linecount=1
283
284
285# Add a cgit favicon
286favicon=/favicon.ico
287
288
289# Use a custom logo
290logo=/img/mylogo.png
291
292
293# Enable statistics per week, month and quarter
294max-stats=quarter
295
296
297# Set the title and heading of the repository index page
298root-title=foobar.com git repositories
299
300
301# Set a subheading for the repository index page
302root-desc=tracking the foobar development
303
304
305# Include some more info about foobar.com on the index page
306root-readme=/var/www/htdocs/about.html
307
308
309# Allow download of tar.gz, tar.bz2 and zip-files
310snapshots=tar.gz tar.bz2 zip
311
312
313##
314## List of repositories.
315## PS: Any repositories listed when repo.group is unset will not be
316##     displayed under a group heading
317## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
318##      and included like this:
319##        include=/etc/cgitrepos
320##
321
322
323repo.url=foo
324repo.path=/pub/git/foo.git
325repo.desc=the master foo repository
326repo.owner=fooman@foobar.com
327repo.readme=info/web/about.html
328
329
330repo.url=bar
331repo.path=/pub/git/bar.git
332repo.desc=the bars for your foo
333repo.owner=barman@foobar.com
334repo.readme=info/web/about.html
335
336
337# The next repositories will be displayed under the 'extras' heading
338repo.group=extras
339
340
341repo.url=baz
342repo.path=/pub/git/baz.git
343repo.desc=a set of extensions for bar users
344
345repo.url=wiz
346repo.path=/pub/git/wiz.git
347repo.desc=the wizard of foo
348
349
350# Add some mirrored repositories
351repo.group=mirrors
352
353
354repo.url=git
355repo.path=/pub/git/git.git
356repo.desc=the dscm
357
358
359repo.url=linux
360repo.path=/pub/git/linux.git
361repo.desc=the kernel
362
363# Disable adhoc downloads of this repo
364repo.snapshots=0
365
366# Disable line-counts for this repo
367repo.enable-log-linecount=0
368
369# Restrict the max statistics period for this repo
370repo.max-stats=month
371
372
373BUGS
374----
375Comments currently cannot appear on the same line as a setting; the comment
376will be included as part of the value. E.g. this line:
377
378	robots=index  # allow indexing
379
380will generate the following html element:
381
382	<meta name='robots' content='index  # allow indexing'/>
383
384
385
386AUTHOR
387------
388Lars Hjemli <hjemli@gmail.com>