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