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