1 |
##--------------------------------------------------------------------------- |
2 |
## |
3 |
## Configuration file for ViewVC |
4 |
## |
5 |
## Information on ViewVC is located at the following web site: |
6 |
## http://viewvc.org/ |
7 |
## |
8 |
##--------------------------------------------------------------------------- |
9 |
|
10 |
## THE FORMAT OF THIS CONFIGURATION FILE |
11 |
## |
12 |
## This file is delineated by sections, specified in [brackets]. Within |
13 |
## each section, are a number of configuration settings. These settings |
14 |
## take the form of: name = value. Values may be continued on the |
15 |
## following line by indenting the continued line. |
16 |
## |
17 |
## WARNING: Indentation *always* means continuation. Name=value lines |
18 |
## should always start in column zero. |
19 |
## |
20 |
## Comments should always start in column zero, and are identified |
21 |
## with "#". By default each of the configuration items is |
22 |
## commented out, with the default value of the option shown. |
23 |
## You'll need to remove the '#' that precedes configuration |
24 |
## options whose values you wish to modify. |
25 |
## |
26 |
## Certain configuration settings may have multiple values. These should |
27 |
## be separated by a comma. The settings where this is allowed are noted |
28 |
## below. Any other setting that requires special syntax is noted at that |
29 |
## setting. |
30 |
## |
31 |
## |
32 |
## SOME TERMINOLOGY USED HEREIN |
33 |
## |
34 |
## "root" - This is a CVS or Subversion repository. For Subversion, the |
35 |
## meaning is pretty clear, as the virtual, versioned directory tree |
36 |
## stored inside a Subversion repository looks nothing like the actual |
37 |
## tree visible with shell utilities that holds the repository. For |
38 |
## CVS, this is more confusing, because CVS's repository layout mimics |
39 |
## (actually, defines) the layout of the stuff housed in the repository. |
40 |
## But a CVS repository can be identified by the presence of a CVSROOT |
41 |
## subdirectory in its root directory. |
42 |
## |
43 |
## "module" - A module is a top-level subdirectory of a root, usually |
44 |
## associated with the concept of a single "project" among many housed |
45 |
## within a single repository. |
46 |
## |
47 |
## |
48 |
## BASIC VIEWVC CONFIGURATION HINTS |
49 |
## |
50 |
## While ViewVC has quite a few configuration options, you generally |
51 |
## only need to change a small subset of them to get your ViewVC |
52 |
## installation working properly. Here are some options that we |
53 |
## recommend you pay attention to. Of course, don't try to change the |
54 |
## options here -- do so in the relevant section of the configuration |
55 |
## file below. |
56 |
## |
57 |
## For correct operation, you will probably need to change the following |
58 |
## configuration variables: |
59 |
## |
60 |
## cvs_roots (for CVS) |
61 |
## svn_roots (for Subversion) |
62 |
## root_parents (for CVS or Subversion) |
63 |
## default_root |
64 |
## root_as_url_component |
65 |
## rcs_dir |
66 |
## mime_types_files |
67 |
## the many options in the [utilities] section |
68 |
## |
69 |
## It is usually desirable to change the following variables: |
70 |
## |
71 |
## address |
72 |
## forbidden |
73 |
## |
74 |
## To optimize delivery of ViewVC static files: |
75 |
## |
76 |
## docroot |
77 |
## |
78 |
## To customize the display of ViewVC for your site: |
79 |
## |
80 |
## template_dir |
81 |
## the [templates] override section |
82 |
## |
83 |
|
84 |
##--------------------------------------------------------------------------- |
85 |
[general] |
86 |
|
87 |
## cvs_roots: Specifies each of the CVS roots on your system and |
88 |
## assigns names to them. Each root should be given by a "name: path" |
89 |
## value. Multiple roots should be separated by commas and can be |
90 |
## placed on separate lines. |
91 |
## |
92 |
## Example: |
93 |
## cvs_roots = cvsroot: /opt/cvs/repos1, |
94 |
## anotherroot: /usr/local/cvs/repos2 |
95 |
## |
96 |
#cvs_roots = |
97 |
|
98 |
## svn_roots: Specifies each of the Subversion roots (repositories) on |
99 |
## your system and assigns names to them. Each root should be given by |
100 |
## a "name: path" value. Multiple roots should be separated by commas |
101 |
## and can be placed on separate lines. |
102 |
## |
103 |
## Example: |
104 |
## svn_roots = svnrepos: /opt/svn/, |
105 |
## anotherrepos: /usr/local/svn/repos2 |
106 |
## |
107 |
#svn_roots = adm: /svn/adm/ |
108 |
# web: /svn/web/ |
109 |
# packages: /svn/packages/ |
110 |
# soft: /svn/soft/ |
111 |
|
112 |
## root_parents: Specifies a list of directories in which any number of |
113 |
## repositories may reside. Rather than force you to add a new entry |
114 |
## to 'cvs_roots' or 'svn_roots' each time you create a new repository, |
115 |
## ViewVC rewards you for organising all your repositories under a few |
116 |
## parent directories by allowing you to simply specifiy just those |
117 |
## parent directories. ViewVC will then notice each repository in that |
118 |
## directory as a new root whose name is the subdirectory of the parent |
119 |
## path in which that repository lives. |
120 |
## |
121 |
## You can specify multiple parent paths separated by commas or new lines. |
122 |
## |
123 |
## WARNING: these names can, of course, clash with names you have |
124 |
## defined in your cvs_roots or svn_roots configuration items. If this |
125 |
## occurs, you can either rename the offending repository on disk, or |
126 |
## grant new names to the clashing item in cvs_roots or svn_roots. |
127 |
## Each parent path is processed sequentially, so repositories under |
128 |
## later parent paths may override earlier ones. |
129 |
## |
130 |
## Example: |
131 |
## root_parents = /opt/svn : svn, |
132 |
## /opt/cvs : cvs |
133 |
## |
134 |
root_parents = /svn : svn |
135 |
|
136 |
## default_root: This is the name of the default root. Valid names |
137 |
## include those explicitly listed in the cvs_roots and svn_roots |
138 |
## configuration options, as well as those implicitly indicated by |
139 |
## virtue of being the basenames of repositories found in the |
140 |
## root_parents option locations. |
141 |
## |
142 |
## NOTE: This setting is ignored when root_as_url_component is enabled. |
143 |
## |
144 |
## Example: |
145 |
## default_root = cvsroot |
146 |
## |
147 |
#default_root = |
148 |
|
149 |
## mime_types_files: This is a list of pathnames to a set of MIME type |
150 |
## mapping files to help ViewVC guess the correct MIME type of a |
151 |
## versioned file. The pathnames listed here are specified in order of |
152 |
## authoritativeness either as absolute paths or relative to this |
153 |
## configuration file. |
154 |
## |
155 |
## As a convenience, ViewVC provides a MIME type mapping file |
156 |
## (mimetypes.conf) which is, by default, the preferred provider of |
157 |
## MIME type mapping answers, but which is also empty. If you find |
158 |
## that ViewVC is unable to accurately guess MIME types based on the |
159 |
## extensions of some of your versioned files, you can add records of |
160 |
## your preferred mappings to the provided mimetypes.conf file (or to |
161 |
## your system's mapping files, if you wish). |
162 |
## |
163 |
## You might, for example, wish to have ViewVC also consult the mapping |
164 |
## files provided by your operating system and Apache. |
165 |
## |
166 |
## Example: |
167 |
## mime_types_files = mimetypes.conf, |
168 |
## /etc/mime.types, |
169 |
## /usr/local/apache2/conf/mime.types |
170 |
## |
171 |
mime_types_files = /etc/viewvc/mimetypes.conf, /etc/httpd/conf/mime.types |
172 |
|
173 |
## address: The address of the local repository maintainer. (This |
174 |
## option is provided only as a convenience for ViewVC installations |
175 |
## which are using the default template set, where the value of this |
176 |
## option will be displayed in the footer of every ViewVC page.) |
177 |
## |
178 |
## Example: |
179 |
## address = admin@server.com |
180 |
## |
181 |
#address = |
182 |
|
183 |
## kv_files: Provides a mechanism for custom key/value pairs to be |
184 |
## available to templates. These are stored in key/value (KV) files. |
185 |
## |
186 |
## The paths of the KV files are listed here, specified either as |
187 |
## absolute paths or relative to this configuration file. The files |
188 |
## use the same format as this configuration file, containing one or |
189 |
## more user-defined sections, and user-defined options in those |
190 |
## sections. ViewVC makes these options available to template authors |
191 |
## as: |
192 |
## |
193 |
## kv.SECTION.OPTION |
194 |
## |
195 |
## Note that an option name can be dotted. For example: |
196 |
## |
197 |
## [my_images] |
198 |
## logos.small = /images/small-logo.png |
199 |
## logos.big = /images/big-logo.png |
200 |
## |
201 |
## Templates can use these with a directive like: [kv.my_images.logos.small] |
202 |
## |
203 |
## Note that section names which are common to multiple KV files will |
204 |
## be merged. If two files have a [my_images] section, then the |
205 |
## options in those two like-named sections will be merged together. |
206 |
## If two files have the same option name in a section, then one will |
207 |
## overwrite the other (and which one "wins" is unspecified). |
208 |
## |
209 |
## To further categorize the KV files, and how the values are provided to |
210 |
## the templates, a KV file name may be annotated with an additional level |
211 |
## of dotted naming. For example: |
212 |
## |
213 |
## kv_files = [asf]kv/images.conf |
214 |
## |
215 |
## Assuming the same section as above, the template would refer to an image |
216 |
## using [kv.asf.my_images.logos.small] |
217 |
## |
218 |
## Lastly, it is possible to use %lang% in the filenames to specify a |
219 |
## substitution of the selected language-tag. |
220 |
## |
221 |
## Example: |
222 |
## kv_files = kv/file1.conf, kv/file2.conf, [i18n]kv/%lang%_data.conf |
223 |
## |
224 |
#kv_files = |
225 |
|
226 |
## This option is a comma-separated list of language-tag values |
227 |
## available to ViewVC. The first language-tag listed is the default |
228 |
## language, and will be used if an Accept-Language header is not |
229 |
## present in the request, or none of the user's requested languages |
230 |
## are available. If there are ties on the selection of a language, |
231 |
## then the first to appear in the list is chosen. |
232 |
## |
233 |
## Example: |
234 |
## languages = en-us, en-gb, de |
235 |
## |
236 |
#languages = en-us |
237 |
|
238 |
|
239 |
##--------------------------------------------------------------------------- |
240 |
[utilities] |
241 |
|
242 |
## ViewVC uses (sometimes optionally) various third-party programs to do some |
243 |
## of the heavy lifting. Generally, it will attempt to execute those utility |
244 |
## programs in such a way that if they are found in ViewVC's executable |
245 |
## search path ($PATH, %PATH%, etc.) all is well. But sometimes these tools |
246 |
## aren't installed in the executable search path, so here's where you can |
247 |
## tell ViewVC where to find them. |
248 |
## |
249 |
## NOTE: Options with a "_dir" suffix are for configuring the |
250 |
## directories in which certain programs live. Note that this might |
251 |
## not be the same directory into which the program's installer dumped |
252 |
## the whole program package -- we want the deepest directory in which |
253 |
## the executable program itself resides ("C:\rcstools\bin\win32" |
254 |
## rather than just "C:\rcstools", for example). The values of options |
255 |
## whose names lack the "_dir" suffix should point to the actual |
256 |
## program itself (such as "C:\Program Files\cvsnt\cvs.exe"). |
257 |
|
258 |
|
259 |
## rcs_dir: Directory in which the RCS utilities are installed, used |
260 |
## for viewing CVS repositories. |
261 |
## |
262 |
## Example: |
263 |
## rcs_dir = /usr/bin/ |
264 |
## |
265 |
#rcs_dir = |
266 |
|
267 |
## cvsnt: Location of cvsnt program. ViewVC can use CVSNT (www.cvsnt.org) |
268 |
## instead of the RCS utilities to retrieve information from CVS |
269 |
## repositories. To enable use of CVSNT, set the "cvsnt" value to the |
270 |
## path of the CVSNT executable. (If CVSNT is on the standard path, you |
271 |
## can also set it to the name of the CVSNT executable). By default |
272 |
## "cvsnt" is set to "cvs" on Windows and is not set on other platforms. |
273 |
## |
274 |
## Examples: |
275 |
## cvsnt = K:\Program Files\cvsnt\cvs.exe |
276 |
## cvsnt = /usr/bin/cvs |
277 |
## cvsnt = cvs |
278 |
## |
279 |
#cvsnt = |
280 |
|
281 |
## svn: Location of the Subversion command-line client, used for |
282 |
## viewing Subversion repositories. |
283 |
## |
284 |
## Example: |
285 |
## svn = /usr/bin/svn |
286 |
## |
287 |
#svn = |
288 |
|
289 |
## diff: Location of the GNU diff program, used for showing file |
290 |
## version differences. |
291 |
## |
292 |
## Example: |
293 |
## diff = /usr/bin/diff |
294 |
## |
295 |
#diff = |
296 |
|
297 |
## cvsgraph: Location of the CvsGraph program, a graphical CVS version |
298 |
## graph generator (see options.use_cvsgraph). |
299 |
## |
300 |
## Example: |
301 |
## cvsgraph = /usr/local/bin/cvsgraph |
302 |
## |
303 |
#cvsgraph = |
304 |
|
305 |
|
306 |
##--------------------------------------------------------------------------- |
307 |
[options] |
308 |
|
309 |
## root_as_url_component: Interpret the first path component in the URL |
310 |
## after the script location as the root to use. This is an |
311 |
## alternative to using the "root=" query key. If ViewVC is configured |
312 |
## with multiple repositories, this results in more natural looking |
313 |
## ViewVC URLs. |
314 |
## |
315 |
## NOTE: Enabling this option will break backwards compatibility with |
316 |
## any old ViewCVS URL which doesn't have an explicit "root" parameter. |
317 |
## |
318 |
#root_as_url_component = 1 |
319 |
|
320 |
## checkout_magic: Use checkout links with magic /*checkout*/ prefixes so |
321 |
## checked out HTML pages can have working links to other repository files |
322 |
## |
323 |
## NOTE: This option is DEPRECATED and should not be used in new ViewVC |
324 |
## installations. Setting "default_file_view = co" achieves the same effect |
325 |
## |
326 |
#checkout_magic = 0 |
327 |
|
328 |
## allowed_views: List the ViewVC views which are enabled. Views not |
329 |
## in this comma-delited list will not be served (or, will return an |
330 |
## error on attempted access). |
331 |
## Possible values: "annotate", "co", "diff", "markup", "roots", "tar" |
332 |
## |
333 |
allowed_views = annotate, diff, markup, roots, co |
334 |
|
335 |
## authorizer: The name of the ViewVC authorizer plugin to use when |
336 |
## authorizing access to repository contents. This value must be the |
337 |
## name of a Python module addressable as vcauth.MODULENAME (most |
338 |
## easily accomplished by placing it in ViewVC's lib/vcauth/ directory) |
339 |
## and which implements a ViewVCAuthorizer class (as a subclass of |
340 |
## vcauth.GenericViewVCAuthorizer). You can provide custom parameters |
341 |
## to the authorizer module by defining configuration sections named |
342 |
## authz-MODULENAME and adding the parameter keys and values there. |
343 |
## |
344 |
## ViewVC provides the following modules: |
345 |
## svnauthz - based on Subversion authz files |
346 |
## forbidden - simple path glob matches against top-level root directories |
347 |
## forbiddenre - root and path matches against regular expressions |
348 |
## |
349 |
## NOTE: Only one authorizer may be in use for a given ViewVC request. |
350 |
## It doesn't matter if you configure the parameters of multiple |
351 |
## authorizer plugins -- only the authorizer whose name is configured |
352 |
## here (or effectively configured here via per-vhost or per-root |
353 |
## configuration) will be activated. |
354 |
## |
355 |
#authorizer = |
356 |
|
357 |
## hide_cvsroot: Don't show the CVSROOT directory |
358 |
## 1 Hide CVSROOT directory |
359 |
## 0 Show CVSROOT directory |
360 |
## |
361 |
## NOTE: Someday this option may be removed in favor of letting |
362 |
## individual authorizer plugin hide the CVSROOT. |
363 |
## |
364 |
#hide_cvsroot = 1 |
365 |
|
366 |
## mangle_email_addresses: Mangle email addresses in marked-up output. |
367 |
## There are various levels of mangling available: |
368 |
## 0 - No mangling; markup un-mangled email addresses as hyperlinks |
369 |
## 1 - Obfuscation (using entity encoding); no hyperlinking |
370 |
## 2 - Data-dropping address truncation; no hyperlinking |
371 |
## |
372 |
## NOTE: this will not effect the display of versioned file contents, only |
373 |
## addresses that appear in version control metadata (e.g. log messages). |
374 |
## |
375 |
#mangle_email_addresses = 0 |
376 |
|
377 |
## default_file_view: "log", "co", or "markup" |
378 |
## Controls whether the default view for file URLs is a checkout view or |
379 |
## a log view. "log" is the default for backwards compatibility with old |
380 |
## ViewCVS URLs, but "co" has the advantage that it allows ViewVC to serve |
381 |
## static HTML pages directly from a repository with working links |
382 |
## to other repository files |
383 |
## |
384 |
## NOTE: Changing this option may break compatibility with existing |
385 |
## bookmarked URLs. |
386 |
## |
387 |
## ALSO NOTE: If you choose one of the "co" or "markup" views, be sure |
388 |
## to enable it (via the allowed_views option) |
389 |
## |
390 |
#default_file_view = log |
391 |
|
392 |
## http_expiration_time: Expiration time (in seconds) for cacheable |
393 |
## pages served by ViewVC. Note that in most cases, a cache aware |
394 |
## client will only revalidate the page after it expires (using the |
395 |
## If-Modified-Since and/or If-None-Match headers) and that browsers |
396 |
## will also revalidate the page when the reload button is pressed. |
397 |
## Set to 0 to disable the transmission of these caching headers. |
398 |
## |
399 |
http_expiration_time = 600 |
400 |
|
401 |
## generate_etags: Generate Etag headers for relevant pages to assist |
402 |
## in browser caching. |
403 |
## 1 Generate Etags |
404 |
## 0 Don't generate Etags |
405 |
## |
406 |
#generate_etags = 1 |
407 |
|
408 |
## svn_ignore_mimetype: Don't consult the svn:mime-type property to |
409 |
## determine how to display a file in the markup view. This is |
410 |
## especially helpful when versioned images carry the default |
411 |
## Subversion-calculated MIME type of "application/octet-stream" (which |
412 |
## isn't recognized as viewable type by browsers). |
413 |
## |
414 |
#svn_ignore_mimetype = 0 |
415 |
|
416 |
## svn_config_dir: Path of the Subversion runtime configuration |
417 |
## directory ViewVC should consult for various things, including cached |
418 |
## remote authentication credentials. If unset, Subversion will use |
419 |
## the default location(s) ($HOME/.subversion, etc.) |
420 |
## |
421 |
#svn_config_dir = |
422 |
|
423 |
## use_rcsparse: Use the rcsparse Python module to retrieve CVS |
424 |
## repository information instead of invoking rcs utilities [EXPERIMENTAL] |
425 |
## |
426 |
#use_rcsparse = 0 |
427 |
|
428 |
## sort_by: File sort order |
429 |
## file Sort by filename |
430 |
## rev Sort by revision number |
431 |
## date Sort by commit date |
432 |
## author Sort by author |
433 |
## log Sort by log message |
434 |
## |
435 |
#sort_by = file |
436 |
|
437 |
## sort_group_dirs: Group directories when sorting |
438 |
## 1 Group directories together |
439 |
## 0 No grouping -- sort directories as any other item would be sorted |
440 |
## |
441 |
#sort_group_dirs = 1 |
442 |
|
443 |
## hide_attic: Hide or show the contents of the Attic subdirectory |
444 |
## 1 Hide dead files inside Attic subdir |
445 |
## 0 Show the files which are inside the Attic subdir |
446 |
## |
447 |
#hide_attic = 1 |
448 |
|
449 |
## hide_errorful_entries: Hide or show errorful directory entries |
450 |
## (perhaps due to not being readable, or some other rlog parsing |
451 |
## error, etc.) |
452 |
## 1 Hide errorful entries from the directory display |
453 |
## 0 Show errorful entries (with their errors) in the directory display |
454 |
## |
455 |
#hide_errorful_entries = 0 |
456 |
|
457 |
## log_sort: Sort order for log messages |
458 |
## date Sort revisions by date |
459 |
## rev Sort revision by revision number |
460 |
## none Use the version control system's ordering |
461 |
## |
462 |
#log_sort = date |
463 |
|
464 |
## diff_format: Default diff format |
465 |
## h Human readable |
466 |
## u Unified diff |
467 |
## c Context diff |
468 |
## s Side by side |
469 |
## l Long human readable (more context) |
470 |
## f Full human readable (entire file) |
471 |
## |
472 |
#diff_format = h |
473 |
|
474 |
## hr_breakable: Diff view line breaks |
475 |
## 1 lines break at spaces |
476 |
## 0 no line breaking |
477 |
## Or, use a positive integer > 1 to cut lines after that many characters |
478 |
## |
479 |
#hr_breakable = 1 |
480 |
|
481 |
## hr_funout: Give out function names in human readable diffs. |
482 |
## (Only works well for C source files, otherwise diff's heuristic falls short.) |
483 |
## ('-p' option to diff) |
484 |
## |
485 |
#hr_funout = 0 |
486 |
|
487 |
## hr_ignore_white: Ignore whitespace (indendation and stuff) for human |
488 |
## readable diffs. |
489 |
## ('-w' option to diff) |
490 |
## |
491 |
#hr_ignore_white = 0 |
492 |
|
493 |
## hr_ignore_keyword_subst: Ignore diffs which are caused by keyword |
494 |
## substitution (such as "$Id - Stuff"). |
495 |
## ('-kk' option to rcsdiff) |
496 |
## |
497 |
#hr_ignore_keyword_subst = 1 |
498 |
|
499 |
## hr_intraline: Enable highlighting of intraline changes in human |
500 |
## readable diffs. [Requires Python 2.4] |
501 |
## |
502 |
#hr_intraline = 0 |
503 |
|
504 |
## allow_compress: Allow compression via gzip of output if the Browser |
505 |
## accepts it (HTTP_ACCEPT_ENCODING contains "gzip"). |
506 |
## |
507 |
## NOTE: this relies on Python's gzip module, which has proven to be |
508 |
## not-so-performant. Enabling this feature should reduce the overall |
509 |
## transfer size of ViewVC's responses to the client's request, but |
510 |
## will do so with a speed penalty. |
511 |
## |
512 |
#allow_compress = 0 |
513 |
|
514 |
## template_dir: The directory which contains the EZT templates used by |
515 |
## ViewVC to customize the display of the various output views. ViewVC |
516 |
## looks in this directory for files with names that match the name of |
517 |
## the view ("log", "directory", etc.) plus the ".ezt" extension. If |
518 |
## specified as a relative path, it is relative to the directory where |
519 |
## this config file resides; absolute paths may be used as well. If |
520 |
## %lang% occurs in the pathname, then the selected language will be |
521 |
## substituted. |
522 |
## |
523 |
## SEE ALSO: the [templates] configuration section, where you can |
524 |
## override templates on a per-view basis. |
525 |
## |
526 |
template_dir = /usr/share/viewvc/templates/ |
527 |
|
528 |
## docroot: Web path to a directory that contains ViewVC static files |
529 |
## (stylesheets, images, etc.) If set, static files will get |
530 |
## downloaded directory from this location. If unset, static files |
531 |
## will be served by the ViewVC script (at a likely performance |
532 |
## penalty, and from the "docroot" subdirectory of the directory |
533 |
## specified by the "template_dir" option). |
534 |
## |
535 |
## NOTE: This option is evaluated outside the context of a particular |
536 |
## root. Be careful when using per-root configuration to select an |
537 |
## alternate template set as the default value for this option will |
538 |
## still be based on the global default template set per 'template_dir' |
539 |
## above, not on 'template_dir' as overridden for a given root. |
540 |
## |
541 |
docroot = /viewvc |
542 |
|
543 |
## show_subdir_lastmod: Show last changelog message for CVS subdirectories |
544 |
## |
545 |
## NOTE: The current implementation makes many assumptions and may show |
546 |
## the incorrect file at some times. The main assumption is that the |
547 |
## last modified file has the newest filedate. But some CVS operations |
548 |
## touches the file without even when a new version is not checked in, |
549 |
## and TAG based browsing essentially puts this out of order, unless |
550 |
## the last checkin was on the same tag as you are viewing. Enable |
551 |
## this if you like the feature, but don't rely on correct results. |
552 |
## |
553 |
## SECURITY WARNING: Enabling this will currently leak unauthorized |
554 |
## path names. |
555 |
## |
556 |
#show_subdir_lastmod = 0 |
557 |
|
558 |
## show_logs: Show the most recent log entry in directory listings. |
559 |
## |
560 |
#show_logs = 1 |
561 |
|
562 |
## show_log_in_markup: Show log when viewing file contents. |
563 |
## |
564 |
#show_log_in_markup = 1 |
565 |
|
566 |
## cross_copies: Cross filesystem copies when traversing Subversion |
567 |
## file revision histories. |
568 |
## |
569 |
#cross_copies = 1 |
570 |
|
571 |
## use_localtime: Display dates as UTC or in local time zone. |
572 |
## |
573 |
#use_localtime = 0 |
574 |
|
575 |
## short_log_len: The length (in characters) to which the most recent |
576 |
## log entry should be truncated when shown in the directory view. |
577 |
## |
578 |
#short_log_len = 80 |
579 |
|
580 |
## enable_syntax_coloration: Should we colorize known file content |
581 |
## syntaxes? [Requires Pygments Python module] |
582 |
## |
583 |
#enable_syntax_coloration = 1 |
584 |
|
585 |
## tabsize: The number of spaces into which tabstops are converted |
586 |
## when viewing file contents. |
587 |
## |
588 |
#tabsize = 8 |
589 |
|
590 |
## detect_encoding: Should we attempt to detect versioned file |
591 |
## character encodings? [Requires 'chardet' module, and is currently |
592 |
## used only by the syntax coloration logic -- if enabled -- for the |
593 |
## 'markup' and 'annotate' views; see 'enable_syntax_coloration'.] |
594 |
## |
595 |
#detect_encoding = 0 |
596 |
|
597 |
## use_cvsgraph: Use CvsGraph to offer visual graphs of CVS revision history. |
598 |
## |
599 |
#use_cvsgraph = 0 |
600 |
|
601 |
## cvsgraph_conf: Location of the customized cvsgraph configuration file. |
602 |
## May be specified as an absolute path or as a path relative to this |
603 |
## configuration file. |
604 |
## |
605 |
cvsgraph_conf = /etc/viewvc/cvsgraph.conf |
606 |
|
607 |
## use_re_search: Enable regular expression search of files in a directory. |
608 |
## |
609 |
## WARNING: Enabling this option can consume HUGE amounts of server |
610 |
## time. A "checkout" must be performed on *each* file in a directory, |
611 |
## and the result needs to be searched for a match against the regular |
612 |
## expression. |
613 |
## |
614 |
## SECURITY WARNING: Since a user can enter the regular expression, it |
615 |
## is possible for them to enter an expression with many alternatives |
616 |
## and a lot of backtracking. Executing that search over thousands of |
617 |
## lines over dozens of files can easily tie up a server for a long |
618 |
## period of time. This option should only be used on sites with |
619 |
## trusted users. It is highly inadvisable to use this on a public site. |
620 |
## |
621 |
#use_re_search = 0 |
622 |
|
623 |
## dir_pagesize: Maximum number of directory entries on a given page. |
624 |
## This allows ViewVC to present discrete pages to the users instead of |
625 |
## the entire directory. Set to 0 to disable pagination. |
626 |
## |
627 |
dir_pagesize = 100 |
628 |
|
629 |
## log_pagesize: Maximum number of revision log entries on a given page. |
630 |
## This allows ViewVC to present discrete pages to the users instead of |
631 |
## the entire revision log. Set to 0 to disable pagination. |
632 |
## |
633 |
log_pagesize = 100 |
634 |
|
635 |
## limit_changes: Maximum number of changed paths shown per commit in |
636 |
## the Subversion revision view and in query results. This is not a |
637 |
## hard limit (the UI provides options to show all changed paths), but |
638 |
## it prevents ViewVC from generating enormous and hard to read pages |
639 |
## by default when they happen to contain import or merge commits |
640 |
## affecting hundreds or thousands of files. Set to 0 to disable the |
641 |
## limit. |
642 |
## |
643 |
#limit_changes = 100 |
644 |
|
645 |
##--------------------------------------------------------------------------- |
646 |
[templates] |
647 |
|
648 |
## You can override the templates used by various ViewVC views in this |
649 |
## section. By default, ViewVC will look for templates in the |
650 |
## directory specified by the "template_dir" configuration option (see |
651 |
## the documentation for that option for details). But if you want to |
652 |
## use a different template for a particular view, simply uncomment the |
653 |
## appropriate option below and specify the currect location of the EZT |
654 |
## template file you wish to use for that view. |
655 |
## |
656 |
## Templates are specified relative to the configured template |
657 |
## directory (see the "template_dir" option), but absolute paths may |
658 |
## also be used as well. |
659 |
## |
660 |
## If %lang% occurs in the pathname, then the selected language will be |
661 |
## substituted. |
662 |
## |
663 |
## NOTE: the selected language is defined by the "languages" item in the |
664 |
## [general] section, and based on the request's Accept-Language |
665 |
## header. |
666 |
## |
667 |
|
668 |
## diff: Template used for the file differences view. |
669 |
## |
670 |
#diff = |
671 |
|
672 |
## directory: Template used for the directory listing view. |
673 |
## |
674 |
#directory = |
675 |
|
676 |
## error: Template used for the ViewVC error display view. |
677 |
## |
678 |
#error = |
679 |
|
680 |
## file: Template used for the file contents/annotation view. |
681 |
## |
682 |
#file = |
683 |
|
684 |
## graph: Template used for the revision graph view. |
685 |
## |
686 |
#graph = |
687 |
|
688 |
## log: Template used for the revision log view. |
689 |
## |
690 |
#log = |
691 |
|
692 |
## query: Template used for the non-integrated query interface. |
693 |
## |
694 |
#query = |
695 |
|
696 |
## query_form: Template used for the query form view. |
697 |
## |
698 |
#query_form = |
699 |
|
700 |
## query_results: Template used for the query results view. |
701 |
## |
702 |
#query_results = |
703 |
|
704 |
## revision: Template used for the revision/changeset view. |
705 |
## |
706 |
#revision = |
707 |
|
708 |
## roots: Template used for the root listing view. |
709 |
## |
710 |
#roots = |
711 |
|
712 |
##--------------------------------------------------------------------------- |
713 |
[cvsdb] |
714 |
|
715 |
## enabled: Enable database integration feature. |
716 |
## |
717 |
#enabled = 0 |
718 |
|
719 |
## host: Database hostname. Leave unset to use a local Unix socket |
720 |
## connection. |
721 |
## |
722 |
#host = |
723 |
|
724 |
## post: Database listening port. |
725 |
## |
726 |
#port = 3306 |
727 |
|
728 |
## database_name: ViewVC database name. |
729 |
## |
730 |
#database_name = ViewVC |
731 |
|
732 |
## user: Username of user with read/write privileges to the database |
733 |
## specified by the 'database_name' configuration option. |
734 |
## |
735 |
#user = |
736 |
|
737 |
## passwd: Password of user with read/write privileges to the database |
738 |
## specified by the 'database_name' configuration option. |
739 |
## |
740 |
#passwd = |
741 |
|
742 |
## readonly_user: Username of user with read privileges to the database |
743 |
## specified by the 'database_name' configuration option. |
744 |
## |
745 |
#readonly_user = |
746 |
|
747 |
## readonly_passwd: Password of user with read privileges to the database |
748 |
## specified by the 'database_name' configuration option. |
749 |
## |
750 |
#readonly_passwd = |
751 |
|
752 |
## row_limit: Maximum number of rows returned by a given normal query |
753 |
## to the database. |
754 |
## |
755 |
#row_limit = 1000 |
756 |
|
757 |
## rss_row_limit: Maximum number of rows returned by a given query to |
758 |
## the database made as part of an RSS feed request. (Keeping in mind |
759 |
## that RSS readers tend to poll regularly for new data, you might want |
760 |
## to keep this set to a conservative number.) |
761 |
## |
762 |
#rss_row_limit = 100 |
763 |
|
764 |
## check_database_for_root: Check if the repository is found in the |
765 |
## database before showing the query link and RSS feeds. |
766 |
## |
767 |
## WARNING: Enabling this check adds the cost of a database connection |
768 |
## and query to most ViewVC requests. If all your roots are represented |
769 |
## in the commits database, or if you don't care about the creation of |
770 |
## RSS and query links that might lead ultimately to error pages for |
771 |
## certain of your roots, or if you simply don't want to add this extra |
772 |
## cost to your ViewVC requests, leave this disabled. |
773 |
## |
774 |
#check_database_for_root = 0 |
775 |
|
776 |
##--------------------------------------------------------------------------- |
777 |
[vhosts] |
778 |
|
779 |
## Virtual hosts are individual logical servers accessible via |
780 |
## different hostnames, but which are all really the same physical |
781 |
## computer. For example, you might have your web server configured to |
782 |
## accept incoming traffic for both http://www.yourdomain.com/ and |
783 |
## http://viewvc.yourdomain.com/. Users pointing their web browsers at |
784 |
## each of those two URLs might see entirely different content via one |
785 |
## URL versus the other, but all that content actually lives on the |
786 |
## same computer, is served up via the same web server, and so |
787 |
## on. It just *looks* like its coming from multiple servers. |
788 |
## |
789 |
## ViewVC allows you to customize its configuration options for |
790 |
## individual virtual hosts. You might, for example, wish to expose |
791 |
## all of your Subversion repositories at http://svn.yourdomain.com/viewvc/ |
792 |
## and all your CVS ones at http://cvs.yourdomain.com/viewvc/, with no |
793 |
## cross-exposure. Using ViewVC's virtual host (vhost) configuration |
794 |
## support, you can do this. Simply create two vhost configurations |
795 |
## (one for each of your hostnames), then configure the cvs_roots |
796 |
## option only for the vhost associated with cvs.yourdomain.com, and |
797 |
## configure the svn_roots option only for the vhost associated with |
798 |
## svn.yourdomain.com. |
799 |
## |
800 |
## This section is a freeform configuration section, where you create |
801 |
## both the option names and their values. The names of the options |
802 |
## are then treated as canonical names of virtual hosts, and their |
803 |
## values are defined to be comma-delimited lists of hostname globs |
804 |
## against which incoming ViewVC requests will be matched to figure out |
805 |
## which vhost they apply to. |
806 |
## |
807 |
## After you've named and defined your vhosts, you may then create new |
808 |
## configuration sections whose names are of the form |
809 |
## vhost-VHOSTNAME/CONFIGSECTION. VHOSTNAME here is the canonical name |
810 |
## of one of the virtual hosts you defined under the [vhosts] section. |
811 |
## Inside those configuration sections, you override the standard |
812 |
## ViewVC options typically found in the base configuration section |
813 |
## named CONFIGSECTION ("general", "option", etc.) |
814 |
## |
815 |
## NOTE: Per-vhost overrides may only be applied to the following |
816 |
## sections: |
817 |
## |
818 |
## general |
819 |
## options |
820 |
## utilities |
821 |
## templates |
822 |
## cvsdb |
823 |
## authz-* |
824 |
## |
825 |
## Here is an example: |
826 |
## |
827 |
## [vhosts] |
828 |
## libs = libs.yourdomain.*, *.yourlibs.* |
829 |
## gui = guiproject.yourdomain.* |
830 |
## |
831 |
## [vhost-libs/general] |
832 |
## cvs_roots = |
833 |
## svn_roots = svnroot: /var/svn/libs-repos |
834 |
## default_root = svnroot |
835 |
## |
836 |
## [vhost-libs/options] |
837 |
## show_logs = 1 |
838 |
## |
839 |
## [vhost-gui/general] |
840 |
## cvs_roots = cvsroot: /var/cvs/guiproject |
841 |
## svn_roots = |
842 |
## default_root = cvsroot |
843 |
## |
844 |
|
845 |
##--------------------------------------------------------------------------- |
846 |
## ViewVC recognizes per-root configuration overrides, too. To |
847 |
## override the value of a configuration parameter only for a single |
848 |
## root, create a configuration section whose names is of the form |
849 |
## root-ROOTNAME/CONFIGSECTION. ROOTNAME here is the name of the root |
850 |
## as defined explicitly in cvs_roots or svn_roots or implicitly as the |
851 |
## basename of a root path in root_parents. Options found in this new |
852 |
## configuration section override for this one root the corresponding |
853 |
## options found in the base configuration section CONFIGSECTION |
854 |
## ("options", "authz-*", etc.) as interpreted after per-vhost |
855 |
## overrides (if any) have been applied. |
856 |
## |
857 |
## NOTE: Per-root overrides may only be applied to the following |
858 |
## sections: |
859 |
## |
860 |
## options |
861 |
## utilities |
862 |
## authz-* |
863 |
## |
864 |
## WARNING: Do not use per-root overrides if your ViewVC instance is |
865 |
## served via the standalone.py server option! Doing so could cause |
866 |
## ViewVC to be unable to function properly (or at all). |
867 |
## |
868 |
## Here is an example showing how to enable Subversion authz-based |
869 |
## authorization for only the single root named "svnroot": |
870 |
## |
871 |
## [root-svnroot/options] |
872 |
## authorizer = svnauthz |
873 |
## |
874 |
## [root-svnroot/authz-svnauthz] |
875 |
## authzfile = /path/to/authzfile |
876 |
## |
877 |
|
878 |
##--------------------------------------------------------------------------- |
879 |
[authz-forbidden] |
880 |
|
881 |
## The "forbidden" authorizer forbids access to repository modules, |
882 |
## defined to be top-level subdirectories in a repository. |
883 |
## |
884 |
## NOTE: The options in this section apply only when the 'authorizer' |
885 |
## option (in the [options] section) is set to 'forbidden'. |
886 |
|
887 |
## forbidden: A comma-delimited list of patterns which match modules |
888 |
## that ViewVC should hide from users. |
889 |
## |
890 |
## You can use a simple list of modules, or something more complex: |
891 |
## |
892 |
## *) The "!" can be used before a module to explicitly state that it |
893 |
## is NOT forbidden. Whenever this form is seen, then all modules will |
894 |
## be forbidden unless one of the "!" modules match. |
895 |
## |
896 |
## *) Shell-style "glob" expressions may be used. "*" will match any |
897 |
## sequence of zero or more characters, "?" will match any single |
898 |
## character, "[seq]" will match any character in seq, and "[!seq]" |
899 |
## will match any character not in seq. |
900 |
## |
901 |
## *) Tests are performed in sequence. The first match will terminate the |
902 |
## testing. This allows for more complex allow/deny patterns. |
903 |
## |
904 |
## Tests are case-sensitive. |
905 |
## |
906 |
## NOTE: Again, this is for the hiding of modules within repositories, *not* |
907 |
## for the hiding of repositories (roots) themselves. |
908 |
## |
909 |
## Some examples: |
910 |
## |
911 |
## Disallow "example" but allow all others: |
912 |
## forbidden = example |
913 |
## |
914 |
## Disallow "example1" and "example2" but allow all others: |
915 |
## forbidden = example1, example2 |
916 |
## |
917 |
## Allow *only* "example1" and "example2": |
918 |
## forbidden = !example1, !example2 |
919 |
## |
920 |
## Forbid modules starting with "x": |
921 |
## forbidden = x* |
922 |
## |
923 |
## Allow modules starting with "x" but no others: |
924 |
## forbidden = !x* |
925 |
## |
926 |
## Allow "xml", forbid other modules starting with "x", and allow the rest: |
927 |
## forbidden = !xml, x*, !* |
928 |
## |
929 |
#forbidden = |
930 |
|
931 |
##--------------------------------------------------------------------------- |
932 |
[authz-forbiddenre] |
933 |
|
934 |
## The "forbiddenre" authorizer forbids access to repositories and |
935 |
## repository paths by comparing a list of regular expressions |
936 |
## (separated by commas) against paths consisting of the repository (or |
937 |
## root) name plus the path of the versioned file or directory to be |
938 |
## tested. For example, to see if the user is authorized to see the |
939 |
## path "/trunk/www/index.html" in the repository whose root name is |
940 |
## "svnrepos", this authorizer will check the path |
941 |
## "svnrepos/trunk/www/index.html" against the list of forbidden |
942 |
## regular expressions. Directory paths will be terminated by a forward |
943 |
## slash. |
944 |
## |
945 |
## NOTE: The options in this section apply only when the 'authorizer' |
946 |
## option (in the [options] section) is set to 'forbiddenre'. |
947 |
|
948 |
## forbiddenre: A comma-delimited list of regular expressions which |
949 |
## match paths that ViewVC should hide from users. |
950 |
## |
951 |
## Like the "forbidden" authorizer... |
952 |
## |
953 |
## *) The "!" can be used before a module to explicitly state that it |
954 |
## is NOT forbidden. Whenever this form is seen, then all modules will |
955 |
## be forbidden unless one of the "!" modules match. |
956 |
## |
957 |
## *) Tests are performed in sequence. The first match will terminate the |
958 |
## testing. This allows for more complex allow/deny patterns. |
959 |
## |
960 |
## Unlike the "forbidden" authorizer, you can can use this to hide roots, too. |
961 |
## |
962 |
## Some examples: |
963 |
## |
964 |
## Disallow files named "PRIVATE", but allow all others: |
965 |
## forbiddenre = /PRIVATE$ |
966 |
## |
967 |
## Disallow the "hidden" repository, allowing all others: |
968 |
## forbiddenre = ^hidden(/|$) |
969 |
## |
970 |
## Allow only the "example1" and "example2" roots and the paths inside them, |
971 |
## disallowing all others (which can be done in multiple ways): |
972 |
## forbiddenre = !^example1(/|$), !^example2(/|$)/ |
973 |
## forbiddenre = !^example[12](/|$) |
974 |
## |
975 |
## Only allow visibility of HTML files and the directories that hold them: |
976 |
## forbiddenre = !^([^/]+|.*(/|\.html))$ |
977 |
## |
978 |
#forbiddenre = |
979 |
|
980 |
##--------------------------------------------------------------------------- |
981 |
[authz-svnauthz] |
982 |
|
983 |
## The "svnauthz" authorizer uses a Subversion authz configuration file |
984 |
## to determine access to repository paths. |
985 |
## |
986 |
## NOTE: The options in this section apply only when the 'authorizer' |
987 |
## option (in the [options] section) is set to 'svnauthz'. |
988 |
|
989 |
## authzfile: Specifies the location of the authorization rules file |
990 |
## (using an absolute path). |
991 |
## |
992 |
#authzfile = |
993 |
|
994 |
## force_username_case: Like the AuthzForceUsernameCase httpd.conf |
995 |
## directive, set this to "upper" or "lower" to force the normalization |
996 |
## to upper- or lower-case, respectively, of incoming usernames prior |
997 |
## to comparison against the authorization rules files. Leave the |
998 |
## option unset to preserve the username case. |
999 |
## |
1000 |
#force_username_case = |
1001 |
|
1002 |
##--------------------------------------------------------------------------- |