summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2011-02-19 13:01:59 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2011-02-19 13:01:59 (UTC)
commit31e1f9af1d46bd7dfdb3b2ac580c0d0cc8dbaa63 (patch) (unidiff)
tree26200ad3c376ea1208d2a870ebb3b2bc6d7abee6 /cgitrc.5.txt
parente66a16cebcdac53b63e77876acef1ca9e4877038 (diff)
parentc2bfd40f8aaaa69a66c6eb729c202e42a43ec166 (diff)
downloadcgit-31e1f9af1d46bd7dfdb3b2ac580c0d0cc8dbaa63.zip
cgit-31e1f9af1d46bd7dfdb3b2ac580c0d0cc8dbaa63.tar.gz
cgit-31e1f9af1d46bd7dfdb3b2ac580c0d0cc8dbaa63.tar.bz2
Merge branch 'jh/graph'
* jh/graph: ui-log: Move 'Age' column when commit graph is present ui-log: Line-wrap long commit subjects when showmsg is enabled ui-log: Colorize commit graph ui-log: Implement support for commit graphs ui-log: Change display of full commit messages (and notes) Conflicts: cgit.css
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 8e51ca5..3c20fe1 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,570 +1,583 @@
1:man source: cgit 1:man source: cgit
2:man manual: cgit 2:man manual: cgit
3 3
4CGITRC(5) 4CGITRC(5)
5======== 5========
6 6
7 7
8NAME 8NAME
9---- 9----
10cgitrc - runtime configuration for cgit 10cgitrc - runtime configuration for cgit
11 11
12 12
13SYNOPSIS 13SYNOPSIS
14-------- 14--------
15Cgitrc contains all runtime settings for cgit, including the list of git 15Cgitrc contains all runtime settings for cgit, including the list of git
16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 16repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
17lines, and lines starting with '#', are ignored. 17lines, and lines starting with '#', are ignored.
18 18
19 19
20LOCATION 20LOCATION
21-------- 21--------
22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At 22The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
23runtime, cgit will consult the environment variable CGIT_CONFIG and, if 23runtime, cgit will consult the environment variable CGIT_CONFIG and, if
24defined, use its value instead. 24defined, use its value instead.
25 25
26 26
27GLOBAL SETTINGS 27GLOBAL SETTINGS
28--------------- 28---------------
29about-filter:: 29about-filter::
30 Specifies a command which will be invoked to format the content of 30 Specifies a command which will be invoked to format the content of
31 about pages (both top-level and for each repository). The command will 31 about pages (both top-level and for each repository). The command will
32 get the content of the about-file on its STDIN, and the STDOUT from the 32 get the content of the about-file on its STDIN, and the STDOUT from the
33 command will be included verbatim on the about page. Default value: 33 command will be included verbatim on the about page. Default value:
34 none. 34 none.
35 35
36agefile:: 36agefile::
37 Specifies a path, relative to each repository path, which can be used 37 Specifies a path, relative to each repository path, which can be used
38 to specify the date and time of the youngest commit in the repository. 38 to specify the date and time of the youngest commit in the repository.
39 The first line in the file is used as input to the "parse_date" 39 The first line in the file is used as input to the "parse_date"
40 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 40 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
41 hh:mm:ss". Default value: "info/web/last-modified". 41 hh:mm:ss". Default value: "info/web/last-modified".
42 42
43cache-root:: 43cache-root::
44 Path used to store the cgit cache entries. Default value: 44 Path used to store the cgit cache entries. Default value:
45 "/var/cache/cgit". 45 "/var/cache/cgit".
46 46
47cache-dynamic-ttl:: 47cache-dynamic-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 without a fixed SHA1. Default 49 version of repository pages accessed without a fixed SHA1. Default
50 value: "5". 50 value: "5".
51 51
52cache-repo-ttl:: 52cache-repo-ttl::
53 Number which specifies the time-to-live, in minutes, for the cached 53 Number which specifies the time-to-live, in minutes, for the cached
54 version of the repository summary page. Default value: "5". 54 version of the repository summary page. Default value: "5".
55 55
56cache-root-ttl:: 56cache-root-ttl::
57 Number which specifies the time-to-live, in minutes, for the cached 57 Number which specifies the time-to-live, in minutes, for the cached
58 version of the repository index page. Default value: "5". 58 version of the repository index page. Default value: "5".
59 59
60cache-scanrc-ttl:: 60cache-scanrc-ttl::
61 Number which specifies the time-to-live, in minutes, for the result 61 Number which specifies the time-to-live, in minutes, for the result
62 of scanning a path for git repositories. Default value: "15". 62 of scanning a path for git repositories. Default value: "15".
63 63
64cache-size:: 64cache-size::
65 The maximum number of entries in the cgit cache. Default value: "0" 65 The maximum number of entries in the cgit cache. Default value: "0"
66 (i.e. caching is disabled). 66 (i.e. caching is disabled).
67 67
68cache-static-ttl:: 68cache-static-ttl::
69 Number which specifies the time-to-live, in minutes, for the cached 69 Number which specifies the time-to-live, in minutes, for the cached
70 version of repository pages accessed with a fixed SHA1. Default value: 70 version of repository pages accessed with a fixed SHA1. Default value:
71 "5". 71 "5".
72 72
73clone-prefix:: 73clone-prefix::
74 Space-separated list of common prefixes which, when combined with a 74 Space-separated list of common prefixes which, when combined with a
75 repository url, generates valid clone urls for the repository. This 75 repository url, generates valid clone urls for the repository. This
76 setting is only used if `repo.clone-url` is unspecified. Default value: 76 setting is only used if `repo.clone-url` is unspecified. Default value:
77 none. 77 none.
78 78
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
82 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-commit-graph::
95 Flag which, when set to "1", will make cgit print an ASCII-art commit
96 history graph to the left of the commit messages in the repository
97 log page. Default value: "0".
98
94enable-filter-overrides:: 99enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 100 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 101 overridden in repository-specific cgitrc files. Default value: none.
97 102
98enable-gitweb-owner:: 103enable-gitweb-owner::
99 If set to "1" and scan-path is enabled, we first check each repository 104 If set to "1" and scan-path is enabled, we first check each repository
100 for the git config value "gitweb.owner" to determine the owner. 105 for the git config value "gitweb.owner" to determine the owner.
101 Default value: "1". See also: scan-path. 106 Default value: "1". See also: scan-path.
102 107
103enable-index-links:: 108enable-index-links::
104 Flag which, when set to "1", will make cgit generate extra links for 109 Flag which, when set to "1", will make cgit generate extra links for
105 each repo in the repository index (specifically, to the "summary", 110 each repo in the repository index (specifically, to the "summary",
106 "commit" and "tree" pages). Default value: "0". 111 "commit" and "tree" pages). Default value: "0".
107 112
108enable-log-filecount:: 113enable-log-filecount::
109 Flag which, when set to "1", will make cgit print the number of 114 Flag which, when set to "1", will make cgit print the number of
110 modified files for each commit on the repository log page. Default 115 modified files for each commit on the repository log page. Default
111 value: "0". 116 value: "0".
112 117
113enable-log-linecount:: 118enable-log-linecount::
114 Flag which, when set to "1", will make cgit print the number of added 119 Flag which, when set to "1", will make cgit print the number of added
115 and removed lines for each commit on the repository log page. Default 120 and removed lines for each commit on the repository log page. Default
116 value: "0". 121 value: "0".
117 122
118enable-remote-branches:: 123enable-remote-branches::
119 Flag which, when set to "1", will make cgit display remote branches 124 Flag which, when set to "1", will make cgit display remote branches
120 in the summary and refs views. Default value: "0". See also: 125 in the summary and refs views. Default value: "0". See also:
121 "repo.enable-remote-branches". 126 "repo.enable-remote-branches".
122 127
123enable-subject-links:: 128enable-subject-links::
124 Flag which, when set to "1", will make cgit use the subject of the 129 Flag which, when set to "1", will make cgit use the subject of the
125 parent commit as link text when generating links to parent commits 130 parent commit as link text when generating links to parent commits
126 in commit view. Default value: "0". See also: 131 in commit view. Default value: "0". See also:
127 "repo.enable-subject-links". 132 "repo.enable-subject-links".
128 133
129enable-tree-linenumbers:: 134enable-tree-linenumbers::
130 Flag which, when set to "1", will make cgit generate linenumber links 135 Flag which, when set to "1", will make cgit generate linenumber links
131 for plaintext blobs printed in the tree view. Default value: "1". 136 for plaintext blobs printed in the tree view. Default value: "1".
132 137
133favicon:: 138favicon::
134 Url used as link to a shortcut icon for cgit. If specified, it is 139 Url used as link to a shortcut icon for cgit. If specified, it is
135 suggested to use the value "/favicon.ico" since certain browsers will 140 suggested to use the value "/favicon.ico" since certain browsers will
136 ignore other values. Default value: none. 141 ignore other values. Default value: none.
137 142
138footer:: 143footer::
139 The content of the file specified with this option will be included 144 The content of the file specified with this option will be included
140 verbatim at the bottom of all pages (i.e. it replaces the standard 145 verbatim at the bottom of all pages (i.e. it replaces the standard
141 "generated by..." message. Default value: none. 146 "generated by..." message. Default value: none.
142 147
143head-include:: 148head-include::
144 The content of the file specified with this option will be included 149 The content of the file specified with this option will be included
145 verbatim in the html HEAD section on all pages. Default value: none. 150 verbatim in the html HEAD section on all pages. Default value: none.
146 151
147header:: 152header::
148 The content of the file specified with this option will be included 153 The content of the file specified with this option will be included
149 verbatim at the top of all pages. Default value: none. 154 verbatim at the top of all pages. Default value: none.
150 155
151include:: 156include::
152 Name of a configfile to include before the rest of the current config- 157 Name of a configfile to include before the rest of the current config-
153 file is parsed. Default value: none. 158 file is parsed. Default value: none.
154 159
155index-header:: 160index-header::
156 The content of the file specified with this option will be included 161 The content of the file specified with this option will be included
157 verbatim above the repository index. This setting is deprecated, and 162 verbatim above the repository index. This setting is deprecated, and
158 will not be supported by cgit-1.0 (use root-readme instead). Default 163 will not be supported by cgit-1.0 (use root-readme instead). Default
159 value: none. 164 value: none.
160 165
161index-info:: 166index-info::
162 The content of the file specified with this option will be included 167 The content of the file specified with this option will be included
163 verbatim below the heading on the repository index page. This setting 168 verbatim below the heading on the repository index page. This setting
164 is deprecated, and will not be supported by cgit-1.0 (use root-desc 169 is deprecated, and will not be supported by cgit-1.0 (use root-desc
165 instead). Default value: none. 170 instead). Default value: none.
166 171
167local-time:: 172local-time::
168 Flag which, if set to "1", makes cgit print commit and tag times in the 173 Flag which, if set to "1", makes cgit print commit and tag times in the
169 servers timezone. Default value: "0". 174 servers timezone. Default value: "0".
170 175
171logo:: 176logo::
172 Url which specifies the source of an image which will be used as a logo 177 Url which specifies the source of an image which will be used as a logo
173 on all cgit pages. Default value: "/cgit.png". 178 on all cgit pages. Default value: "/cgit.png".
174 179
175logo-link:: 180logo-link::
176 Url loaded when clicking on the cgit logo image. If unspecified the 181 Url loaded when clicking on the cgit logo image. If unspecified the
177 calculated url of the repository index page will be used. Default 182 calculated url of the repository index page will be used. Default
178 value: none. 183 value: none.
179 184
180max-atom-items:: 185max-atom-items::
181 Specifies the number of items to display in atom feeds view. Default 186 Specifies the number of items to display in atom feeds view. Default
182 value: "10". 187 value: "10".
183 188
184max-commit-count:: 189max-commit-count::
185 Specifies the number of entries to list per page in "log" view. Default 190 Specifies the number of entries to list per page in "log" view. Default
186 value: "50". 191 value: "50".
187 192
188max-message-length:: 193max-message-length::
189 Specifies the maximum number of commit message characters to display in 194 Specifies the maximum number of commit message characters to display in
190 "log" view. Default value: "80". 195 "log" view. Default value: "80".
191 196
192max-repo-count:: 197max-repo-count::
193 Specifies the number of entries to list per page on therepository 198 Specifies the number of entries to list per page on therepository
194 index page. Default value: "50". 199 index page. Default value: "50".
195 200
196max-repodesc-length:: 201max-repodesc-length::
197 Specifies the maximum number of repo description characters to display 202 Specifies the maximum number of repo description characters to display
198 on the repository index page. Default value: "80". 203 on the repository index page. Default value: "80".
199 204
200max-blob-size:: 205max-blob-size::
201 Specifies the maximum size of a blob to display HTML for in KBytes. 206 Specifies the maximum size of a blob to display HTML for in KBytes.
202 Default value: "0" (limit disabled). 207 Default value: "0" (limit disabled).
203 208
204max-stats:: 209max-stats::
205 Set the default maximum statistics period. Valid values are "week", 210 Set the default maximum statistics period. Valid values are "week",
206 "month", "quarter" and "year". If unspecified, statistics are 211 "month", "quarter" and "year". If unspecified, statistics are
207 disabled. Default value: none. See also: "repo.max-stats". 212 disabled. Default value: none. See also: "repo.max-stats".
208 213
209mimetype.<ext>:: 214mimetype.<ext>::
210 Set the mimetype for the specified filename extension. This is used 215 Set the mimetype for the specified filename extension. This is used
211 by the `plain` command when returning blob content. 216 by the `plain` command when returning blob content.
212 217
213module-link:: 218module-link::
214 Text which will be used as the formatstring for a hyperlink when a 219 Text which will be used as the formatstring for a hyperlink when a
215 submodule is printed in a directory listing. The arguments for the 220 submodule is printed in a directory listing. The arguments for the
216 formatstring are the path and SHA1 of the submodule commit. Default 221 formatstring are the path and SHA1 of the submodule commit. Default
217 value: "./?repo=%s&page=commit&id=%s" 222 value: "./?repo=%s&page=commit&id=%s"
218 223
219nocache:: 224nocache::
220 If set to the value "1" caching will be disabled. This settings is 225 If set to the value "1" caching will be disabled. This settings is
221 deprecated, and will not be honored starting with cgit-1.0. Default 226 deprecated, and will not be honored starting with cgit-1.0. Default
222 value: "0". 227 value: "0".
223 228
224noplainemail:: 229noplainemail::
225 If set to "1" showing full author email adresses will be disabled. 230 If set to "1" showing full author email adresses will be disabled.
226 Default value: "0". 231 Default value: "0".
227 232
228noheader:: 233noheader::
229 Flag which, when set to "1", will make cgit omit the standard header 234 Flag which, when set to "1", will make cgit omit the standard header
230 on all pages. Default value: none. See also: "embedded". 235 on all pages. Default value: none. See also: "embedded".
231 236
232project-list:: 237project-list::
233 A list of subdirectories inside of scan-path, relative to it, that 238 A list of subdirectories inside of scan-path, relative to it, that
234 should loaded as git repositories. This must be defined prior to 239 should loaded as git repositories. This must be defined prior to
235 scan-path. Default value: none. See also: scan-path. 240 scan-path. Default value: none. See also: scan-path.
236 241
237readme:: 242readme::
238 Text which will be used as default value for "repo.readme". Default 243 Text which will be used as default value for "repo.readme". Default
239 value: none. 244 value: none.
240 245
241remove-suffix:: 246remove-suffix::
242 If set to "1" and scan-path is enabled, if any repositories are found 247 If set to "1" and scan-path is enabled, if any repositories are found
243 with a suffix of ".git", this suffix will be removed for the url and 248 with a suffix of ".git", this suffix will be removed for the url and
244 name. Default value: "0". See also: scan-path. 249 name. Default value: "0". See also: scan-path.
245 250
246renamelimit:: 251renamelimit::
247 Maximum number of files to consider when detecting renames. The value 252 Maximum number of files to consider when detecting renames. The value
248 "-1" uses the compiletime value in git (for further info, look at 253 "-1" uses the compiletime value in git (for further info, look at
249 `man git-diff`). Default value: "-1". 254 `man git-diff`). Default value: "-1".
250 255
251repo.group:: 256repo.group::
252 Legacy alias for "section". This option is deprecated and will not be 257 Legacy alias for "section". This option is deprecated and will not be
253 supported in cgit-1.0. 258 supported in cgit-1.0.
254 259
255robots:: 260robots::
256 Text used as content for the "robots" meta-tag. Default value: 261 Text used as content for the "robots" meta-tag. Default value:
257 "index, nofollow". 262 "index, nofollow".
258 263
259root-desc:: 264root-desc::
260 Text printed below the heading on the repository index page. Default 265 Text printed below the heading on the repository index page. Default
261 value: "a fast webinterface for the git dscm". 266 value: "a fast webinterface for the git dscm".
262 267
263root-readme:: 268root-readme::
264 The content of the file specified with this option will be included 269 The content of the file specified with this option will be included
265 verbatim below the "about" link on the repository index page. Default 270 verbatim below the "about" link on the repository index page. Default
266 value: none. 271 value: none.
267 272
268root-title:: 273root-title::
269 Text printed as heading on the repository index page. Default value: 274 Text printed as heading on the repository index page. Default value:
270 "Git Repository Browser". 275 "Git Repository Browser".
271 276
272scan-path:: 277scan-path::
273 A path which will be scanned for repositories. If caching is enabled, 278 A path which will be scanned for repositories. If caching is enabled,
274 the result will be cached as a cgitrc include-file in the cache 279 the result will be cached as a cgitrc include-file in the cache
275 directory. If project-list has been defined prior to scan-path, 280 directory. If project-list has been defined prior to scan-path,
276 scan-path loads only the directories listed in the file pointed to by 281 scan-path loads only the directories listed in the file pointed to by
277 project-list. Default value: none. See also: cache-scanrc-ttl, 282 project-list. Default value: none. See also: cache-scanrc-ttl,
278 project-list. 283 project-list.
279 284
280section:: 285section::
281 The name of the current repository section - all repositories defined 286 The name of the current repository section - all repositories defined
282 after this option will inherit the current section name. Default value: 287 after this option will inherit the current section name. Default value:
283 none. 288 none.
284 289
285section-from-path:: 290section-from-path::
286 A number which, if specified before scan-path, specifies how many 291 A number which, if specified before scan-path, specifies how many
287 path elements from each repo path to use as a default section name. 292 path elements from each repo path to use as a default section name.
288 If negative, cgit will discard the specified number of path elements 293 If negative, cgit will discard the specified number of path elements
289 above the repo directory. Default value: 0. 294 above the repo directory. Default value: 0.
290 295
291side-by-side-diffs:: 296side-by-side-diffs::
292 If set to "1" shows side-by-side diffs instead of unidiffs per 297 If set to "1" shows side-by-side diffs instead of unidiffs per
293 default. Default value: "0". 298 default. Default value: "0".
294 299
295snapshots:: 300snapshots::
296 Text which specifies the default set of snapshot formats generated by 301 Text which specifies the default set of snapshot formats generated by
297 cgit. The value is a space-separated list of zero or more of the 302 cgit. The value is a space-separated list of zero or more of the
298 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 303 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
299 304
300source-filter:: 305source-filter::
301 Specifies a command which will be invoked to format plaintext blobs 306 Specifies a command which will be invoked to format plaintext blobs
302 in the tree view. The command will get the blob content on its STDIN 307 in the tree view. The command will get the blob content on its STDIN
303 and the name of the blob as its only command line argument. The STDOUT 308 and the name of the blob as its only command line argument. The STDOUT
304 from the command will be included verbatim as the blob contents, i.e. 309 from the command will be included verbatim as the blob contents, i.e.
305 this can be used to implement e.g. syntax highlighting. Default value: 310 this can be used to implement e.g. syntax highlighting. Default value:
306 none. 311 none.
307 312
308summary-branches:: 313summary-branches::
309 Specifies the number of branches to display in the repository "summary" 314 Specifies the number of branches to display in the repository "summary"
310 view. Default value: "10". 315 view. Default value: "10".
311 316
312summary-log:: 317summary-log::
313 Specifies the number of log entries to display in the repository 318 Specifies the number of log entries to display in the repository
314 "summary" view. Default value: "10". 319 "summary" view. Default value: "10".
315 320
316summary-tags:: 321summary-tags::
317 Specifies the number of tags to display in the repository "summary" 322 Specifies the number of tags to display in the repository "summary"
318 view. Default value: "10". 323 view. Default value: "10".
319 324
320strict-export:: 325strict-export::
321 Filename which, if specified, needs to be present within the repository 326 Filename which, if specified, needs to be present within the repository
322 for cgit to allow access to that repository. This can be used to emulate 327 for cgit to allow access to that repository. This can be used to emulate
323 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's 328 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
324 repositories to match those exported by git-daemon. This option MUST come 329 repositories to match those exported by git-daemon. This option MUST come
325 before 'scan-path'. 330 before 'scan-path'.
326 331
327virtual-root:: 332virtual-root::
328 Url which, if specified, will be used as root for all cgit links. It 333 Url which, if specified, will be used as root for all cgit links. It
329 will also cause cgit to generate 'virtual urls', i.e. urls like 334 will also cause cgit to generate 'virtual urls', i.e. urls like
330 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 335 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
331 value: none. 336 value: none.
332 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 337 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
333 same kind of virtual urls, so this option will probably be deprecated. 338 same kind of virtual urls, so this option will probably be deprecated.
334 339
335REPOSITORY SETTINGS 340REPOSITORY SETTINGS
336------------------- 341-------------------
337repo.about-filter:: 342repo.about-filter::
338 Override the default about-filter. Default value: none. See also: 343 Override the default about-filter. Default value: none. See also:
339 "enable-filter-overrides". 344 "enable-filter-overrides".
340 345
341repo.clone-url:: 346repo.clone-url::
342 A list of space-separated urls which can be used to clone this repo. 347 A list of space-separated urls which can be used to clone this repo.
343 Default value: none. 348 Default value: none.
344 349
345repo.commit-filter:: 350repo.commit-filter::
346 Override the default commit-filter. Default value: none. See also: 351 Override the default commit-filter. Default value: none. See also:
347 "enable-filter-overrides". 352 "enable-filter-overrides".
348 353
349repo.defbranch:: 354repo.defbranch::
350 The name of the default branch for this repository. If no such branch 355 The name of the default branch for this repository. If no such branch
351 exists in the repository, the first branch name (when sorted) is used 356 exists in the repository, the first branch name (when sorted) is used
352 as default instead. Default value: "master". 357 as default instead. Default value: "master".
353 358
354repo.desc:: 359repo.desc::
355 The value to show as repository description. Default value: none. 360 The value to show as repository description. Default value: none.
356 361
362repo.enable-commit-graph::
363 A flag which can be used to disable the global setting
364 `enable-commit-graph'. Default value: none.
365
357repo.enable-log-filecount:: 366repo.enable-log-filecount::
358 A flag which can be used to disable the global setting 367 A flag which can be used to disable the global setting
359 `enable-log-filecount'. Default value: none. 368 `enable-log-filecount'. Default value: none.
360 369
361repo.enable-log-linecount:: 370repo.enable-log-linecount::
362 A flag which can be used to disable the global setting 371 A flag which can be used to disable the global setting
363 `enable-log-linecount'. Default value: none. 372 `enable-log-linecount'. Default value: none.
364 373
365repo.enable-remote-branches:: 374repo.enable-remote-branches::
366 Flag which, when set to "1", will make cgit display remote branches 375 Flag which, when set to "1", will make cgit display remote branches
367 in the summary and refs views. Default value: <enable-remote-branches>. 376 in the summary and refs views. Default value: <enable-remote-branches>.
368 377
369repo.enable-subject-links:: 378repo.enable-subject-links::
370 A flag which can be used to override the global setting 379 A flag which can be used to override the global setting
371 `enable-subject-links'. Default value: none. 380 `enable-subject-links'. Default value: none.
372 381
373repo.max-stats:: 382repo.max-stats::
374 Override the default maximum statistics period. Valid values are equal 383 Override the default maximum statistics period. Valid values are equal
375 to the values specified for the global "max-stats" setting. Default 384 to the values specified for the global "max-stats" setting. Default
376 value: none. 385 value: none.
377 386
378repo.name:: 387repo.name::
379 The value to show as repository name. Default value: <repo.url>. 388 The value to show as repository name. Default value: <repo.url>.
380 389
381repo.owner:: 390repo.owner::
382 A value used to identify the owner of the repository. Default value: 391 A value used to identify the owner of the repository. Default value:
383 none. 392 none.
384 393
385repo.path:: 394repo.path::
386 An absolute path to the repository directory. For non-bare repositories 395 An absolute path to the repository directory. For non-bare repositories
387 this is the .git-directory. Default value: none. 396 this is the .git-directory. Default value: none.
388 397
389repo.readme:: 398repo.readme::
390 A path (relative to <repo.path>) which specifies a file to include 399 A path (relative to <repo.path>) which specifies a file to include
391 verbatim as the "About" page for this repo. You may also specify a 400 verbatim as the "About" page for this repo. You may also specify a
392 git refspec by head or by hash by prepending the refspec followed by 401 git refspec by head or by hash by prepending the refspec followed by
393 a colon. For example, "master:docs/readme.mkd" Default value: <readme>. 402 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
394 403
395repo.snapshots:: 404repo.snapshots::
396 A mask of allowed snapshot-formats for this repo, restricted by the 405 A mask of allowed snapshot-formats for this repo, restricted by the
397 "snapshots" global setting. Default value: <snapshots>. 406 "snapshots" global setting. Default value: <snapshots>.
398 407
399repo.section:: 408repo.section::
400 Override the current section name for this repository. Default value: 409 Override the current section name for this repository. Default value:
401 none. 410 none.
402 411
403repo.source-filter:: 412repo.source-filter::
404 Override the default source-filter. Default value: none. See also: 413 Override the default source-filter. Default value: none. See also:
405 "enable-filter-overrides". 414 "enable-filter-overrides".
406 415
407repo.url:: 416repo.url::
408 The relative url used to access the repository. This must be the first 417 The relative url used to access the repository. This must be the first
409 setting specified for each repo. Default value: none. 418 setting specified for each repo. Default value: none.
410 419
411 420
412REPOSITORY-SPECIFIC CGITRC FILE 421REPOSITORY-SPECIFIC CGITRC FILE
413------------------------------- 422-------------------------------
414When the option "scan-path" is used to auto-discover git repositories, cgit 423When the option "scan-path" is used to auto-discover git repositories, cgit
415will try to parse the file "cgitrc" within any found repository. Such a 424will try to parse the file "cgitrc" within any found repository. Such a
416repo-specific config file may contain any of the repo-specific options 425repo-specific config file may contain any of the repo-specific options
417described above, except "repo.url" and "repo.path". Additionally, the "filter" 426described above, except "repo.url" and "repo.path". Additionally, the "filter"
418options are only acknowledged in repo-specific config files when 427options are only acknowledged in repo-specific config files when
419"enable-filter-overrides" is set to "1". 428"enable-filter-overrides" is set to "1".
420 429
421Note: the "repo." prefix is dropped from the option names in repo-specific 430Note: the "repo." prefix is dropped from the option names in repo-specific
422config files, e.g. "repo.desc" becomes "desc". 431config files, e.g. "repo.desc" becomes "desc".
423 432
424 433
425EXAMPLE CGITRC FILE 434EXAMPLE CGITRC FILE
426------------------- 435-------------------
427 436
428.... 437....
429# Enable caching of up to 1000 output entriess 438# Enable caching of up to 1000 output entriess
430cache-size=1000 439cache-size=1000
431 440
432 441
433# Specify some default clone prefixes 442# Specify some default clone prefixes
434clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git 443clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git
435 444
436# Specify the css url 445# Specify the css url
437css=/css/cgit.css 446css=/css/cgit.css
438 447
439 448
440# Show extra links for each repository on the index page 449# Show extra links for each repository on the index page
441enable-index-links=1 450enable-index-links=1
442 451
443 452
453# Enable ASCII art commit history graph on the log pages
454enable-commit-graph=1
455
456
444# Show number of affected files per commit on the log pages 457# Show number of affected files per commit on the log pages
445enable-log-filecount=1 458enable-log-filecount=1
446 459
447 460
448# Show number of added/removed lines per commit on the log pages 461# Show number of added/removed lines per commit on the log pages
449enable-log-linecount=1 462enable-log-linecount=1
450 463
451 464
452# Add a cgit favicon 465# Add a cgit favicon
453favicon=/favicon.ico 466favicon=/favicon.ico
454 467
455 468
456# Use a custom logo 469# Use a custom logo
457logo=/img/mylogo.png 470logo=/img/mylogo.png
458 471
459 472
460# Enable statistics per week, month and quarter 473# Enable statistics per week, month and quarter
461max-stats=quarter 474max-stats=quarter
462 475
463 476
464# Set the title and heading of the repository index page 477# Set the title and heading of the repository index page
465root-title=example.com git repositories 478root-title=example.com git repositories
466 479
467 480
468# Set a subheading for the repository index page 481# Set a subheading for the repository index page
469root-desc=tracking the foobar development 482root-desc=tracking the foobar development
470 483
471 484
472# Include some more info about example.com on the index page 485# Include some more info about example.com on the index page
473root-readme=/var/www/htdocs/about.html 486root-readme=/var/www/htdocs/about.html
474 487
475 488
476# Allow download of tar.gz, tar.bz2 and zip-files 489# Allow download of tar.gz, tar.bz2 and zip-files
477snapshots=tar.gz tar.bz2 zip 490snapshots=tar.gz tar.bz2 zip
478 491
479 492
480## 493##
481## List of common mimetypes 494## List of common mimetypes
482## 495##
483 496
484mimetype.gif=image/gif 497mimetype.gif=image/gif
485mimetype.html=text/html 498mimetype.html=text/html
486mimetype.jpg=image/jpeg 499mimetype.jpg=image/jpeg
487mimetype.jpeg=image/jpeg 500mimetype.jpeg=image/jpeg
488mimetype.pdf=application/pdf 501mimetype.pdf=application/pdf
489mimetype.png=image/png 502mimetype.png=image/png
490mimetype.svg=image/svg+xml 503mimetype.svg=image/svg+xml
491 504
492 505
493## 506##
494## List of repositories. 507## List of repositories.
495## PS: Any repositories listed when section is unset will not be 508## PS: Any repositories listed when section is unset will not be
496## displayed under a section heading 509## displayed under a section heading
497## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 510## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
498## and included like this: 511## and included like this:
499## include=/etc/cgitrepos 512## include=/etc/cgitrepos
500## 513##
501 514
502 515
503repo.url=foo 516repo.url=foo
504repo.path=/pub/git/foo.git 517repo.path=/pub/git/foo.git
505repo.desc=the master foo repository 518repo.desc=the master foo repository
506repo.owner=fooman@example.com 519repo.owner=fooman@example.com
507repo.readme=info/web/about.html 520repo.readme=info/web/about.html
508 521
509 522
510repo.url=bar 523repo.url=bar
511repo.path=/pub/git/bar.git 524repo.path=/pub/git/bar.git
512repo.desc=the bars for your foo 525repo.desc=the bars for your foo
513repo.owner=barman@example.com 526repo.owner=barman@example.com
514repo.readme=info/web/about.html 527repo.readme=info/web/about.html
515 528
516 529
517# The next repositories will be displayed under the 'extras' heading 530# The next repositories will be displayed under the 'extras' heading
518section=extras 531section=extras
519 532
520 533
521repo.url=baz 534repo.url=baz
522repo.path=/pub/git/baz.git 535repo.path=/pub/git/baz.git
523repo.desc=a set of extensions for bar users 536repo.desc=a set of extensions for bar users
524 537
525repo.url=wiz 538repo.url=wiz
526repo.path=/pub/git/wiz.git 539repo.path=/pub/git/wiz.git
527repo.desc=the wizard of foo 540repo.desc=the wizard of foo
528 541
529 542
530# Add some mirrored repositories 543# Add some mirrored repositories
531section=mirrors 544section=mirrors
532 545
533 546
534repo.url=git 547repo.url=git
535repo.path=/pub/git/git.git 548repo.path=/pub/git/git.git
536repo.desc=the dscm 549repo.desc=the dscm
537 550
538 551
539repo.url=linux 552repo.url=linux
540repo.path=/pub/git/linux.git 553repo.path=/pub/git/linux.git
541repo.desc=the kernel 554repo.desc=the kernel
542 555
543# Disable adhoc downloads of this repo 556# Disable adhoc downloads of this repo
544repo.snapshots=0 557repo.snapshots=0
545 558
546# Disable line-counts for this repo 559# Disable line-counts for this repo
547repo.enable-log-linecount=0 560repo.enable-log-linecount=0
548 561
549# Restrict the max statistics period for this repo 562# Restrict the max statistics period for this repo
550repo.max-stats=month 563repo.max-stats=month
551.... 564....
552 565
553 566
554BUGS 567BUGS
555---- 568----
556Comments currently cannot appear on the same line as a setting; the comment 569Comments currently cannot appear on the same line as a setting; the comment
557will be included as part of the value. E.g. this line: 570will be included as part of the value. E.g. this line:
558 571
559 robots=index # allow indexing 572 robots=index # allow indexing
560 573
561will generate the following html element: 574will generate the following html element:
562 575
563 <meta name='robots' content='index # allow indexing'/> 576 <meta name='robots' content='index # allow indexing'/>
564 577
565 578
566 579
567AUTHOR 580AUTHOR
568------ 581------
569Lars Hjemli <hjemli@gmail.com> 582Lars Hjemli <hjemli@gmail.com>
570Jason A. Donenfeld <Jason@zx2c4.com> 583Jason A. Donenfeld <Jason@zx2c4.com>