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