summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (show whitespace changes)
-rw-r--r--cgitrc.5.txt48
1 files changed, 43 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 3b16db9..4dc383d 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -9,126 +9,134 @@ cgitrc - runtime configuration for cgit
9 9
10SYNOPSIS 10SYNOPSIS
11-------- 11--------
12Cgitrc contains all runtime settings for cgit, including the list of git 12Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored. 14lines, and lines starting with '#', are ignored.
15 15
16 16
17LOCATION 17LOCATION
18-------- 18--------
19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At 19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
20runtime, cgit will consult the environment variable CGIT_CONFIG and, if 20runtime, cgit will consult the environment variable CGIT_CONFIG and, if
21defined, use its value instead. 21defined, use its value instead.
22 22
23 23
24GLOBAL SETTINGS 24GLOBAL SETTINGS
25--------------- 25---------------
26about-filter:: 26about-filter::
27 Specifies a command which will be invoked to format the content of 27 Specifies a command which will be invoked to format the content of
28 about pages (both top-level and for each repository). The command will 28 about pages (both top-level and for each repository). The command will
29 get the content of the about-file on its STDIN, and the STDOUT from the 29 get the content of the about-file on its STDIN, and the STDOUT from the
30 command will be included verbatim on the about page. Default value: 30 command will be included verbatim on the about page. Default value:
31 none. 31 none.
32 32
33agefile:: 33agefile::
34 Specifies a path, relative to each repository path, which can be used 34 Specifies a path, relative to each repository path, which can be used
35 to specify the date and time of the youngest commit in the repository. 35 to specify the date and time of the youngest commit in the repository.
36 The first line in the file is used as input to the "parse_date" 36 The first line in the file is used as input to the "parse_date"
37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
38 hh:mm:ss". Default value: "info/web/last-modified". 38 hh:mm:ss". Default value: "info/web/last-modified".
39 39
40cache-root:: 40cache-root::
41 Path used to store the cgit cache entries. Default value: 41 Path used to store the cgit cache entries. Default value:
42 "/var/cache/cgit". 42 "/var/cache/cgit".
43 43
44cache-dynamic-ttl:: 44cache-dynamic-ttl::
45 Number which specifies the time-to-live, in minutes, for the cached 45 Number which specifies the time-to-live, in minutes, for the cached
46 version of repository pages accessed without a fixed SHA1. Default 46 version of repository pages accessed without a fixed SHA1. Default
47 value: "5". 47 value: "5".
48 48
49cache-repo-ttl:: 49cache-repo-ttl::
50 Number which specifies the time-to-live, in minutes, for the cached 50 Number which specifies the time-to-live, in minutes, for the cached
51 version of the repository summary page. Default value: "5". 51 version of the repository summary page. Default value: "5".
52 52
53cache-root-ttl:: 53cache-root-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached 54 Number which specifies the time-to-live, in minutes, for the cached
55 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
56 56
57cache-scanrc-ttl::
58 Number which specifies the time-to-live, in minutes, for the result
59 of scanning a path for git repositories. Default value: "15".
60
57cache-size:: 61cache-size::
58 The maximum number of entries in the cgit cache. Default value: "0" 62 The maximum number of entries in the cgit cache. Default value: "0"
59 (i.e. caching is disabled). 63 (i.e. caching is disabled).
60 64
61cache-static-ttl:: 65cache-static-ttl::
62 Number which specifies the time-to-live, in minutes, for the cached 66 Number which specifies the time-to-live, in minutes, for the cached
63 version of repository pages accessed with a fixed SHA1. Default value: 67 version of repository pages accessed with a fixed SHA1. Default value:
64 "5". 68 "5".
65 69
66clone-prefix:: 70clone-prefix::
67 Space-separated list of common prefixes which, when combined with a 71 Space-separated list of common prefixes which, when combined with a
68 repository url, generates valid clone urls for the repository. This 72 repository url, generates valid clone urls for the repository. This
69 setting is only used if `repo.clone-url` is unspecified. Default value: 73 setting is only used if `repo.clone-url` is unspecified. Default value:
70 none. 74 none.
71 75
72commit-filter:: 76commit-filter::
73 Specifies a command which will be invoked to format commit messages. 77 Specifies a command which will be invoked to format commit messages.
74 The command will get the message on its STDIN, and the STDOUT from the 78 The command will get the message on its STDIN, and the STDOUT from the
75 command will be included verbatim as the commit message, i.e. this can 79 command will be included verbatim as the commit message, i.e. this can
76 be used to implement bugtracker integration. Default value: none. 80 be used to implement bugtracker integration. Default value: none.
77 81
78css:: 82css::
79 Url which specifies the css document to include in all cgit pages. 83 Url which specifies the css document to include in all cgit pages.
80 Default value: "/cgit.css". 84 Default value: "/cgit.css".
81 85
82embedded:: 86embedded::
83 Flag which, when set to "1", will make cgit generate a html fragment 87 Flag which, when set to "1", will make cgit generate a html fragment
84 suitable for embedding in other html pages. Default value: none. See 88 suitable for embedding in other html pages. Default value: none. See
85 also: "noheader". 89 also: "noheader".
86 90
91enable-filter-overrides::
92 Flag which, when set to "1", allows all filter settings to be
93 overridden in repository-specific cgitrc files. Default value: none.
94
87enable-index-links:: 95enable-index-links::
88 Flag which, when set to "1", will make cgit generate extra links for 96 Flag which, when set to "1", will make cgit generate extra links for
89 each repo in the repository index (specifically, to the "summary", 97 each repo in the repository index (specifically, to the "summary",
90 "commit" and "tree" pages). Default value: "0". 98 "commit" and "tree" pages). Default value: "0".
91 99
92enable-log-filecount:: 100enable-log-filecount::
93 Flag which, when set to "1", will make cgit print the number of 101 Flag which, when set to "1", will make cgit print the number of
94 modified files for each commit on the repository log page. Default 102 modified files for each commit on the repository log page. Default
95 value: "0". 103 value: "0".
96 104
97enable-log-linecount:: 105enable-log-linecount::
98 Flag which, when set to "1", will make cgit print the number of added 106 Flag which, when set to "1", will make cgit print the number of added
99 and removed lines for each commit on the repository log page. Default 107 and removed lines for each commit on the repository log page. Default
100 value: "0". 108 value: "0".
101 109
102enable-tree-linenumbers:: 110enable-tree-linenumbers::
103 Flag which, when set to "1", will make cgit generate linenumber links 111 Flag which, when set to "1", will make cgit generate linenumber links
104 for plaintext blobs printed in the tree view. Default value: "1". 112 for plaintext blobs printed in the tree view. Default value: "1".
105 113
106favicon:: 114favicon::
107 Url used as link to a shortcut icon for cgit. If specified, it is 115 Url used as link to a shortcut icon for cgit. If specified, it is
108 suggested to use the value "/favicon.ico" since certain browsers will 116 suggested to use the value "/favicon.ico" since certain browsers will
109 ignore other values. Default value: none. 117 ignore other values. Default value: none.
110 118
111footer:: 119footer::
112 The content of the file specified with this option will be included 120 The content of the file specified with this option will be included
113 verbatim at the bottom of all pages (i.e. it replaces the standard 121 verbatim at the bottom of all pages (i.e. it replaces the standard
114 "generated by..." message. Default value: none. 122 "generated by..." message. Default value: none.
115 123
116head-include:: 124head-include::
117 The content of the file specified with this option will be included 125 The content of the file specified with this option will be included
118 verbatim in the html HEAD section on all pages. Default value: none. 126 verbatim in the html HEAD section on all pages. Default value: none.
119 127
120header:: 128header::
121 The content of the file specified with this option will be included 129 The content of the file specified with this option will be included
122 verbatim at the top of all pages. Default value: none. 130 verbatim at the top of all pages. Default value: none.
123 131
124include:: 132include::
125 Name of a configfile to include before the rest of the current config- 133 Name of a configfile to include before the rest of the current config-
126 file is parsed. Default value: none. 134 file is parsed. Default value: none.
127 135
128index-header:: 136index-header::
129 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
130 verbatim above the repository index. This setting is deprecated, and 138 verbatim above the repository index. This setting is deprecated, and
131 will not be supported by cgit-1.0 (use root-readme instead). Default 139 will not be supported by cgit-1.0 (use root-readme instead). Default
132 value: none. 140 value: none.
133 141
134index-info:: 142index-info::
@@ -155,209 +163,239 @@ max-commit-count::
155 value: "50". 163 value: "50".
156 164
157max-message-length:: 165max-message-length::
158 Specifies the maximum number of commit message characters to display in 166 Specifies the maximum number of commit message characters to display in
159 "log" view. Default value: "80". 167 "log" view. Default value: "80".
160 168
161max-repo-count:: 169max-repo-count::
162 Specifies the number of entries to list per page on therepository 170 Specifies the number of entries to list per page on therepository
163 index page. Default value: "50". 171 index page. Default value: "50".
164 172
165max-repodesc-length:: 173max-repodesc-length::
166 Specifies the maximum number of repo description characters to display 174 Specifies the maximum number of repo description characters to display
167 on the repository index page. Default value: "80". 175 on the repository index page. Default value: "80".
168 176
169max-stats:: 177max-stats::
170 Set the default maximum statistics period. Valid values are "week", 178 Set the default maximum statistics period. Valid values are "week",
171 "month", "quarter" and "year". If unspecified, statistics are 179 "month", "quarter" and "year". If unspecified, statistics are
172 disabled. Default value: none. See also: "repo.max-stats". 180 disabled. Default value: none. See also: "repo.max-stats".
173 181
174mimetype.<ext>:: 182mimetype.<ext>::
175 Set the mimetype for the specified filename extension. This is used 183 Set the mimetype for the specified filename extension. This is used
176 by the `plain` command when returning blob content. 184 by the `plain` command when returning blob content.
177 185
178module-link:: 186module-link::
179 Text which will be used as the formatstring for a hyperlink when a 187 Text which will be used as the formatstring for a hyperlink when a
180 submodule is printed in a directory listing. The arguments for the 188 submodule is printed in a directory listing. The arguments for the
181 formatstring are the path and SHA1 of the submodule commit. Default 189 formatstring are the path and SHA1 of the submodule commit. Default
182 value: "./?repo=%s&page=commit&id=%s" 190 value: "./?repo=%s&page=commit&id=%s"
183 191
184nocache:: 192nocache::
185 If set to the value "1" caching will be disabled. This settings is 193 If set to the value "1" caching will be disabled. This settings is
186 deprecated, and will not be honored starting with cgit-1.0. Default 194 deprecated, and will not be honored starting with cgit-1.0. Default
187 value: "0". 195 value: "0".
188 196
189noplainemail:: 197noplainemail::
190 If set to "1" showing full author email adresses will be disabled. 198 If set to "1" showing full author email adresses will be disabled.
191 Default value: "0". 199 Default value: "0".
192 200
193noheader:: 201noheader::
194 Flag which, when set to "1", will make cgit omit the standard header 202 Flag which, when set to "1", will make cgit omit the standard header
195 on all pages. Default value: none. See also: "embedded". 203 on all pages. Default value: none. See also: "embedded".
196 204
197renamelimit:: 205renamelimit::
198 Maximum number of files to consider when detecting renames. The value 206 Maximum number of files to consider when detecting renames. The value
199 "-1" uses the compiletime value in git (for further info, look at 207 "-1" uses the compiletime value in git (for further info, look at
200 `man git-diff`). Default value: "-1". 208 `man git-diff`). Default value: "-1".
201 209
202repo.group:: 210repo.group::
203 A value for the current repository group, which all repositories 211 Legacy alias for "section". This option is deprecated and will not be
204 specified after this setting will inherit. Default value: none. 212 supported in cgit-1.0.
205 213
206robots:: 214robots::
207 Text used as content for the "robots" meta-tag. Default value: 215 Text used as content for the "robots" meta-tag. Default value:
208 "index, nofollow". 216 "index, nofollow".
209 217
210root-desc:: 218root-desc::
211 Text printed below the heading on the repository index page. Default 219 Text printed below the heading on the repository index page. Default
212 value: "a fast webinterface for the git dscm". 220 value: "a fast webinterface for the git dscm".
213 221
214root-readme:: 222root-readme::
215 The content of the file specified with this option will be included 223 The content of the file specified with this option will be included
216 verbatim below the "about" link on the repository index page. Default 224 verbatim below the "about" link on the repository index page. Default
217 value: none. 225 value: none.
218 226
219root-title:: 227root-title::
220 Text printed as heading on the repository index page. Default value: 228 Text printed as heading on the repository index page. Default value:
221 "Git Repository Browser". 229 "Git Repository Browser".
222 230
231scan-path::
232 A path which will be scanned for repositories. If caching is enabled,
233 the result will be cached as a cgitrc include-file in the cache
234 directory. Default value: none. See also: cache-scanrc-ttl.
235
236section::
237 The name of the current repository section - all repositories defined
238 after this option will inherit the current section name. Default value:
239 none.
240
223snapshots:: 241snapshots::
224 Text which specifies the default set of snapshot formats generated by 242 Text which specifies the default set of snapshot formats generated by
225 cgit. The value is a space-separated list of zero or more of the 243 cgit. The value is a space-separated list of zero or more of the
226 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 244 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
227 245
228source-filter:: 246source-filter::
229 Specifies a command which will be invoked to format plaintext blobs 247 Specifies a command which will be invoked to format plaintext blobs
230 in the tree view. The command will get the blob content on its STDIN 248 in the tree view. The command will get the blob content on its STDIN
231 and the name of the blob as its only command line argument. The STDOUT 249 and the name of the blob as its only command line argument. The STDOUT
232 from the command will be included verbatim as the blob contents, i.e. 250 from the command will be included verbatim as the blob contents, i.e.
233 this can be used to implement e.g. syntax highlighting. Default value: 251 this can be used to implement e.g. syntax highlighting. Default value:
234 none. 252 none.
235 253
236summary-branches:: 254summary-branches::
237 Specifies the number of branches to display in the repository "summary" 255 Specifies the number of branches to display in the repository "summary"
238 view. Default value: "10". 256 view. Default value: "10".
239 257
240summary-log:: 258summary-log::
241 Specifies the number of log entries to display in the repository 259 Specifies the number of log entries to display in the repository
242 "summary" view. Default value: "10". 260 "summary" view. Default value: "10".
243 261
244summary-tags:: 262summary-tags::
245 Specifies the number of tags to display in the repository "summary" 263 Specifies the number of tags to display in the repository "summary"
246 view. Default value: "10". 264 view. Default value: "10".
247 265
248virtual-root:: 266virtual-root::
249 Url which, if specified, will be used as root for all cgit links. It 267 Url which, if specified, will be used as root for all cgit links. It
250 will also cause cgit to generate 'virtual urls', i.e. urls like 268 will also cause cgit to generate 'virtual urls', i.e. urls like
251 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 269 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
252 value: none. 270 value: none.
253 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 271 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
254 same kind of virtual urls, so this option will probably be deprecated. 272 same kind of virtual urls, so this option will probably be deprecated.
255 273
256REPOSITORY SETTINGS 274REPOSITORY SETTINGS
257------------------- 275-------------------
258repo.about-filter:: 276repo.about-filter::
259 Override the default about-filter. Default value: <about-filter>. 277 Override the default about-filter. Default value: none. See also:
278 "enable-filter-overrides".
260 279
261repo.clone-url:: 280repo.clone-url::
262 A list of space-separated urls which can be used to clone this repo. 281 A list of space-separated urls which can be used to clone this repo.
263 Default value: none. 282 Default value: none.
264 283
265repo.commit-filter:: 284repo.commit-filter::
266 Override the default commit-filter. Default value: <commit-filter>. 285 Override the default commit-filter. Default value: none. See also:
286 "enable-filter-overrides".
267 287
268repo.defbranch:: 288repo.defbranch::
269 The name of the default branch for this repository. If no such branch 289 The name of the default branch for this repository. If no such branch
270 exists in the repository, the first branch name (when sorted) is used 290 exists in the repository, the first branch name (when sorted) is used
271 as default instead. Default value: "master". 291 as default instead. Default value: "master".
272 292
273repo.desc:: 293repo.desc::
274 The value to show as repository description. Default value: none. 294 The value to show as repository description. Default value: none.
275 295
276repo.enable-log-filecount:: 296repo.enable-log-filecount::
277 A flag which can be used to disable the global setting 297 A flag which can be used to disable the global setting
278 `enable-log-filecount'. Default value: none. 298 `enable-log-filecount'. Default value: none.
279 299
280repo.enable-log-linecount:: 300repo.enable-log-linecount::
281 A flag which can be used to disable the global setting 301 A flag which can be used to disable the global setting
282 `enable-log-linecount'. Default value: none. 302 `enable-log-linecount'. Default value: none.
283 303
284repo.max-stats:: 304repo.max-stats::
285 Override the default maximum statistics period. Valid values are equal 305 Override the default maximum statistics period. Valid values are equal
286 to the values specified for the global "max-stats" setting. Default 306 to the values specified for the global "max-stats" setting. Default
287 value: none. 307 value: none.
288 308
289repo.name:: 309repo.name::
290 The value to show as repository name. Default value: <repo.url>. 310 The value to show as repository name. Default value: <repo.url>.
291 311
292repo.owner:: 312repo.owner::
293 A value used to identify the owner of the repository. Default value: 313 A value used to identify the owner of the repository. Default value:
294 none. 314 none.
295 315
296repo.path:: 316repo.path::
297 An absolute path to the repository directory. For non-bare repositories 317 An absolute path to the repository directory. For non-bare repositories
298 this is the .git-directory. Default value: none. 318 this is the .git-directory. Default value: none.
299 319
300repo.readme:: 320repo.readme::
301 A path (relative to <repo.path>) which specifies a file to include 321 A path (relative to <repo.path>) which specifies a file to include
302 verbatim as the "About" page for this repo. Default value: none. 322 verbatim as the "About" page for this repo. Default value: none.
303 323
304repo.snapshots:: 324repo.snapshots::
305 A mask of allowed snapshot-formats for this repo, restricted by the 325 A mask of allowed snapshot-formats for this repo, restricted by the
306 "snapshots" global setting. Default value: <snapshots>. 326 "snapshots" global setting. Default value: <snapshots>.
307 327
328repo.section::
329 Override the current section name for this repository. Default value:
330 none.
331
308repo.source-filter:: 332repo.source-filter::
309 Override the default source-filter. Default value: <source-filter>. 333 Override the default source-filter. Default value: none. See also:
334 "enable-filter-overrides".
310 335
311repo.url:: 336repo.url::
312 The relative url used to access the repository. This must be the first 337 The relative url used to access the repository. This must be the first
313 setting specified for each repo. Default value: none. 338 setting specified for each repo. Default value: none.
314 339
315 340
341REPOSITORY-SPECIFIC CGITRC FILE
342-------------------------------
343When the option "scan-path" is used to auto-discover git repositories, cgit
344will try to parse the file "cgitrc" within any found repository. Such a
345repo-specific config file may contain any of the repo-specific options
346described above, except "repo.url" and "repo.path". Additionally, the "filter"
347options are only acknowledged in repo-specific config files when
348"enable-filter-overrides" is set to "1".
349
350Note: the "repo." prefix is dropped from the option names in repo-specific
351config files, e.g. "repo.desc" becomes "desc".
352
353
316EXAMPLE CGITRC FILE 354EXAMPLE CGITRC FILE
317------------------- 355-------------------
318 356
319.... 357....
320# Enable caching of up to 1000 output entriess 358# Enable caching of up to 1000 output entriess
321cache-size=1000 359cache-size=1000
322 360
323 361
324# Specify some default clone prefixes 362# Specify some default clone prefixes
325clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 363clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
326 364
327# Specify the css url 365# Specify the css url
328css=/css/cgit.css 366css=/css/cgit.css
329 367
330 368
331# Show extra links for each repository on the index page 369# Show extra links for each repository on the index page
332enable-index-links=1 370enable-index-links=1
333 371
334 372
335# Show number of affected files per commit on the log pages 373# Show number of affected files per commit on the log pages
336enable-log-filecount=1 374enable-log-filecount=1
337 375
338 376
339# Show number of added/removed lines per commit on the log pages 377# Show number of added/removed lines per commit on the log pages
340enable-log-linecount=1 378enable-log-linecount=1
341 379
342 380
343# Add a cgit favicon 381# Add a cgit favicon
344favicon=/favicon.ico 382favicon=/favicon.ico
345 383
346 384
347# Use a custom logo 385# Use a custom logo
348logo=/img/mylogo.png 386logo=/img/mylogo.png
349 387
350 388
351# Enable statistics per week, month and quarter 389# Enable statistics per week, month and quarter
352max-stats=quarter 390max-stats=quarter
353 391
354 392
355# Set the title and heading of the repository index page 393# Set the title and heading of the repository index page
356root-title=foobar.com git repositories 394root-title=foobar.com git repositories
357 395
358 396
359# Set a subheading for the repository index page 397# Set a subheading for the repository index page
360root-desc=tracking the foobar development 398root-desc=tracking the foobar development
361 399
362 400
363# Include some more info about foobar.com on the index page 401# Include some more info about foobar.com on the index page