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