aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt198
1 files changed, 133 insertions, 65 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fd299ae..0d18290 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,203 +1,247 @@
1CGITRC 1CGITRC(5)
2====== 2========
3 3
4 4
5NAME 5NAME
6---- 6----
7 cgitrc - runtime configuration for cgit 7cgitrc - runtime configuration for cgit
8 8
9 9
10DESCRIPTION 10SYNOPSIS
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
17LOCATION
18--------
19The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
20runtime, cgit will consult the environment variable CGIT_CONFIG and, if
21defined, use its value instead.
22
23
17GLOBAL SETTINGS 24GLOBAL SETTINGS
18--------------- 25---------------
19agefile 26about-filter::
27 Specifies a command which will be invoked to format the content of
28 about pages (both top-level and for each repository). The command will
29 get the content of the about-file on its STDIN, and the STDOUT from the
30 command will be included verbatim on the about page. Default value:
31 none.
32
33agefile::
20 Specifies a path, relative to each repository path, which can be used 34 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. 35 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" 36 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 37 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
24 hh:mm:ss". Default value: "info/web/last-modified". 38 hh:mm:ss". Default value: "info/web/last-modified".
25 39
26cache-root 40cache-root::
27 Path used to store the cgit cache entries. Default value: 41 Path used to store the cgit cache entries. Default value:
28 "/var/cache/cgit". 42 "/var/cache/cgit".
29 43
30cache-dynamic-ttl 44cache-dynamic-ttl::
31 Number which specifies the time-to-live, in minutes, for the cached 45 Number which specifies the time-to-live, in minutes, for the cached
32 version of repository pages accessed without a fixed SHA1. Default 46 version of repository pages accessed without a fixed SHA1. Default
33 value: "5". 47 value: "5".
34 48
35cache-repo-ttl 49cache-repo-ttl::
36 Number which specifies the time-to-live, in minutes, for the cached 50 Number which specifies the time-to-live, in minutes, for the cached
37 version of the repository summary page. Default value: "5". 51 version of the repository summary page. Default value: "5".
38 52
39cache-root-ttl 53cache-root-ttl::
40 Number which specifies the time-to-live, in minutes, for the cached 54 Number which specifies the time-to-live, in minutes, for the cached
41 version of the repository index page. Default value: "5". 55 version of the repository index page. Default value: "5".
42 56
43cache-size 57cache-size::
44 The maximum number of entries in the cgit cache. Default value: "0" 58 The maximum number of entries in the cgit cache. Default value: "0"
45 (i.e. caching is disabled). 59 (i.e. caching is disabled).
46 60
47cache-static-ttl 61cache-static-ttl::
48 Number which specifies the time-to-live, in minutes, for the cached 62 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed with a fixed SHA1. Default value: 63 version of repository pages accessed with a fixed SHA1. Default value:
50 "5". 64 "5".
51 65
52clone-prefix 66clone-prefix::
53 Space-separated list of common prefixes which, when combined with a 67 Space-separated list of common prefixes which, when combined with a
54 repository url, generates valid clone urls for the repository. This 68 repository url, generates valid clone urls for the repository. This
55 setting is only used if `repo.clone-url` is unspecified. Default value: 69 setting is only used if `repo.clone-url` is unspecified. Default value:
56 none. 70 none.
57 71
58css 72commit-filter::
73 Specifies a command which will be invoked to format commit messages.
74 The command will get the message on its STDIN, and the STDOUT from the
75 command will be included verbatim as the commit message, i.e. this can
76 be used to implement bugtracker integration. Default value: none.
77
78css::
59 Url which specifies the css document to include in all cgit pages. 79 Url which specifies the css document to include in all cgit pages.
60 Default value: "/cgit.css". 80 Default value: "/cgit.css".
61 81
62enable-index-links 82embedded::
83 Flag which, when set to "1", will make cgit generate a html fragment
84 suitable for embedding in other html pages. Default value: none. See
85 also: "noheader".
86
87enable-index-links::
63 Flag which, when set to "1", will make cgit generate extra links for 88 Flag which, when set to "1", will make cgit generate extra links for
64 each repo in the repository index (specifically, to the "summary", 89 each repo in the repository index (specifically, to the "summary",
65 "commit" and "tree" pages). Default value: "0". 90 "commit" and "tree" pages). Default value: "0".
66 91
67enable-log-filecount 92enable-log-filecount::
68 Flag which, when set to "1", will make cgit print the number of 93 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 94 modified files for each commit on the repository log page. Default
70 value: "0". 95 value: "0".
71 96
72enable-log-linecount 97enable-log-linecount::
73 Flag which, when set to "1", will make cgit print the number of added 98 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 99 and removed lines for each commit on the repository log page. Default
75 value: "0". 100 value: "0".
76 101
77favicon 102favicon::
78 Url used as link to a shortcut icon for cgit. If specified, it is 103 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 104 suggested to use the value "/favicon.ico" since certain browsers will
80 ignore other values. Default value: none. 105 ignore other values. Default value: none.
81 106
82footer 107footer::
83 The content of the file specified with this option will be included 108 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 109 verbatim at the bottom of all pages (i.e. it replaces the standard
85 "generated by..." message. Default value: none. 110 "generated by..." message. Default value: none.
86 111
87header 112head-include::
113 The content of the file specified with this option will be included
114 verbatim in the html HEAD section on all pages. Default value: none.
115
116header::
88 The content of the file specified with this option will be included 117 The content of the file specified with this option will be included
89 verbatim at the top of all pages. Default value: none. 118 verbatim at the top of all pages. Default value: none.
90 119
91include 120include::
92 Name of a configfile to include before the rest of the current config- 121 Name of a configfile to include before the rest of the current config-
93 file is parsed. Default value: none. 122 file is parsed. Default value: none.
94 123
95index-header 124index-header::
96 The content of the file specified with this option will be included 125 The content of the file specified with this option will be included
97 verbatim above the repository index. This setting is deprecated, and 126 verbatim above the repository index. This setting is deprecated, and
98 will not be supported by cgit-1.0 (use root-readme instead). Default 127 will not be supported by cgit-1.0 (use root-readme instead). Default
99 value: none. 128 value: none.
100 129
101index-info 130index-info::
102 The content of the file specified with this option will be included 131 The content of the file specified with this option will be included
103 verbatim below the heading on the repository index page. This setting 132 verbatim below the heading on the repository index page. This setting
104 is deprecated, and will not be supported by cgit-1.0 (use root-desc 133 is deprecated, and will not be supported by cgit-1.0 (use root-desc
105 instead). Default value: none. 134 instead). Default value: none.
106 135
107local-time 136local-time::
108 Flag which, if set to "1", makes cgit print commit and tag times in the 137 Flag which, if set to "1", makes cgit print commit and tag times in the
109 servers timezone. Default value: "0". 138 servers timezone. Default value: "0".
110 139
111logo 140logo::
112 Url which specifies the source of an image which will be used as a logo 141 Url which specifies the source of an image which will be used as a logo
113 on all cgit pages. 142 on all cgit pages. Default value: "/cgit.png".
114 143
115logo-link 144logo-link::
116 Url loaded when clicking on the cgit logo image. If unspecified the 145 Url loaded when clicking on the cgit logo image. If unspecified the
117 calculated url of the repository index page will be used. Default 146 calculated url of the repository index page will be used. Default
118 value: none. 147 value: none.
119 148
120max-commit-count 149max-commit-count::
121 Specifies the number of entries to list per page in "log" view. Default 150 Specifies the number of entries to list per page in "log" view. Default
122 value: "50". 151 value: "50".
123 152
124max-message-length 153max-message-length::
125 Specifies the maximum number of commit message characters to display in 154 Specifies the maximum number of commit message characters to display in
126 "log" view. Default value: "80". 155 "log" view. Default value: "80".
127 156
128max-repo-count 157max-repo-count::
129 Specifies the number of entries to list per page on the repository 158 Specifies the number of entries to list per page on the repository
130 index page. Default value: "50". 159 index page. Default value: "50".
131 160
132max-repodesc-length 161max-repodesc-length::
133 Specifies the maximum number of repo description characters to display 162 Specifies the maximum number of repo description characters to display
134 on the repository index page. Default value: "80". 163 on the repository index page. Default value: "80".
135 164
136max-stats 165max-stats::
137 Set the default maximum statistics period. Valid values are "week", 166 Set the default maximum statistics period. Valid values are "week",
138 "month", "quarter" and "year". If unspecified, statistics are 167 "month", "quarter" and "year". If unspecified, statistics are
139 disabled. Default value: none. See also: "repo.max-stats". 168 disabled. Default value: none. See also: "repo.max-stats".
140 169
141module-link 170mimetype.<ext>::
171 Set the mimetype for the specified filename extension. This is used
172 by the `plain` command when returning blob content.
173
174module-link::
142 Text which will be used as the formatstring for a hyperlink when a 175 Text which will be used as the formatstring for a hyperlink when a
143 submodule is printed in a directory listing. The arguments for the 176 submodule is printed in a directory listing. The arguments for the
144 formatstring are the path and SHA1 of the submodule commit. Default 177 formatstring are the path and SHA1 of the submodule commit. Default
145 value: "./?repo=%s&page=commit&id=%s" 178 value: "./?repo=%s&page=commit&id=%s"
146 179
147nocache 180nocache::
148 If set to the value "1" caching will be disabled. This settings is 181 If set to the value "1" caching will be disabled. This settings is
149 deprecated, and will not be honored starting with cgit-1.0. Default 182 deprecated, and will not be honored starting with cgit-1.0. Default
150 value: "0". 183 value: "0".
151 184
152renamelimit 185noplainemail::
186 If set to "1" showing full author email adresses will be disabled.
187 Default value: "0".
188
189noheader::
190 Flag which, when set to "1", will make cgit omit the standard header
191 on all pages. Default value: none. See also: "embedded".
192
193renamelimit::
153 Maximum number of files to consider when detecting renames. The value 194 Maximum number of files to consider when detecting renames. The value
154 "-1" uses the compiletime value in git (for further info, look at 195 "-1" uses the compiletime value in git (for further info, look at
155 `man git-diff`). Default value: "-1". 196 `man git-diff`). Default value: "-1".
156 197
157repo.group 198repo.group::
158 A value for the current repository group, which all repositories 199 A value for the current repository group, which all repositories
159 specified after this setting will inherit. Default value: none. 200 specified after this setting will inherit. Default value: none.
160 201
161robots 202robots::
162 Text used as content for the "robots" meta-tag. Default value: 203 Text used as content for the "robots" meta-tag. Default value:
163 "index, nofollow". 204 "index, nofollow".
164 205
165root-desc 206root-desc::
166 Text printed below the heading on the repository index page. Default 207 Text printed below the heading on the repository index page. Default
167 value: "a fast webinterface for the git dscm". 208 value: "a fast webinterface for the git dscm".
168 209
169root-readme: 210root-readme::
170 The content of the file specified with this option will be included 211 The content of the file specified with this option will be included
171 verbatim below the "about" link on the repository index page. Default 212 verbatim below the "about" link on the repository index page. Default
172 value: none. 213 value: none.
173 214
174root-title 215root-title::
175 Text printed as heading on the repository index page. Default value: 216 Text printed as heading on the repository index page. Default value:
176 "Git Repository Browser". 217 "Git Repository Browser".
177 218
178snapshots 219snapshots::
179 Text which specifies the default (and allowed) set of snapshot formats 220 Text which specifies the default set of snapshot formats generated by
180 supported by cgit. The value is a space-separated list of zero or more 221 cgit. The value is a space-separated list of zero or more of the
181 of the following values: 222 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
182 "tar" uncompressed tar-file 223
183 "tar.gz" gzip-compressed tar-file 224source-filter::
184 "tar.bz2" bzip-compressed tar-file 225 Specifies a command which will be invoked to format plaintext blobs
185 "zip" zip-file 226 in the tree view. The command will get the blob content on its STDIN
186 Default value: none. 227 and the name of the blob as its only command line argument. The STDOUT
228 from the command will be included verbatim as the blob contents, i.e.
229 this can be used to implement e.g. syntax highlighting. Default value:
230 none.
187 231
188summary-branches 232summary-branches::
189 Specifies the number of branches to display in the repository "summary" 233 Specifies the number of branches to display in the repository "summary"
190 view. Default value: "10". 234 view. Default value: "10".
191 235
192summary-log 236summary-log::
193 Specifies the number of log entries to display in the repository 237 Specifies the number of log entries to display in the repository
194 "summary" view. Default value: "10". 238 "summary" view. Default value: "10".
195 239
196summary-tags 240summary-tags::
197 Specifies the number of tags to display in the repository "summary" 241 Specifies the number of tags to display in the repository "summary"
198 view. Default value: "10". 242 view. Default value: "10".
199 243
200virtual-root 244virtual-root::
201 Url which, if specified, will be used as root for all cgit links. It 245 Url which, if specified, will be used as root for all cgit links. It
202 will also cause cgit to generate 'virtual urls', i.e. urls like 246 will also cause cgit to generate 'virtual urls', i.e. urls like
203 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 247 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
@@ -207,51 +251,60 @@ virtual-root
207 251
208REPOSITORY SETTINGS 252REPOSITORY SETTINGS
209------------------- 253-------------------
210repo.clone-url 254repo.about-filter::
255 Override the default about-filter. Default value: <about-filter>.
256
257repo.clone-url::
211 A list of space-separated urls which can be used to clone this repo. 258 A list of space-separated urls which can be used to clone this repo.
212 Default value: none. 259 Default value: none.
213 260
214repo.defbranch 261repo.commit-filter::
262 Override the default commit-filter. Default value: <commit-filter>.
263
264repo.defbranch::
215 The name of the default branch for this repository. If no such branch 265 The name of the default branch for this repository. If no such branch
216 exists in the repository, the first branch name (when sorted) is used 266 exists in the repository, the first branch name (when sorted) is used
217 as default instead. Default value: "master". 267 as default instead. Default value: "master".
218 268
219repo.desc 269repo.desc::
220 The value to show as repository description. Default value: none. 270 The value to show as repository description. Default value: none.
221 271
222repo.enable-log-filecount 272repo.enable-log-filecount::
223 A flag which can be used to disable the global setting 273 A flag which can be used to disable the global setting
224 `enable-log-filecount'. Default value: none. 274 `enable-log-filecount'. Default value: none.
225 275
226repo.enable-log-linecount 276repo.enable-log-linecount::
227 A flag which can be used to disable the global setting 277 A flag which can be used to disable the global setting
228 `enable-log-linecount'. Default value: none. 278 `enable-log-linecount'. Default value: none.
229 279
230repo.max-stats 280repo.max-stats::
231 Override the default maximum statistics period. Valid values are equal 281 Override the default maximum statistics period. Valid values are equal
232 to the values specified for the global "max-stats" setting. Default 282 to the values specified for the global "max-stats" setting. Default
233 value: none. 283 value: none.
234 284
235repo.name 285repo.name::
236 The value to show as repository name. Default value: <repo.url>. 286 The value to show as repository name. Default value: <repo.url>.
237 287
238repo.owner 288repo.owner::
239 A value used to identify the owner of the repository. Default value: 289 A value used to identify the owner of the repository. Default value:
240 none. 290 none.
241 291
242repo.path 292repo.path::
243 An absolute path to the repository directory. For non-bare repositories 293 An absolute path to the repository directory. For non-bare repositories
244 this is the .git-directory. Default value: none. 294 this is the .git-directory. Default value: none.
245 295
246repo.readme 296repo.readme::
247 A path (relative to <repo.path>) which specifies a file to include 297 A path (relative to <repo.path>) which specifies a file to include
248 verbatim as the "About" page for this repo. Default value: none. 298 verbatim as the "About" page for this repo. Default value: none.
249 299
250repo.snapshots 300repo.snapshots::
251 A mask of allowed snapshot-formats for this repo, restricted by the 301 A mask of allowed snapshot-formats for this repo, restricted by the
252 "snapshots" global setting. Default value: <snapshots>. 302 "snapshots" global setting. Default value: <snapshots>.
253 303
254repo.url 304repo.source-filter::
305 Override the default source-filter. Default value: <source-filter>.
306
307repo.url::
255 The relative url used to access the repository. This must be the first 308 The relative url used to access the repository. This must be the first
256 setting specified for each repo. Default value: none. 309 setting specified for each repo. Default value: none.
257 310
@@ -259,6 +312,7 @@ repo.url
259EXAMPLE CGITRC FILE 312EXAMPLE CGITRC FILE
260------------------- 313-------------------
261 314
315....
262# Enable caching of up to 1000 output entriess 316# Enable caching of up to 1000 output entriess
263cache-size=1000 317cache-size=1000
264 318
@@ -311,6 +365,19 @@ snapshots=tar.gz tar.bz2 zip
311 365
312 366
313## 367##
368## List of common mimetypes
369##
370
371mimetype.git=image/git
372mimetype.html=text/html
373mimetype.jpg=image/jpeg
374mimetype.jpeg=image/jpeg
375mimetype.pdf=application/pdf
376mimetype.png=image/png
377mimetype.svg=image/svg+xml
378
379
380##
314## List of repositories. 381## List of repositories.
315## PS: Any repositories listed when repo.group is unset will not be 382## PS: Any repositories listed when repo.group is unset will not be
316## displayed under a group heading 383## displayed under a group heading
@@ -368,6 +435,7 @@ repo.enable-log-linecount=0
368 435
369# Restrict the max statistics period for this repo 436# Restrict the max statistics period for this repo
370repo.max-stats=month 437repo.max-stats=month
438....
371 439
372 440
373BUGS 441BUGS