-rw-r--r-- | cgitrc.5.txt | 244 |
1 files changed, 177 insertions, 67 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index fd299ae..4dc383d 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -1,277 +1,373 @@ | |||
1 | CGITRC | 1 | CGITRC(5) |
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 | SYNOPSIS |
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 | LOCATION | ||
18 | -------- | ||
19 | The default location of cgitrc, defined at compile time, is /etc/cgitrc. At | ||
20 | runtime, cgit will consult the environment variable CGIT_CONFIG and, if | ||
21 | defined, use its value instead. | ||
22 | |||
23 | |||
17 | GLOBAL SETTINGS | 24 | GLOBAL SETTINGS |
18 | --------------- | 25 | --------------- |
19 | agefile | 26 | about-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 | |||
33 | agefile:: | ||
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 | ||
26 | cache-root | 40 | cache-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 | ||
30 | cache-dynamic-ttl | 44 | cache-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 | ||
35 | cache-repo-ttl | 49 | cache-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 | ||
39 | cache-root-ttl | 53 | cache-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 | ||
43 | cache-size | 57 | cache-scanrc-ttl:: |
58 | Number which specifies the time-to-live, in minutes, for the result | ||
59 | of scanning a path for git repositories. Default value: "15". | ||
60 | |||
61 | cache-size:: | ||
44 | The maximum number of entries in the cgit cache. Default value: "0" | 62 | The maximum number of entries in the cgit cache. Default value: "0" |
45 | (i.e. caching is disabled). | 63 | (i.e. caching is disabled). |
46 | 64 | ||
47 | cache-static-ttl | 65 | cache-static-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 66 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed with a fixed SHA1. Default value: | 67 | version of repository pages accessed with a fixed SHA1. Default value: |
50 | "5". | 68 | "5". |
51 | 69 | ||
52 | clone-prefix | 70 | clone-prefix:: |
53 | Space-separated list of common prefixes which, when combined with a | 71 | Space-separated list of common prefixes which, when combined with a |
54 | repository url, generates valid clone urls for the repository. This | 72 | repository url, generates valid clone urls for the repository. This |
55 | setting is only used if `repo.clone-url` is unspecified. Default value: | 73 | setting is only used if `repo.clone-url` is unspecified. Default value: |
56 | none. | 74 | none. |
57 | 75 | ||
58 | css | 76 | commit-filter:: |
77 | Specifies a command which will be invoked to format commit messages. | ||
78 | The command will get the message on its STDIN, and the STDOUT from the | ||
79 | command will be included verbatim as the commit message, i.e. this can | ||
80 | be used to implement bugtracker integration. Default value: none. | ||
81 | |||
82 | css:: | ||
59 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
60 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
61 | 85 | ||
62 | enable-index-links | 86 | embedded:: |
87 | Flag which, when set to "1", will make cgit generate a html fragment | ||
88 | suitable for embedding in other html pages. Default value: none. See | ||
89 | also: "noheader". | ||
90 | |||
91 | enable-filter-overrides:: | ||
92 | Flag which, when set to "1", allows all filter settings to be | ||
93 | overridden in repository-specific cgitrc files. Default value: none. | ||
94 | |||
95 | enable-index-links:: | ||
63 | Flag which, when set to "1", will make cgit generate extra links for | 96 | Flag which, when set to "1", will make cgit generate extra links for |
64 | each repo in the repository index (specifically, to the "summary", | 97 | each repo in the repository index (specifically, to the "summary", |
65 | "commit" and "tree" pages). Default value: "0". | 98 | "commit" and "tree" pages). Default value: "0". |
66 | 99 | ||
67 | enable-log-filecount | 100 | enable-log-filecount:: |
68 | Flag which, when set to "1", will make cgit print the number of | 101 | 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 | 102 | modified files for each commit on the repository log page. Default |
70 | value: "0". | 103 | value: "0". |
71 | 104 | ||
72 | enable-log-linecount | 105 | enable-log-linecount:: |
73 | Flag which, when set to "1", will make cgit print the number of added | 106 | 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 | 107 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 108 | value: "0". |
76 | 109 | ||
77 | favicon | 110 | enable-tree-linenumbers:: |
111 | Flag which, when set to "1", will make cgit generate linenumber links | ||
112 | for plaintext blobs printed in the tree view. Default value: "1". | ||
113 | |||
114 | favicon:: | ||
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 115 | 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 | 116 | suggested to use the value "/favicon.ico" since certain browsers will |
80 | ignore other values. Default value: none. | 117 | ignore other values. Default value: none. |
81 | 118 | ||
82 | footer | 119 | footer:: |
83 | The content of the file specified with this option will be included | 120 | 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 | 121 | verbatim at the bottom of all pages (i.e. it replaces the standard |
85 | "generated by..." message. Default value: none. | 122 | "generated by..." message. Default value: none. |
86 | 123 | ||
87 | header | 124 | head-include:: |
125 | The content of the file specified with this option will be included | ||
126 | verbatim in the html HEAD section on all pages. Default value: none. | ||
127 | |||
128 | header:: | ||
88 | The content of the file specified with this option will be included | 129 | The content of the file specified with this option will be included |
89 | verbatim at the top of all pages. Default value: none. | 130 | verbatim at the top of all pages. Default value: none. |
90 | 131 | ||
91 | include | 132 | include:: |
92 | Name of a configfile to include before the rest of the current config- | 133 | Name of a configfile to include before the rest of the current config- |
93 | file is parsed. Default value: none. | 134 | file is parsed. Default value: none. |
94 | 135 | ||
95 | index-header | 136 | index-header:: |
96 | The content of the file specified with this option will be included | 137 | The content of the file specified with this option will be included |
97 | verbatim above the repository index. This setting is deprecated, and | 138 | verbatim above the repository index. This setting is deprecated, and |
98 | will not be supported by cgit-1.0 (use root-readme instead). Default | 139 | will not be supported by cgit-1.0 (use root-readme instead). Default |
99 | value: none. | 140 | value: none. |
100 | 141 | ||
101 | index-info | 142 | index-info:: |
102 | The content of the file specified with this option will be included | 143 | The content of the file specified with this option will be included |
103 | verbatim below the heading on the repository index page. This setting | 144 | 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 | 145 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
105 | instead). Default value: none. | 146 | instead). Default value: none. |
106 | 147 | ||
107 | local-time | 148 | local-time:: |
108 | Flag which, if set to "1", makes cgit print commit and tag times in the | 149 | Flag which, if set to "1", makes cgit print commit and tag times in the |
109 | servers timezone. Default value: "0". | 150 | servers timezone. Default value: "0". |
110 | 151 | ||
111 | logo | 152 | logo:: |
112 | Url which specifies the source of an image which will be used as a logo | 153 | Url which specifies the source of an image which will be used as a logo |
113 | on all cgit pages. | 154 | on all cgit pages. Default value: "/cgit.png". |
114 | 155 | ||
115 | logo-link | 156 | logo-link:: |
116 | Url loaded when clicking on the cgit logo image. If unspecified the | 157 | Url loaded when clicking on the cgit logo image. If unspecified the |
117 | calculated url of the repository index page will be used. Default | 158 | calculated url of the repository index page will be used. Default |
118 | value: none. | 159 | value: none. |
119 | 160 | ||
120 | max-commit-count | 161 | max-commit-count:: |
121 | Specifies the number of entries to list per page in "log" view. Default | 162 | Specifies the number of entries to list per page in "log" view. Default |
122 | value: "50". | 163 | value: "50". |
123 | 164 | ||
124 | max-message-length | 165 | max-message-length:: |
125 | Specifies the maximum number of commit message characters to display in | 166 | Specifies the maximum number of commit message characters to display in |
126 | "log" view. Default value: "80". | 167 | "log" view. Default value: "80". |
127 | 168 | ||
128 | max-repo-count | 169 | max-repo-count:: |
129 | Specifies the number of entries to list per page on therepository | 170 | Specifies the number of entries to list per page on therepository |
130 | index page. Default value: "50". | 171 | index page. Default value: "50". |
131 | 172 | ||
132 | max-repodesc-length | 173 | max-repodesc-length:: |
133 | Specifies the maximum number of repo description characters to display | 174 | Specifies the maximum number of repo description characters to display |
134 | on the repository index page. Default value: "80". | 175 | on the repository index page. Default value: "80". |
135 | 176 | ||
136 | max-stats | 177 | max-stats:: |
137 | Set the default maximum statistics period. Valid values are "week", | 178 | Set the default maximum statistics period. Valid values are "week", |
138 | "month", "quarter" and "year". If unspecified, statistics are | 179 | "month", "quarter" and "year". If unspecified, statistics are |
139 | disabled. Default value: none. See also: "repo.max-stats". | 180 | disabled. Default value: none. See also: "repo.max-stats". |
140 | 181 | ||
141 | module-link | 182 | mimetype.<ext>:: |
183 | Set the mimetype for the specified filename extension. This is used | ||
184 | by the `plain` command when returning blob content. | ||
185 | |||
186 | module-link:: | ||
142 | Text which will be used as the formatstring for a hyperlink when a | 187 | 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 | 188 | submodule is printed in a directory listing. The arguments for the |
144 | formatstring are the path and SHA1 of the submodule commit. Default | 189 | formatstring are the path and SHA1 of the submodule commit. Default |
145 | value: "./?repo=%s&page=commit&id=%s" | 190 | value: "./?repo=%s&page=commit&id=%s" |
146 | 191 | ||
147 | nocache | 192 | nocache:: |
148 | If set to the value "1" caching will be disabled. This settings is | 193 | 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 | 194 | deprecated, and will not be honored starting with cgit-1.0. Default |
150 | value: "0". | 195 | value: "0". |
151 | 196 | ||
152 | renamelimit | 197 | noplainemail:: |
198 | If set to "1" showing full author email adresses will be disabled. | ||
199 | Default value: "0". | ||
200 | |||
201 | noheader:: | ||
202 | Flag which, when set to "1", will make cgit omit the standard header | ||
203 | on all pages. Default value: none. See also: "embedded". | ||
204 | |||
205 | renamelimit:: | ||
153 | Maximum number of files to consider when detecting renames. The value | 206 | Maximum number of files to consider when detecting renames. The value |
154 | "-1" uses the compiletime value in git (for further info, look at | 207 | "-1" uses the compiletime value in git (for further info, look at |
155 | `man git-diff`). Default value: "-1". | 208 | `man git-diff`). Default value: "-1". |
156 | 209 | ||
157 | repo.group | 210 | repo.group:: |
158 | A value for the current repository group, which all repositories | 211 | Legacy alias for "section". This option is deprecated and will not be |
159 | specified after this setting will inherit. Default value: none. | 212 | supported in cgit-1.0. |
160 | 213 | ||
161 | robots | 214 | robots:: |
162 | Text used as content for the "robots" meta-tag. Default value: | 215 | Text used as content for the "robots" meta-tag. Default value: |
163 | "index, nofollow". | 216 | "index, nofollow". |
164 | 217 | ||
165 | root-desc | 218 | root-desc:: |
166 | Text printed below the heading on the repository index page. Default | 219 | Text printed below the heading on the repository index page. Default |
167 | value: "a fast webinterface for the git dscm". | 220 | value: "a fast webinterface for the git dscm". |
168 | 221 | ||
169 | root-readme: | 222 | root-readme:: |
170 | The content of the file specified with this option will be included | 223 | The content of the file specified with this option will be included |
171 | verbatim below the "about" link on the repository index page. Default | 224 | verbatim below the "about" link on the repository index page. Default |
172 | value: none. | 225 | value: none. |
173 | 226 | ||
174 | root-title | 227 | root-title:: |
175 | Text printed as heading on the repository index page. Default value: | 228 | Text printed as heading on the repository index page. Default value: |
176 | "Git Repository Browser". | 229 | "Git Repository Browser". |
177 | 230 | ||
178 | snapshots | 231 | scan-path:: |
179 | Text which specifies the default (and allowed) set of snapshot formats | 232 | A path which will be scanned for repositories. If caching is enabled, |
180 | supported by cgit. The value is a space-separated list of zero or more | 233 | the result will be cached as a cgitrc include-file in the cache |
181 | of the following values: | 234 | directory. Default value: none. See also: cache-scanrc-ttl. |
182 | "tar" uncompressed tar-file | 235 | |
183 | "tar.gz"gzip-compressed tar-file | 236 | section:: |
184 | "tar.bz2"bzip-compressed tar-file | 237 | The name of the current repository section - all repositories defined |
185 | "zip" zip-file | 238 | after this option will inherit the current section name. Default value: |
186 | Default value: none. | 239 | none. |
187 | 240 | ||
188 | summary-branches | 241 | snapshots:: |
242 | Text which specifies the default set of snapshot formats generated by | ||
243 | cgit. The value is a space-separated list of zero or more of the | ||
244 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | ||
245 | |||
246 | source-filter:: | ||
247 | Specifies a command which will be invoked to format plaintext blobs | ||
248 | in the tree view. The command will get the blob content on its STDIN | ||
249 | and the name of the blob as its only command line argument. The STDOUT | ||
250 | from the command will be included verbatim as the blob contents, i.e. | ||
251 | this can be used to implement e.g. syntax highlighting. Default value: | ||
252 | none. | ||
253 | |||
254 | summary-branches:: | ||
189 | Specifies the number of branches to display in the repository "summary" | 255 | Specifies the number of branches to display in the repository "summary" |
190 | view. Default value: "10". | 256 | view. Default value: "10". |
191 | 257 | ||
192 | summary-log | 258 | summary-log:: |
193 | Specifies the number of log entries to display in the repository | 259 | Specifies the number of log entries to display in the repository |
194 | "summary" view. Default value: "10". | 260 | "summary" view. Default value: "10". |
195 | 261 | ||
196 | summary-tags | 262 | summary-tags:: |
197 | Specifies the number of tags to display in the repository "summary" | 263 | Specifies the number of tags to display in the repository "summary" |
198 | view. Default value: "10". | 264 | view. Default value: "10". |
199 | 265 | ||
200 | virtual-root | 266 | virtual-root:: |
201 | Url which, if specified, will be used as root for all cgit links. It | 267 | 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 | 268 | 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 | 269 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
204 | value: none. | 270 | value: none. |
205 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 271 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
206 | same kind of virtual urls, so this option will probably be deprecated. | 272 | same kind of virtual urls, so this option will probably be deprecated. |
207 | 273 | ||
208 | REPOSITORY SETTINGS | 274 | REPOSITORY SETTINGS |
209 | ------------------- | 275 | ------------------- |
210 | repo.clone-url | 276 | repo.about-filter:: |
277 | Override the default about-filter. Default value: none. See also: | ||
278 | "enable-filter-overrides". | ||
279 | |||
280 | repo.clone-url:: | ||
211 | A list of space-separated urls which can be used to clone this repo. | 281 | A list of space-separated urls which can be used to clone this repo. |
212 | Default value: none. | 282 | Default value: none. |
213 | 283 | ||
214 | repo.defbranch | 284 | repo.commit-filter:: |
285 | Override the default commit-filter. Default value: none. See also: | ||
286 | "enable-filter-overrides". | ||
287 | |||
288 | repo.defbranch:: | ||
215 | The name of the default branch for this repository. If no such branch | 289 | 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 | 290 | exists in the repository, the first branch name (when sorted) is used |
217 | as default instead. Default value: "master". | 291 | as default instead. Default value: "master". |
218 | 292 | ||
219 | repo.desc | 293 | repo.desc:: |
220 | The value to show as repository description. Default value: none. | 294 | The value to show as repository description. Default value: none. |
221 | 295 | ||
222 | repo.enable-log-filecount | 296 | repo.enable-log-filecount:: |
223 | A flag which can be used to disable the global setting | 297 | A flag which can be used to disable the global setting |
224 | `enable-log-filecount'. Default value: none. | 298 | `enable-log-filecount'. Default value: none. |
225 | 299 | ||
226 | repo.enable-log-linecount | 300 | repo.enable-log-linecount:: |
227 | A flag which can be used to disable the global setting | 301 | A flag which can be used to disable the global setting |
228 | `enable-log-linecount'. Default value: none. | 302 | `enable-log-linecount'. Default value: none. |
229 | 303 | ||
230 | repo.max-stats | 304 | repo.max-stats:: |
231 | Override the default maximum statistics period. Valid values are equal | 305 | Override the default maximum statistics period. Valid values are equal |
232 | to the values specified for the global "max-stats" setting. Default | 306 | to the values specified for the global "max-stats" setting. Default |
233 | value: none. | 307 | value: none. |
234 | 308 | ||
235 | repo.name | 309 | repo.name:: |
236 | The value to show as repository name. Default value: <repo.url>. | 310 | The value to show as repository name. Default value: <repo.url>. |
237 | 311 | ||
238 | repo.owner | 312 | repo.owner:: |
239 | A value used to identify the owner of the repository. Default value: | 313 | A value used to identify the owner of the repository. Default value: |
240 | none. | 314 | none. |
241 | 315 | ||
242 | repo.path | 316 | repo.path:: |
243 | An absolute path to the repository directory. For non-bare repositories | 317 | An absolute path to the repository directory. For non-bare repositories |
244 | this is the .git-directory. Default value: none. | 318 | this is the .git-directory. Default value: none. |
245 | 319 | ||
246 | repo.readme | 320 | repo.readme:: |
247 | A path (relative to <repo.path>) which specifies a file to include | 321 | A path (relative to <repo.path>) which specifies a file to include |
248 | verbatim as the "About" page for this repo. Default value: none. | 322 | verbatim as the "About" page for this repo. Default value: none. |
249 | 323 | ||
250 | repo.snapshots | 324 | repo.snapshots:: |
251 | A mask of allowed snapshot-formats for this repo, restricted by the | 325 | A mask of allowed snapshot-formats for this repo, restricted by the |
252 | "snapshots" global setting. Default value: <snapshots>. | 326 | "snapshots" global setting. Default value: <snapshots>. |
253 | 327 | ||
254 | repo.url | 328 | repo.section:: |
329 | Override the current section name for this repository. Default value: | ||
330 | none. | ||
331 | |||
332 | repo.source-filter:: | ||
333 | Override the default source-filter. Default value: none. See also: | ||
334 | "enable-filter-overrides". | ||
335 | |||
336 | repo.url:: | ||
255 | The relative url used to access the repository. This must be the first | 337 | The relative url used to access the repository. This must be the first |
256 | setting specified for each repo. Default value: none. | 338 | setting specified for each repo. Default value: none. |
257 | 339 | ||
258 | 340 | ||
341 | REPOSITORY-SPECIFIC CGITRC FILE | ||
342 | ------------------------------- | ||
343 | When the option "scan-path" is used to auto-discover git repositories, cgit | ||
344 | will try to parse the file "cgitrc" within any found repository. Such a | ||
345 | repo-specific config file may contain any of the repo-specific options | ||
346 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | ||
347 | options are only acknowledged in repo-specific config files when | ||
348 | "enable-filter-overrides" is set to "1". | ||
349 | |||
350 | Note: the "repo." prefix is dropped from the option names in repo-specific | ||
351 | config files, e.g. "repo.desc" becomes "desc". | ||
352 | |||
353 | |||
259 | EXAMPLE CGITRC FILE | 354 | EXAMPLE CGITRC FILE |
260 | ------------------- | 355 | ------------------- |
261 | 356 | ||
357 | .... | ||
262 | # Enable caching of up to 1000 output entriess | 358 | # Enable caching of up to 1000 output entriess |
263 | cache-size=1000 | 359 | cache-size=1000 |
264 | 360 | ||
265 | 361 | ||
266 | # Specify some default clone prefixes | 362 | # Specify some default clone prefixes |
267 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 363 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
268 | 364 | ||
269 | # Specify the css url | 365 | # Specify the css url |
270 | css=/css/cgit.css | 366 | css=/css/cgit.css |
271 | 367 | ||
272 | 368 | ||
273 | # Show extra links for each repository on the index page | 369 | # Show extra links for each repository on the index page |
274 | enable-index-links=1 | 370 | enable-index-links=1 |
275 | 371 | ||
276 | 372 | ||
277 | # Show number of affected files per commit on the log pages | 373 | # Show number of affected files per commit on the log pages |
@@ -298,32 +394,45 @@ max-stats=quarter | |||
298 | root-title=foobar.com git repositories | 394 | root-title=foobar.com git repositories |
299 | 395 | ||
300 | 396 | ||
301 | # Set a subheading for the repository index page | 397 | # Set a subheading for the repository index page |
302 | root-desc=tracking the foobar development | 398 | root-desc=tracking the foobar development |
303 | 399 | ||
304 | 400 | ||
305 | # Include some more info about foobar.com on the index page | 401 | # Include some more info about foobar.com on the index page |
306 | root-readme=/var/www/htdocs/about.html | 402 | root-readme=/var/www/htdocs/about.html |
307 | 403 | ||
308 | 404 | ||
309 | # Allow download of tar.gz, tar.bz2 and zip-files | 405 | # Allow download of tar.gz, tar.bz2 and zip-files |
310 | snapshots=tar.gz tar.bz2 zip | 406 | snapshots=tar.gz tar.bz2 zip |
311 | 407 | ||
312 | 408 | ||
313 | ## | 409 | ## |
410 | ## List of common mimetypes | ||
411 | ## | ||
412 | |||
413 | mimetype.git=image/git | ||
414 | mimetype.html=text/html | ||
415 | mimetype.jpg=image/jpeg | ||
416 | mimetype.jpeg=image/jpeg | ||
417 | mimetype.pdf=application/pdf | ||
418 | mimetype.png=image/png | ||
419 | mimetype.svg=image/svg+xml | ||
420 | |||
421 | |||
422 | ## | ||
314 | ## List of repositories. | 423 | ## List of repositories. |
315 | ## PS: Any repositories listed when repo.group is unset will not be | 424 | ## PS: Any repositories listed when repo.group is unset will not be |
316 | ## displayed under a group heading | 425 | ## displayed under a group heading |
317 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 426 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
318 | ## and included like this: | 427 | ## and included like this: |
319 | ## include=/etc/cgitrepos | 428 | ## include=/etc/cgitrepos |
320 | ## | 429 | ## |
321 | 430 | ||
322 | 431 | ||
323 | repo.url=foo | 432 | repo.url=foo |
324 | repo.path=/pub/git/foo.git | 433 | repo.path=/pub/git/foo.git |
325 | repo.desc=the master foo repository | 434 | repo.desc=the master foo repository |
326 | repo.owner=fooman@foobar.com | 435 | repo.owner=fooman@foobar.com |
327 | repo.readme=info/web/about.html | 436 | repo.readme=info/web/about.html |
328 | 437 | ||
329 | 438 | ||
@@ -355,32 +464,33 @@ repo.url=git | |||
355 | repo.path=/pub/git/git.git | 464 | repo.path=/pub/git/git.git |
356 | repo.desc=the dscm | 465 | repo.desc=the dscm |
357 | 466 | ||
358 | 467 | ||
359 | repo.url=linux | 468 | repo.url=linux |
360 | repo.path=/pub/git/linux.git | 469 | repo.path=/pub/git/linux.git |
361 | repo.desc=the kernel | 470 | repo.desc=the kernel |
362 | 471 | ||
363 | # Disable adhoc downloads of this repo | 472 | # Disable adhoc downloads of this repo |
364 | repo.snapshots=0 | 473 | repo.snapshots=0 |
365 | 474 | ||
366 | # Disable line-counts for this repo | 475 | # Disable line-counts for this repo |
367 | repo.enable-log-linecount=0 | 476 | repo.enable-log-linecount=0 |
368 | 477 | ||
369 | # Restrict the max statistics period for this repo | 478 | # Restrict the max statistics period for this repo |
370 | repo.max-stats=month | 479 | repo.max-stats=month |
480 | .... | ||
371 | 481 | ||
372 | 482 | ||
373 | BUGS | 483 | BUGS |
374 | ---- | 484 | ---- |
375 | Comments currently cannot appear on the same line as a setting; the comment | 485 | Comments currently cannot appear on the same line as a setting; the comment |
376 | will be included as part of the value. E.g. this line: | 486 | will be included as part of the value. E.g. this line: |
377 | 487 | ||
378 | robots=index # allow indexing | 488 | robots=index # allow indexing |
379 | 489 | ||
380 | will generate the following html element: | 490 | will generate the following html element: |
381 | 491 | ||
382 | <meta name='robots' content='index # allow indexing'/> | 492 | <meta name='robots' content='index # allow indexing'/> |
383 | 493 | ||
384 | 494 | ||
385 | 495 | ||
386 | AUTHOR | 496 | AUTHOR |