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