summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7887b02..60d3ea4 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,316 +1,324 @@
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
77favicon 81favicon
78 Url used as link to a shortcut icon for cgit. If specified, it is 82 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 83 suggested to use the value "/favicon.ico" since certain browsers will
80 ignore other values. Default value: none. 84 ignore other values. Default value: none.
81 85
82footer 86footer
83 The content of the file specified with this option will be included 87 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 88 verbatim at the bottom of all pages (i.e. it replaces the standard
85 "generated by..." message. Default value: none. 89 "generated by..." message. Default value: none.
86 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
132module-link 136module-link
133 Text which will be used as the formatstring for a hyperlink when a 137 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 138 submodule is printed in a directory listing. The arguments for the
135 formatstring are the path and SHA1 of the submodule commit. Default 139 formatstring are the path and SHA1 of the submodule commit. Default
136 value: "./?repo=%s&page=commit&id=%s" 140 value: "./?repo=%s&page=commit&id=%s"
137 141
138nocache 142nocache
139 If set to the value "1" caching will be disabled. This settings is 143 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 144 deprecated, and will not be honored starting with cgit-1.0. Default
141 value: "0". 145 value: "0".
142 146
143renamelimit 147renamelimit
144 Maximum number of files to consider when detecting renames. The value 148 Maximum number of files to consider when detecting renames. The value
145 "-1" uses the compiletime value in git (for further info, look at 149 "-1" uses the compiletime value in git (for further info, look at
146 `man git-diff`). Default value: "-1". 150 `man git-diff`). Default value: "-1".
147 151
148repo.group 152repo.group
149 A value for the current repository group, which all repositories 153 A value for the current repository group, which all repositories
150 specified after this setting will inherit. Default value: none. 154 specified after this setting will inherit. Default value: none.
151 155
152robots 156robots
153 Text used as content for the "robots" meta-tag. Default value: 157 Text used as content for the "robots" meta-tag. Default value:
154 "index, nofollow". 158 "index, nofollow".
155 159
156root-desc 160root-desc
157 Text printed below the heading on the repository index page. Default 161 Text printed below the heading on the repository index page. Default
158 value: "a fast webinterface for the git dscm". 162 value: "a fast webinterface for the git dscm".
159 163
160root-readme: 164root-readme:
161 The content of the file specified with this option will be included 165 The content of the file specified with this option will be included
162 verbatim below the "about" link on the repository index page. Default 166 verbatim below the "about" link on the repository index page. Default
163 value: none. 167 value: none.
164 168
165root-title 169root-title
166 Text printed as heading on the repository index page. Default value: 170 Text printed as heading on the repository index page. Default value:
167 "Git Repository Browser". 171 "Git Repository Browser".
168 172
169snapshots 173snapshots
170 Text which specifies the default (and allowed) set of snapshot formats 174 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 175 supported by cgit. The value is a space-separated list of zero or more
172 of the following values: 176 of the following values:
173 "tar" uncompressed tar-file 177 "tar" uncompressed tar-file
174 "tar.gz"gzip-compressed tar-file 178 "tar.gz"gzip-compressed tar-file
175 "tar.bz2"bzip-compressed tar-file 179 "tar.bz2"bzip-compressed tar-file
176 "zip" zip-file 180 "zip" zip-file
177 Default value: none. 181 Default value: none.
178 182
179summary-branches 183summary-branches
180 Specifies the number of branches to display in the repository "summary" 184 Specifies the number of branches to display in the repository "summary"
181 view. Default value: "10". 185 view. Default value: "10".
182 186
183summary-log 187summary-log
184 Specifies the number of log entries to display in the repository 188 Specifies the number of log entries to display in the repository
185 "summary" view. Default value: "10". 189 "summary" view. Default value: "10".
186 190
187summary-tags 191summary-tags
188 Specifies the number of tags to display in the repository "summary" 192 Specifies the number of tags to display in the repository "summary"
189 view. Default value: "10". 193 view. Default value: "10".
190 194
191virtual-root 195virtual-root
192 Url which, if specified, will be used as root for all cgit links. It 196 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 197 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 198 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
195 value: none. 199 value: none.
196 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 200 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. 201 same kind of virtual urls, so this option will probably be deprecated.
198 202
199REPOSITORY SETTINGS 203REPOSITORY SETTINGS
200------------------- 204-------------------
201repo.clone-url 205repo.clone-url
202 A list of space-separated urls which can be used to clone this repo. 206 A list of space-separated urls which can be used to clone this repo.
203 Default value: none. 207 Default value: none.
204 208
205repo.defbranch 209repo.defbranch
206 The name of the default branch for this repository. If no such branch 210 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 211 exists in the repository, the first branch name (when sorted) is used
208 as default instead. Default value: "master". 212 as default instead. Default value: "master".
209 213
210repo.desc 214repo.desc
211 The value to show as repository description. Default value: none. 215 The value to show as repository description. Default value: none.
212 216
213repo.enable-log-filecount 217repo.enable-log-filecount
214 A flag which can be used to disable the global setting 218 A flag which can be used to disable the global setting
215 `enable-log-filecount'. Default value: none. 219 `enable-log-filecount'. Default value: none.
216 220
217repo.enable-log-linecount 221repo.enable-log-linecount
218 A flag which can be used to disable the global setting 222 A flag which can be used to disable the global setting
219 `enable-log-linecount'. Default value: none. 223 `enable-log-linecount'. Default value: none.
220 224
225repo.enable-stats
226 A flag which can be used to disable the global setting
227 `enable-stats'. Default value: none.
228
221repo.name 229repo.name
222 The value to show as repository name. Default value: <repo.url>. 230 The value to show as repository name. Default value: <repo.url>.
223 231
224repo.owner 232repo.owner
225 A value used to identify the owner of the repository. Default value: 233 A value used to identify the owner of the repository. Default value:
226 none. 234 none.
227 235
228repo.path 236repo.path
229 An absolute path to the repository directory. For non-bare repositories 237 An absolute path to the repository directory. For non-bare repositories
230 this is the .git-directory. Default value: none. 238 this is the .git-directory. Default value: none.
231 239
232repo.readme 240repo.readme
233 A path (relative to <repo.path>) which specifies a file to include 241 A path (relative to <repo.path>) which specifies a file to include
234 verbatim as the "About" page for this repo. Default value: none. 242 verbatim as the "About" page for this repo. Default value: none.
235 243
236repo.snapshots 244repo.snapshots
237 A mask of allowed snapshot-formats for this repo, restricted by the 245 A mask of allowed snapshot-formats for this repo, restricted by the
238 "snapshots" global setting. Default value: <snapshots>. 246 "snapshots" global setting. Default value: <snapshots>.
239 247
240repo.url 248repo.url
241 The relative url used to access the repository. This must be the first 249 The relative url used to access the repository. This must be the first
242 setting specified for each repo. Default value: none. 250 setting specified for each repo. Default value: none.
243 251
244 252
245EXAMPLE CGITRC FILE 253EXAMPLE CGITRC FILE
246------------------- 254-------------------
247 255
248# Enable caching of up to 1000 output entriess 256# Enable caching of up to 1000 output entriess
249cache-size=1000 257cache-size=1000
250 258
251 259
252# Specify some default clone prefixes 260# Specify some default clone prefixes
253clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 261clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
254 262
255# Specify the css url 263# Specify the css url
256css=/css/cgit.css 264css=/css/cgit.css
257 265
258 266
259# Show extra links for each repository on the index page 267# Show extra links for each repository on the index page
260enable-index-links=1 268enable-index-links=1
261 269
262 270
263# Show number of affected files per commit on the log pages 271# Show number of affected files per commit on the log pages
264enable-log-filecount=1 272enable-log-filecount=1
265 273
266 274
267# Show number of added/removed lines per commit on the log pages 275# Show number of added/removed lines per commit on the log pages
268enable-log-linecount=1 276enable-log-linecount=1
269 277
270 278
271# Add a cgit favicon 279# Add a cgit favicon
272favicon=/favicon.ico 280favicon=/favicon.ico
273 281
274 282
275# Use a custom logo 283# Use a custom logo
276logo=/img/mylogo.png 284logo=/img/mylogo.png
277 285
278 286
279# Set the title and heading of the repository index page 287# Set the title and heading of the repository index page
280root-title=foobar.com git repositories 288root-title=foobar.com git repositories
281 289
282 290
283# Set a subheading for the repository index page 291# Set a subheading for the repository index page
284root-desc=tracking the foobar development 292root-desc=tracking the foobar development
285 293
286 294
287# Include some more info about foobar.com on the index page 295# Include some more info about foobar.com on the index page
288root-readme=/var/www/htdocs/about.html 296root-readme=/var/www/htdocs/about.html
289 297
290 298
291# Allow download of tar.gz, tar.bz and zip-files 299# Allow download of tar.gz, tar.bz and zip-files
292snapshots=tar.gz tar.bz zip 300snapshots=tar.gz tar.bz zip
293 301
294 302
295## 303##
296## List of repositories. 304## List of repositories.
297## PS: Any repositories listed when repo.group is unset will not be 305## PS: Any repositories listed when repo.group is unset will not be
298## displayed under a group heading 306## displayed under a group heading
299## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 307## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
300## and included like this: 308## and included like this:
301## include=/etc/cgitrepos 309## include=/etc/cgitrepos
302## 310##
303 311
304 312
305repo.url=foo 313repo.url=foo
306repo.path=/pub/git/foo.git 314repo.path=/pub/git/foo.git
307repo.desc=the master foo repository 315repo.desc=the master foo repository
308repo.owner=fooman@foobar.com 316repo.owner=fooman@foobar.com
309repo.readme=info/web/about.html 317repo.readme=info/web/about.html
310 318
311 319
312repo.url=bar 320repo.url=bar
313repo.path=/pub/git/bar.git 321repo.path=/pub/git/bar.git
314repo.desc=the bars for your foo 322repo.desc=the bars for your foo
315repo.owner=barman@foobar.com 323repo.owner=barman@foobar.com
316repo.readme=info/web/about.html 324repo.readme=info/web/about.html