summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt23
1 files changed, 16 insertions, 7 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60d3ea4..0bbbea3 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,375 +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
77enable-stats
78 Globally enable/disable statistics for each repository. Default
79 value: "0".
80
81favicon 77favicon
82 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
83 suggested to use the value "/favicon.ico" since certain browsers will 79 suggested to use the value "/favicon.ico" since certain browsers will
84 ignore other values. Default value: none. 80 ignore other values. Default value: none.
85 81
86footer 82footer
87 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
88 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
89 "generated by..." message. Default value: none. 85 "generated by..." message. Default value: none.
90 86
91include 87include
92 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-
93 file is parsed. Default value: none. 89 file is parsed. Default value: none.
94 90
95index-header 91index-header
96 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
97 verbatim above the repository index. This setting is deprecated, and 93 verbatim above the repository index. This setting is deprecated, and
98 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
99 value: none. 95 value: none.
100 96
101index-info 97index-info
102 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
103 verbatim below the heading on the repository index page. This setting 99 verbatim below the heading on the repository index page. This setting
104 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
105 instead). Default value: none. 101 instead). Default value: none.
106 102
107local-time 103local-time
108 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
109 servers timezone. Default value: "0". 105 servers timezone. Default value: "0".
110 106
111logo 107logo
112 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
113 on all cgit pages. 109 on all cgit pages.
114 110
115logo-link 111logo-link
116 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
117 calculated url of the repository index page will be used. Default 113 calculated url of the repository index page will be used. Default
118 value: none. 114 value: none.
119 115
120max-commit-count 116max-commit-count
121 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
122 value: "50". 118 value: "50".
123 119
124max-message-length 120max-message-length
125 Specifies the maximum number of commit message characters to display in 121 Specifies the maximum number of commit message characters to display in
126 "log" view. Default value: "80". 122 "log" view. Default value: "80".
127 123
128max-repo-count 124max-repo-count
129 Specifies the number of entries to list per page on therepository 125 Specifies the number of entries to list per page on therepository
130 index page. Default value: "50". 126 index page. Default value: "50".
131 127
132max-repodesc-length 128max-repodesc-length
133 Specifies the maximum number of repo description characters to display 129 Specifies the maximum number of repo description characters to display
134 on the repository index page. Default value: "80". 130 on the repository index page. Default value: "80".
135 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
136module-link 137module-link
137 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
138 submodule is printed in a directory listing. The arguments for the 139 submodule is printed in a directory listing. The arguments for the
139 formatstring are the path and SHA1 of the submodule commit. Default 140 formatstring are the path and SHA1 of the submodule commit. Default
140 value: "./?repo=%s&page=commit&id=%s" 141 value: "./?repo=%s&page=commit&id=%s"
141 142
142nocache 143nocache
143 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
144 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
145 value: "0". 146 value: "0".
146 147
147renamelimit 148renamelimit
148 Maximum number of files to consider when detecting renames. The value 149 Maximum number of files to consider when detecting renames. The value
149 "-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
150 `man git-diff`). Default value: "-1". 151 `man git-diff`). Default value: "-1".
151 152
152repo.group 153repo.group
153 A value for the current repository group, which all repositories 154 A value for the current repository group, which all repositories
154 specified after this setting will inherit. Default value: none. 155 specified after this setting will inherit. Default value: none.
155 156
156robots 157robots
157 Text used as content for the "robots" meta-tag. Default value: 158 Text used as content for the "robots" meta-tag. Default value:
158 "index, nofollow". 159 "index, nofollow".
159 160
160root-desc 161root-desc
161 Text printed below the heading on the repository index page. Default 162 Text printed below the heading on the repository index page. Default
162 value: "a fast webinterface for the git dscm". 163 value: "a fast webinterface for the git dscm".
163 164
164root-readme: 165root-readme:
165 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
166 verbatim below the "about" link on the repository index page. Default 167 verbatim below the "about" link on the repository index page. Default
167 value: none. 168 value: none.
168 169
169root-title 170root-title
170 Text printed as heading on the repository index page. Default value: 171 Text printed as heading on the repository index page. Default value:
171 "Git Repository Browser". 172 "Git Repository Browser".
172 173
173snapshots 174snapshots
174 Text which specifies the default (and allowed) set of snapshot formats 175 Text which specifies the default (and allowed) set of snapshot formats
175 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
176 of the following values: 177 of the following values:
177 "tar" uncompressed tar-file 178 "tar" uncompressed tar-file
178 "tar.gz"gzip-compressed tar-file 179 "tar.gz"gzip-compressed tar-file
179 "tar.bz2"bzip-compressed tar-file 180 "tar.bz2"bzip-compressed tar-file
180 "zip" zip-file 181 "zip" zip-file
181 Default value: none. 182 Default value: none.
182 183
183summary-branches 184summary-branches
184 Specifies the number of branches to display in the repository "summary" 185 Specifies the number of branches to display in the repository "summary"
185 view. Default value: "10". 186 view. Default value: "10".
186 187
187summary-log 188summary-log
188 Specifies the number of log entries to display in the repository 189 Specifies the number of log entries to display in the repository
189 "summary" view. Default value: "10". 190 "summary" view. Default value: "10".
190 191
191summary-tags 192summary-tags
192 Specifies the number of tags to display in the repository "summary" 193 Specifies the number of tags to display in the repository "summary"
193 view. Default value: "10". 194 view. Default value: "10".
194 195
195virtual-root 196virtual-root
196 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
197 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
198 '/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
199 value: none. 200 value: none.
200 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
201 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.
202 203
203REPOSITORY SETTINGS 204REPOSITORY SETTINGS
204------------------- 205-------------------
205repo.clone-url 206repo.clone-url
206 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.
207 Default value: none. 208 Default value: none.
208 209
209repo.defbranch 210repo.defbranch
210 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
211 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
212 as default instead. Default value: "master". 213 as default instead. Default value: "master".
213 214
214repo.desc 215repo.desc
215 The value to show as repository description. Default value: none. 216 The value to show as repository description. Default value: none.
216 217
217repo.enable-log-filecount 218repo.enable-log-filecount
218 A flag which can be used to disable the global setting 219 A flag which can be used to disable the global setting
219 `enable-log-filecount'. Default value: none. 220 `enable-log-filecount'. Default value: none.
220 221
221repo.enable-log-linecount 222repo.enable-log-linecount
222 A flag which can be used to disable the global setting 223 A flag which can be used to disable the global setting
223 `enable-log-linecount'. Default value: none. 224 `enable-log-linecount'. Default value: none.
224 225
225repo.enable-stats 226repo.max-stats
226 A flag which can be used to disable the global setting 227 Override the default maximum statistics period. Valid values are equal
227 `enable-stats'. Default value: none. 228 to the values specified for the global "max-stats" setting. Default
229 value: none.
228 230
229repo.name 231repo.name
230 The value to show as repository name. Default value: <repo.url>. 232 The value to show as repository name. Default value: <repo.url>.
231 233
232repo.owner 234repo.owner
233 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:
234 none. 236 none.
235 237
236repo.path 238repo.path
237 An absolute path to the repository directory. For non-bare repositories 239 An absolute path to the repository directory. For non-bare repositories
238 this is the .git-directory. Default value: none. 240 this is the .git-directory. Default value: none.
239 241
240repo.readme 242repo.readme
241 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
242 verbatim as the "About" page for this repo. Default value: none. 244 verbatim as the "About" page for this repo. Default value: none.
243 245
244repo.snapshots 246repo.snapshots
245 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
246 "snapshots" global setting. Default value: <snapshots>. 248 "snapshots" global setting. Default value: <snapshots>.
247 249
248repo.url 250repo.url
249 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
250 setting specified for each repo. Default value: none. 252 setting specified for each repo. Default value: none.
251 253
252 254
253EXAMPLE CGITRC FILE 255EXAMPLE CGITRC FILE
254------------------- 256-------------------
255 257
256# Enable caching of up to 1000 output entriess 258# Enable caching of up to 1000 output entriess
257cache-size=1000 259cache-size=1000
258 260
259 261
260# Specify some default clone prefixes 262# Specify some default clone prefixes
261clone-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
262 264
263# Specify the css url 265# Specify the css url
264css=/css/cgit.css 266css=/css/cgit.css
265 267
266 268
267# Show extra links for each repository on the index page 269# Show extra links for each repository on the index page
268enable-index-links=1 270enable-index-links=1
269 271
270 272
271# Show number of affected files per commit on the log pages 273# Show number of affected files per commit on the log pages
272enable-log-filecount=1 274enable-log-filecount=1
273 275
274 276
275# 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
276enable-log-linecount=1 278enable-log-linecount=1
277 279
278 280
279# Add a cgit favicon 281# Add a cgit favicon
280favicon=/favicon.ico 282favicon=/favicon.ico
281 283
282 284
283# Use a custom logo 285# Use a custom logo
284logo=/img/mylogo.png 286logo=/img/mylogo.png
285 287
286 288
289# Enable statistics per week, month and quarter
290max-stats=quarter
291
292
287# Set the title and heading of the repository index page 293# Set the title and heading of the repository index page
288root-title=foobar.com git repositories 294root-title=foobar.com git repositories
289 295
290 296
291# Set a subheading for the repository index page 297# Set a subheading for the repository index page
292root-desc=tracking the foobar development 298root-desc=tracking the foobar development
293 299
294 300
295# Include some more info about foobar.com on the index page 301# Include some more info about foobar.com on the index page
296root-readme=/var/www/htdocs/about.html 302root-readme=/var/www/htdocs/about.html
297 303
298 304
299# Allow download of tar.gz, tar.bz and zip-files 305# Allow download of tar.gz, tar.bz and zip-files
300snapshots=tar.gz tar.bz zip 306snapshots=tar.gz tar.bz zip
301 307
302 308
303## 309##
304## List of repositories. 310## List of repositories.
305## 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
306## displayed under a group heading 312## displayed under a group heading
307## 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')
308## and included like this: 314## and included like this:
309## include=/etc/cgitrepos 315## include=/etc/cgitrepos
310## 316##
311 317
312 318
313repo.url=foo 319repo.url=foo
314repo.path=/pub/git/foo.git 320repo.path=/pub/git/foo.git
315repo.desc=the master foo repository 321repo.desc=the master foo repository
316repo.owner=fooman@foobar.com 322repo.owner=fooman@foobar.com
317repo.readme=info/web/about.html 323repo.readme=info/web/about.html
318 324
319 325
320repo.url=bar 326repo.url=bar
321repo.path=/pub/git/bar.git 327repo.path=/pub/git/bar.git
322repo.desc=the bars for your foo 328repo.desc=the bars for your foo
323repo.owner=barman@foobar.com 329repo.owner=barman@foobar.com
324repo.readme=info/web/about.html 330repo.readme=info/web/about.html
325 331
326 332
327# The next repositories will be displayed under the 'extras' heading 333# The next repositories will be displayed under the 'extras' heading
328repo.group=extras 334repo.group=extras
329 335
330 336
331repo.url=baz 337repo.url=baz
332repo.path=/pub/git/baz.git 338repo.path=/pub/git/baz.git
333repo.desc=a set of extensions for bar users 339repo.desc=a set of extensions for bar users
334 340
335repo.url=wiz 341repo.url=wiz
336repo.path=/pub/git/wiz.git 342repo.path=/pub/git/wiz.git
337repo.desc=the wizard of foo 343repo.desc=the wizard of foo
338 344
339 345
340# Add some mirrored repositories 346# Add some mirrored repositories
341repo.group=mirrors 347repo.group=mirrors
342 348
343 349
344repo.url=git 350repo.url=git
345repo.path=/pub/git/git.git 351repo.path=/pub/git/git.git
346repo.desc=the dscm 352repo.desc=the dscm
347 353
348 354
349repo.url=linux 355repo.url=linux
350repo.path=/pub/git/linux.git 356repo.path=/pub/git/linux.git
351repo.desc=the kernel 357repo.desc=the kernel
352 358
353# Disable adhoc downloads of this repo 359# Disable adhoc downloads of this repo
354repo.snapshots=0 360repo.snapshots=0
355 361
356# Disable line-counts for this repo 362# Disable line-counts for this repo
357repo.enable-log-linecount=0 363repo.enable-log-linecount=0
358 364
365# Restrict the max statistics period for this repo
366repo.max-stats=month
367
359 368
360BUGS 369BUGS
361---- 370----
362Comments 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
363will be included as part of the value. E.g. this line: 372will be included as part of the value. E.g. this line:
364 373
365 robots=index # allow indexing 374 robots=index # allow indexing
366 375
367will generate the following html element: 376will generate the following html element:
368 377
369 <meta name='robots' content='index # allow indexing'/> 378 <meta name='robots' content='index # allow indexing'/>
370 379
371 380
372 381
373AUTHOR 382AUTHOR
374------ 383------
375Lars Hjemli <hjemli@gmail.com> 384Lars Hjemli <hjemli@gmail.com>