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