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
@@ -61,36 +61,32 @@ 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
@@ -120,32 +116,37 @@ logo-link
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
@@ -209,35 +210,36 @@ repo.clone-url
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
@@ -271,32 +273,36 @@ enable-index-links=1
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
@@ -343,32 +349,35 @@ repo.group=mirrors
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------