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