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