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