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