summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 09f56a6..fd299ae 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,342 +1,346 @@
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
87header
88 The content of the file specified with this option will be included
89 verbatim at the top of all pages. Default value: none.
90
87include 91include
88 Name of a configfile to include before the rest of the current config- 92 Name of a configfile to include before the rest of the current config-
89 file is parsed. Default value: none. 93 file is parsed. Default value: none.
90 94
91index-header 95index-header
92 The content of the file specified with this option will be included 96 The content of the file specified with this option will be included
93 verbatim above the repository index. This setting is deprecated, and 97 verbatim above the repository index. This setting is deprecated, and
94 will not be supported by cgit-1.0 (use root-readme instead). Default 98 will not be supported by cgit-1.0 (use root-readme instead). Default
95 value: none. 99 value: none.
96 100
97index-info 101index-info
98 The content of the file specified with this option will be included 102 The content of the file specified with this option will be included
99 verbatim below the heading on the repository index page. This setting 103 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 104 is deprecated, and will not be supported by cgit-1.0 (use root-desc
101 instead). Default value: none. 105 instead). Default value: none.
102 106
103local-time 107local-time
104 Flag which, if set to "1", makes cgit print commit and tag times in the 108 Flag which, if set to "1", makes cgit print commit and tag times in the
105 servers timezone. Default value: "0". 109 servers timezone. Default value: "0".
106 110
107logo 111logo
108 Url which specifies the source of an image which will be used as a logo 112 Url which specifies the source of an image which will be used as a logo
109 on all cgit pages. 113 on all cgit pages.
110 114
111logo-link 115logo-link
112 Url loaded when clicking on the cgit logo image. If unspecified the 116 Url loaded when clicking on the cgit logo image. If unspecified the
113 calculated url of the repository index page will be used. Default 117 calculated url of the repository index page will be used. Default
114 value: none. 118 value: none.
115 119
116max-commit-count 120max-commit-count
117 Specifies the number of entries to list per page in "log" view. Default 121 Specifies the number of entries to list per page in "log" view. Default
118 value: "50". 122 value: "50".
119 123
120max-message-length 124max-message-length
121 Specifies the maximum number of commit message characters to display in 125 Specifies the maximum number of commit message characters to display in
122 "log" view. Default value: "80". 126 "log" view. Default value: "80".
123 127
124max-repo-count 128max-repo-count
125 Specifies the number of entries to list per page on therepository 129 Specifies the number of entries to list per page on therepository
126 index page. Default value: "50". 130 index page. Default value: "50".
127 131
128max-repodesc-length 132max-repodesc-length
129 Specifies the maximum number of repo description characters to display 133 Specifies the maximum number of repo description characters to display
130 on the repository index page. Default value: "80". 134 on the repository index page. Default value: "80".
131 135
132max-stats 136max-stats
133 Set the default maximum statistics period. Valid values are "week", 137 Set the default maximum statistics period. Valid values are "week",
134 "month", "quarter" and "year". If unspecified, statistics are 138 "month", "quarter" and "year". If unspecified, statistics are
135 disabled. Default value: none. See also: "repo.max-stats". 139 disabled. Default value: none. See also: "repo.max-stats".
136 140
137module-link 141module-link
138 Text which will be used as the formatstring for a hyperlink when a 142 Text which will be used as the formatstring for a hyperlink when a
139 submodule is printed in a directory listing. The arguments for the 143 submodule is printed in a directory listing. The arguments for the
140 formatstring are the path and SHA1 of the submodule commit. Default 144 formatstring are the path and SHA1 of the submodule commit. Default
141 value: "./?repo=%s&page=commit&id=%s" 145 value: "./?repo=%s&page=commit&id=%s"
142 146
143nocache 147nocache
144 If set to the value "1" caching will be disabled. This settings is 148 If set to the value "1" caching will be disabled. This settings is
145 deprecated, and will not be honored starting with cgit-1.0. Default 149 deprecated, and will not be honored starting with cgit-1.0. Default
146 value: "0". 150 value: "0".
147 151
148renamelimit 152renamelimit
149 Maximum number of files to consider when detecting renames. The value 153 Maximum number of files to consider when detecting renames. The value
150 "-1" uses the compiletime value in git (for further info, look at 154 "-1" uses the compiletime value in git (for further info, look at
151 `man git-diff`). Default value: "-1". 155 `man git-diff`). Default value: "-1".
152 156
153repo.group 157repo.group
154 A value for the current repository group, which all repositories 158 A value for the current repository group, which all repositories
155 specified after this setting will inherit. Default value: none. 159 specified after this setting will inherit. Default value: none.
156 160
157robots 161robots
158 Text used as content for the "robots" meta-tag. Default value: 162 Text used as content for the "robots" meta-tag. Default value:
159 "index, nofollow". 163 "index, nofollow".
160 164
161root-desc 165root-desc
162 Text printed below the heading on the repository index page. Default 166 Text printed below the heading on the repository index page. Default
163 value: "a fast webinterface for the git dscm". 167 value: "a fast webinterface for the git dscm".
164 168
165root-readme: 169root-readme:
166 The content of the file specified with this option will be included 170 The content of the file specified with this option will be included
167 verbatim below the "about" link on the repository index page. Default 171 verbatim below the "about" link on the repository index page. Default
168 value: none. 172 value: none.
169 173
170root-title 174root-title
171 Text printed as heading on the repository index page. Default value: 175 Text printed as heading on the repository index page. Default value:
172 "Git Repository Browser". 176 "Git Repository Browser".
173 177
174snapshots 178snapshots
175 Text which specifies the default (and allowed) set of snapshot formats 179 Text which specifies the default (and allowed) set of snapshot formats
176 supported by cgit. The value is a space-separated list of zero or more 180 supported by cgit. The value is a space-separated list of zero or more
177 of the following values: 181 of the following values:
178 "tar" uncompressed tar-file 182 "tar" uncompressed tar-file
179 "tar.gz"gzip-compressed tar-file 183 "tar.gz"gzip-compressed tar-file
180 "tar.bz2"bzip-compressed tar-file 184 "tar.bz2"bzip-compressed tar-file
181 "zip" zip-file 185 "zip" zip-file
182 Default value: none. 186 Default value: none.
183 187
184summary-branches 188summary-branches
185 Specifies the number of branches to display in the repository "summary" 189 Specifies the number of branches to display in the repository "summary"
186 view. Default value: "10". 190 view. Default value: "10".
187 191
188summary-log 192summary-log
189 Specifies the number of log entries to display in the repository 193 Specifies the number of log entries to display in the repository
190 "summary" view. Default value: "10". 194 "summary" view. Default value: "10".
191 195
192summary-tags 196summary-tags
193 Specifies the number of tags to display in the repository "summary" 197 Specifies the number of tags to display in the repository "summary"
194 view. Default value: "10". 198 view. Default value: "10".
195 199
196virtual-root 200virtual-root
197 Url which, if specified, will be used as root for all cgit links. It 201 Url which, if specified, will be used as root for all cgit links. It
198 will also cause cgit to generate 'virtual urls', i.e. urls like 202 will also cause cgit to generate 'virtual urls', i.e. urls like
199 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 203 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
200 value: none. 204 value: none.
201 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 205 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
202 same kind of virtual urls, so this option will probably be deprecated. 206 same kind of virtual urls, so this option will probably be deprecated.
203 207
204REPOSITORY SETTINGS 208REPOSITORY SETTINGS
205------------------- 209-------------------
206repo.clone-url 210repo.clone-url
207 A list of space-separated urls which can be used to clone this repo. 211 A list of space-separated urls which can be used to clone this repo.
208 Default value: none. 212 Default value: none.
209 213
210repo.defbranch 214repo.defbranch
211 The name of the default branch for this repository. If no such branch 215 The name of the default branch for this repository. If no such branch
212 exists in the repository, the first branch name (when sorted) is used 216 exists in the repository, the first branch name (when sorted) is used
213 as default instead. Default value: "master". 217 as default instead. Default value: "master".
214 218
215repo.desc 219repo.desc
216 The value to show as repository description. Default value: none. 220 The value to show as repository description. Default value: none.
217 221
218repo.enable-log-filecount 222repo.enable-log-filecount
219 A flag which can be used to disable the global setting 223 A flag which can be used to disable the global setting
220 `enable-log-filecount'. Default value: none. 224 `enable-log-filecount'. Default value: none.
221 225
222repo.enable-log-linecount 226repo.enable-log-linecount
223 A flag which can be used to disable the global setting 227 A flag which can be used to disable the global setting
224 `enable-log-linecount'. Default value: none. 228 `enable-log-linecount'. Default value: none.
225 229
226repo.max-stats 230repo.max-stats
227 Override the default maximum statistics period. Valid values are equal 231 Override the default maximum statistics period. Valid values are equal
228 to the values specified for the global "max-stats" setting. Default 232 to the values specified for the global "max-stats" setting. Default
229 value: none. 233 value: none.
230 234
231repo.name 235repo.name
232 The value to show as repository name. Default value: <repo.url>. 236 The value to show as repository name. Default value: <repo.url>.
233 237
234repo.owner 238repo.owner
235 A value used to identify the owner of the repository. Default value: 239 A value used to identify the owner of the repository. Default value:
236 none. 240 none.
237 241
238repo.path 242repo.path
239 An absolute path to the repository directory. For non-bare repositories 243 An absolute path to the repository directory. For non-bare repositories
240 this is the .git-directory. Default value: none. 244 this is the .git-directory. Default value: none.
241 245
242repo.readme 246repo.readme
243 A path (relative to <repo.path>) which specifies a file to include 247 A path (relative to <repo.path>) which specifies a file to include
244 verbatim as the "About" page for this repo. Default value: none. 248 verbatim as the "About" page for this repo. Default value: none.
245 249
246repo.snapshots 250repo.snapshots
247 A mask of allowed snapshot-formats for this repo, restricted by the 251 A mask of allowed snapshot-formats for this repo, restricted by the
248 "snapshots" global setting. Default value: <snapshots>. 252 "snapshots" global setting. Default value: <snapshots>.
249 253
250repo.url 254repo.url
251 The relative url used to access the repository. This must be the first 255 The relative url used to access the repository. This must be the first
252 setting specified for each repo. Default value: none. 256 setting specified for each repo. Default value: none.
253 257
254 258
255EXAMPLE CGITRC FILE 259EXAMPLE CGITRC FILE
256------------------- 260-------------------
257 261
258# Enable caching of up to 1000 output entriess 262# Enable caching of up to 1000 output entriess
259cache-size=1000 263cache-size=1000
260 264
261 265
262# Specify some default clone prefixes 266# Specify some default clone prefixes
263clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 267clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
264 268
265# Specify the css url 269# Specify the css url
266css=/css/cgit.css 270css=/css/cgit.css
267 271
268 272
269# Show extra links for each repository on the index page 273# Show extra links for each repository on the index page
270enable-index-links=1 274enable-index-links=1
271 275
272 276
273# Show number of affected files per commit on the log pages 277# Show number of affected files per commit on the log pages
274enable-log-filecount=1 278enable-log-filecount=1
275 279
276 280
277# Show number of added/removed lines per commit on the log pages 281# Show number of added/removed lines per commit on the log pages
278enable-log-linecount=1 282enable-log-linecount=1
279 283
280 284
281# Add a cgit favicon 285# Add a cgit favicon
282favicon=/favicon.ico 286favicon=/favicon.ico
283 287
284 288
285# Use a custom logo 289# Use a custom logo
286logo=/img/mylogo.png 290logo=/img/mylogo.png
287 291
288 292
289# Enable statistics per week, month and quarter 293# Enable statistics per week, month and quarter
290max-stats=quarter 294max-stats=quarter
291 295
292 296
293# Set the title and heading of the repository index page 297# Set the title and heading of the repository index page
294root-title=foobar.com git repositories 298root-title=foobar.com git repositories
295 299
296 300
297# Set a subheading for the repository index page 301# Set a subheading for the repository index page
298root-desc=tracking the foobar development 302root-desc=tracking the foobar development
299 303
300 304
301# Include some more info about foobar.com on the index page 305# Include some more info about foobar.com on the index page
302root-readme=/var/www/htdocs/about.html 306root-readme=/var/www/htdocs/about.html
303 307
304 308
305# Allow download of tar.gz, tar.bz2 and zip-files 309# Allow download of tar.gz, tar.bz2 and zip-files
306snapshots=tar.gz tar.bz2 zip 310snapshots=tar.gz tar.bz2 zip
307 311
308 312
309## 313##
310## List of repositories. 314## List of repositories.
311## PS: Any repositories listed when repo.group is unset will not be 315## PS: Any repositories listed when repo.group is unset will not be
312## displayed under a group heading 316## displayed under a group heading
313## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 317## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
314## and included like this: 318## and included like this:
315## include=/etc/cgitrepos 319## include=/etc/cgitrepos
316## 320##
317 321
318 322
319repo.url=foo 323repo.url=foo
320repo.path=/pub/git/foo.git 324repo.path=/pub/git/foo.git
321repo.desc=the master foo repository 325repo.desc=the master foo repository
322repo.owner=fooman@foobar.com 326repo.owner=fooman@foobar.com
323repo.readme=info/web/about.html 327repo.readme=info/web/about.html
324 328
325 329
326repo.url=bar 330repo.url=bar
327repo.path=/pub/git/bar.git 331repo.path=/pub/git/bar.git
328repo.desc=the bars for your foo 332repo.desc=the bars for your foo
329repo.owner=barman@foobar.com 333repo.owner=barman@foobar.com
330repo.readme=info/web/about.html 334repo.readme=info/web/about.html
331 335
332 336
333# The next repositories will be displayed under the 'extras' heading 337# The next repositories will be displayed under the 'extras' heading
334repo.group=extras 338repo.group=extras
335 339
336 340
337repo.url=baz 341repo.url=baz
338repo.path=/pub/git/baz.git 342repo.path=/pub/git/baz.git
339repo.desc=a set of extensions for bar users 343repo.desc=a set of extensions for bar users
340 344
341repo.url=wiz 345repo.url=wiz
342repo.path=/pub/git/wiz.git 346repo.path=/pub/git/wiz.git