Add redhat-test target, and migrate the RPM_PACKAGEV stuff from 3.0 branch.
[privoxy.git] / config
1 #  Sample Configuration file for Privoxy
2 #
3 # $Id: config,v 1.38 2002/05/03 03:59:25 hal9 Exp $
4 #
5 ###################################################################
6 #                                                                 #
7 #                     Table of Contents                           #
8 #                                                                 #
9 #       I. INTRODUCTION                                           #
10 #      II. FORMAT OF THE CONFIGURATION FILE                       #
11 #                                                                 #
12 #       1. CONFIGURATION AND LOG FILE LOCATIONS                   #
13 #       2. LOCAL SET-UP DOCUMENTATION                             #
14 #       3. DEBUGGING                                              #
15 #       4. ACCESS CONTROL AND SECURITY                            #
16 #       5. FORWARDING                                             #
17 #       6. WINDOWS GUI OPTIONS                                    #
18 #                                                                 #
19 ###################################################################
20
21 #  I. INTRODUCTION
22 #  ===============
23 #
24 #  This file holds the Privoxy configuration.  If you modify this
25 #  file, you will need to send a couple of requests to the proxy
26 #  before any changes take effect.
27 #
28 #  When starting Privoxy on Unix systems, give the name of this
29 #  file as an argument.  On Windows systems, Privoxy will look for
30 #  this file with the name 'config.txt' in the same directory where
31 #  Privoxy is installed.
32 #
33
34 #  II. FORMAT OF THE CONFIGURATION FILE
35 #  ====================================
36 #
37 #  Configuration lines consist of an initial keyword followed by a list
38 #  of values, all separated by whitespace (any number of spaces or
39 #  tabs).  For example,
40 #
41 #  actionsfile default.action
42 #
43 #  Indicates that the actionsfile is named 'default.action'.
44 #
45 #  The '#' indicates a comment.  Any part of a line following a '#' is
46 #  ignored, except if the '#' is preceded by a '\'.
47 #
48 #  Thus, by placing a # at the start of an existing configuration line,
49 #  you can make it a comment and it will be treated as if it weren't there. 
50 #  This is called "commenting out" an option and can be useful.
51 #
52 #  Note that commenting out and option and leaving it at its default
53 #  are two completely different things! Most options behave very
54 #  differently when unset. See the the "Effect if unset" explanation
55 #  in each option's description for details.
56 #
57 #  Long lines can be continued on the next line by using a `\' as
58 #  the last character.
59 #
60
61 #   1. CONFIGURATION AND LOG FILE LOCATIONS
62 #   =======================================
63 #
64 #  Privoxy can (and normally does) use a number of other files for
65 #  additional configuration and logging. This section of the
66 #  configuration file tells Privoxy where to find those other files.
67 #
68 #  The user running Privoxy, must have read permission for all 
69 #  configuration files, and write permission to any files that would 
70 #  be modified, such as log files.
71
72 #  1.1. user-manual
73 #  ================
74
75 #  Specifies:
76 #    
77 #      Location of the Privoxy User Manual.
78 #     
79 #  Type of value:
80 #    
81 #      A fully qualified URI
82 #    
83 #  Default value:
84 #    
85 #      http://www.privoxy.org/user-manual/
86 #    
87 #  Effect if unset:
88 #    
89 #      The default will be used.
90 #    
91 #  Notes:
92 #    
93 #     The User Manual is used for help hints from some of the internal
94 #     CGI pages. It is normally packaged with the binary distributions,
95 #     and would make more sense to have this pointed at a locally
96 #     installed copy.
97 #    
98 #     A more useful example (Unix):
99 #    
100 #       user-manual  file:///usr/share/doc/privoxy-2.9.14/user-manual/
101 #     
102 #   +-----------------------------------------------------------------+
103 #   |                             Warning                             |
104 #   |-----------------------------------------------------------------|
105 #   |If this option is defined, it must come first! It is needed      |
106 #   |before the rest of config is read.                               |
107 #   +-----------------------------------------------------------------+
108
109 #    
110 #user-manual http://www.privoxy.org/user-manual/
111
112 #  1.2. confdir
113 #  ============
114
115 #  Specifies:
116 #     
117 #      The directory where the other configuration files are located
118 #     
119 #  Type of value:
120 #     
121 #      Path name
122 #     
123 #  Default value:
124 #     
125 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
126 #     
127 #  Effect if unset:
128 #     
129 #      Mandatory
130 #     
131 #  Notes:
132 #     
133 #      No trailing "/", please
134 #     
135 #      When development goes modular and multi-user, the blocker,
136 #      filter, and per-user config will be stored in subdirectories of
137 #      "confdir". For now, the configuration directory structure is
138 #      flat, except for confdir/templates, where the HTML templates for
139 #      CGI output reside (e.g. Privoxy's 404 error page).
140 #  
141 confdir .
142
143
144 #  1.3. logdir
145 #  ===========
146 #  
147 #  Specifies:
148 #     
149 #      The directory where all logging takes place (i.e. where logfile
150 #      and jarfile are located)
151 #     
152 #  Type of value:
153 #     
154 #      Path name
155 #     
156 #  Default value:
157 #     
158 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
159 #     
160 #  Effect if unset:
161 #     
162 #      Mandatory
163 #     
164 #  Notes:
165 #    
166 #      No trailing "/", please
167 #
168 logdir .
169
170
171 #  1.4. actionsfile
172 #  ================ 
173 #  
174 #  Specifies:
175 #     
176 #      The actions file to use
177 #     
178 #  Type of value:
179 #     
180 #      File name, relative to confdir, without the .action (Unix)
181 #      or .action.txt (Windows) extension.
182 #     
183 #  Default values:
184 #      standard  # Internal purpose, recommended
185 #      default   # Main actions file
186 #      user      # User customizations
187 #     
188 #  Effect if unset:
189 #     
190 #      No action is taken at all. Simple neutral proxying.
191 #     
192 #  Notes:
193 #      Multiple actionsfile lines are OK and are in fact recommended!
194 #
195 #      The default values include standard.action, which is used for
196 #      internal purposes and should be loaded, default.action, which
197 #      is the "main" actions file maintained by the developers, and
198 #      user.action, where you can make your personal additions.
199 #     
200 #      There is no point in using Privoxy without an actions file.
201 #
202 actionsfile standard  # Internal purpose, recommended
203 actionsfile default   # Main actions file
204 actionsfile user      # User customizations
205
206
207 #  1.5. filterfile
208 #  ===============
209 #  
210 #  Specifies:
211 #     
212 #      The filter file to use
213 #     
214 #  Type of value:
215 #     
216 #      File name, relative to confdir
217 #     
218 #  Default value:
219 #     
220 #      default.filter (Unix) or default.filter.txt (Windows)
221 #    
222 #  Effect if unset:
223 #     
224 #      No textual content filtering takes place, i.e. all +filter{name}
225 #      actions in the actions file are turned off
226 #     
227 #  Notes:
228 #     
229 #      The "default.filter" file contains content modification rules
230 #      that use "regular expressions". These rules permit powerful
231 #      changes on the content of Web pages, e.g., you could disable your
232 #      favorite JavaScript annoyances, re-write the actual displayed
233 #      text, or just have some fun replacing "Microsoft" with
234 #      "MicroSuck" wherever it appears on a Web page.
235
236 filterfile default.filter
237
238
239 #  1.6. logfile
240 #  ============
241 #  
242 #  Specifies:
243 #     
244 #      The log file to use
245 #     
246 #  Type of value:
247 #     
248 #      File name, relative to logdir
249 #     
250 #  Default value:
251 #     
252 #      logfile (Unix) or privoxy.log (Windows)
253 #     
254 #  Effect if unset:
255 #     
256 #      No log file is used, all log messages go to the console
257 #      (stderr).
258 #     
259 #  Notes:
260 #     
261 #      The windows version will additionally log to the console.
262 #     
263 #      The logfile is where all logging and error messages are written.
264 #      The level of detail and number of messages are set with the debug
265 #      option (see below). The logfile can be useful for tracking down a
266 #      problem with Privoxy (e.g., it's not blocking an ad you think it
267 #      should block) but in most cases you probably will never look at
268 #      it.
269 #     
270 #      Your logfile will grow indefinitely, and you will probably want
271 #      to periodically remove it. On Unix systems, you can do this with
272 #      a cron job (see "man cron"). For Red Hat, a logrotate script has
273 #      been included.
274 #    
275 #      On SuSE Linux systems, you can place a line like
276 #      "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
277 #      with the effect that cron.daily will automatically archive, gzip,
278 #      and empty the log, when it exceeds 1M size.
279 #    
280 #      Any log files must be writable by whatever user Privoxy is being 
281 #      run as (default on UNIX, user id is "privoxy").
282
283 logfile logfile
284
285
286 #  1.7. jarfile
287 #  ============
288 #  
289 #  Specifies:
290 #     
291 #      The file to store intercepted cookies in
292 #     
293 #  Type of value:
294 #     
295 #      File name, relative to logdir
296 #     
297 #  Default value:
298 #     
299 #      jarfile (Unix) or privoxy.jar (Windows)
300 #     
301 #  Effect if unset:
302 #     
303 #      Intercepted cookies are not stored at all.
304 #     
305 #  Notes:
306 #     
307 #      The jarfile may grow to ridiculous sizes over time.
308
309 jarfile jarfile
310
311
312 #  1.8. trustfile
313 #  ==============
314 #  
315 #  Specifies:
316 #     
317 #      The trust file to use
318 #     
319 #  Type of value:
320 #     
321 #      File name, relative to confdir
322 #     
323 #  Default value:
324 #     
325 #      Unset (commented out). When activated: trust (Unix) or trust.txt
326 #      (Windows)
327 #     
328 #  Effect if unset:
329 #    
330 #      The whole trust mechanism is turned off.
331 #     
332 #  Notes:
333 #     
334 #      The trust mechanism is an experimental feature for building
335 #      white-lists and should be used with care. It is NOT recommended
336 #      for the casual user.
337 #     
338 #      If you specify a trust file, Privoxy will only allow access to
339 #      sites that are named in the trustfile. You can also mark sites as
340 #      trusted referrers (with +), with the effect that access to
341 #      untrusted sites will be granted, if a link from a trusted
342 #      referrer was used. The link target will then be added to the
343 #      "trustfile". Possible applications include limiting Internet
344 #      access for children.
345 #     
346 #      If you use + operator in the trust file, it may grow considerably
347 #      over time.
348 #  
349 #trustfile trust
350
351
352 #  2. LOCAL SET-UP DOCUMENTATION
353 #  =============================
354 #  
355 #  If you intend to operate Privoxy for more users that just yourself,
356 #  it might be a good idea to let them know how to reach you, what you
357 #  block and why you do that, your policies etc.
358 #  
359 #
360 #  2.1. trust-info-url
361 #  ===================
362 #  
363 #  Specifies:
364 #     
365 #      A URL to be displayed in the error page that users will see if
366 #      access to an untrusted page is denied.
367 #     
368 #  Type of value:
369 #     
370 #      URL
371 #     
372 #  Default value:
373 #     
374 #      Two example URL are provided
375 #     
376 #  Effect if unset:
377 #     
378 #      No links are displayed on the "untrusted" error page.
379 #     
380 #  Notes:
381 #    
382 #      The value of this option only matters if the experimental trust
383 #      mechanism has been activated. (See trustfile above.)
384 #     
385 #      If you use the trust mechanism, it is a good idea to write up
386 #      some on-line documentation about your trust policy and to specify
387 #      the URL(s) here. Use multiple times for multiple URLs.
388 #     
389 #      The URL(s) should be added to the trustfile as well, so users
390 #      don't end up locked out from the information on why they were
391 #      locked out in the first place!
392 #    
393 trust-info-url http://www.example.com/why_we_block.html
394 trust-info-url http://www.example.com/what_we_allow.html
395
396
397 #  2.2. admin-address
398 #  ==================
399 #  
400 #  Specifies:
401 #     
402 #      An email address to reach the proxy administrator.
403 #     
404 #  Type of value:
405 #     
406 #      Email address
407 #     
408 #  Default value:
409 #     
410 #      Unset
411 #     
412 #  Effect if unset:
413 #     
414 #      No email address is displayed on error pages and the CGI user
415 #      interface.
416 #     
417 #  Notes:
418 #     
419 #      Highly recommended for multi-user installations.
420 #
421 #      If both admin-address and proxy-info-url are unset, the whole
422 #      "Local Privoxy Support" box on all generated pages will not be
423 #      shown.
424 #
425 #admin-address privoxy-admin@example.com
426
427
428 #  2.3. proxy-info-url
429 #  ===================
430 #  
431 #  Specifies:
432 #     
433 #      A URL to documentation about the local Privoxy setup,
434 #      configuration or policies.
435 #     
436 #  Type of value:
437 #     
438 #      URL
439 #     
440 #  Default value:
441 #     
442 #      Unset
443 #     
444 #  Effect if unset:
445 #     
446 #      No link to local documentation is displayed on error pages and
447 #      the CGI user interface.
448 #     
449 #  Notes:
450 #     
451 #      If both admin-address and proxy-info-url are unset, the whole
452 #      "Local Privoxy Support" box on all generated pages will not be
453 #      shown.
454 #     
455 #      This URL shouldn't be blocked ;-)
456 #  
457 #proxy-info-url http://www.example.com/proxy-service.html
458
459
460 #  3. DEBUGGING
461 #  ============
462 #  
463 #  These options are mainly useful when tracing a problem. Note that you
464 #  might also want to invoke Privoxy with the --no-daemon command line
465 #  option when debugging.
466
467
468 #  3.1. debug
469 #  ==========
470 #  
471 #  Specifies:
472 #     
473 #      Key values that determine what information gets logged.
474 #     
475 #  Type of value:
476 #     
477 #      Integer values
478 #     
479 #  Default value:
480 #     
481 #      12289 (i.e.: URLs plus warnings and errors)
482 #     
483 #  Effect if unset:
484 #     
485 #      Nothing gets logged.
486 #     
487 #  Notes:
488 #     
489 #      The available debug levels are:
490 #     
491 #        debug         1 # show each GET/POST/CONNECT request             
492 #        debug         2 # show each connection status                    
493 #        debug         4 # show I/O status                                
494 #        debug         8 # show header parsing                            
495 #        debug        16 # log all data into the logfile                  
496 #        debug        32 # debug force feature                            
497 #        debug        64 # debug regular expression filter                
498 #        debug       128 # debug fast redirects                           
499 #        debug       256 # debug GIF de-animation                         
500 #        debug       512 # Common Log Format                              
501 #        debug      1024 # debug kill pop-ups                             
502 #        debug      4096 # Startup banner and warnings               
503 #        debug      8192 # Non-fatal errors                               
504 #                                                                         
505 #     
506 #      To select multiple debug levels, you can either add them or use
507 #      multiple debug lines.
508 #    
509 #      A debug level of 1 is informative because it will show you each
510 #      request as it happens. 1, 4096 and 8192 are highly recommended so
511 #      that you will notice when things go wrong. The other levels are
512 #      probably only of interest if you are hunting down a specific
513 #      problem. They can produce a hell of an output (especially 16).
514 #     
515 #      The reporting of fatal errors (i.e. ones which crash Privoxy) is
516 #      always on and cannot be disabled.
517 #     
518 #      If you want to use CLF (Common Log Format), you should set "debug
519 #      512" ONLY and not enable anything else.
520 #  
521 debug   1    # show each GET/POST/CONNECT request
522 debug   4096 # Startup banner and warnings
523 debug   8192 # Errors - *we highly recommended enabling this*
524
525
526 #  3.2. single-threaded
527 #  ====================
528 #  
529 #  Specifies:
530 #     
531 #      Whether to run only one server thread
532 #     
533 #  Type of value:
534 #     
535 #      None
536 #     
537 #  Default value:
538 #    
539 #      Unset
540 #    
541 #  Effect if unset:
542 #     
543 #      Multi-threaded (or, where unavailable: forked) operation, i.e.
544 #      the ability to serve multiple requests simultaneously.
545 #     
546 #  Notes:
547 #     
548 #      This option is only there for debug purposes and you should never
549 #      need to use it. It will drastically reduce performance.
550 #    
551 #single-threaded
552
553
554 #  4. ACCESS CONTROL AND SECURITY
555 #  ==============================
556 #  
557 #  This section of the config file controls the security-relevant
558 #  aspects of Privoxy's configuration.
559
560
561 #  4.1. listen-address
562 #  ===================
563 #  
564 #  Specifies:
565 #     
566 #      The IP address and TCP port on which Privoxy will listen for
567 #      client requests.
568 #     
569 #  Type of value:
570 #     
571 #      [IP-Address]:Port
572 #     
573 #  Default value:
574 #     
575 #      127.0.0.1:8118
576 #     
577 #  Effect if unset:
578 #     
579 #      Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
580 #      recommended for home users who run Privoxy on the same machine as
581 #      their browser.
582 #    
583 #  Notes:
584 #     
585 #      You will need to configure your browser(s) to this proxy address
586 #      and port.
587 #     
588 #      If you already have another service running on port 8118, or if
589 #      you want to serve requests from other machines (e.g. on your
590 #      local network) as well, you will need to override the default.
591 #     
592 #      If you leave out the IP address, Privoxy will bind to all
593 #      interfaces (addresses) on your machine and may become reachable
594 #      from the Internet. In that case, consider using access control
595 #      lists (acl's) (see "ACLs" below), or a firewall.
596 #     
597 #  Example:
598 #     
599 #      Suppose you are running Privoxy on a machine which has the
600 #      address 192.168.0.1 on your local private network (192.168.0.0)
601 #      and has another outside connection with a different address. You
602 #      want it to serve requests from inside only:
603 #     
604 #        listen-address  192.168.0.1:8118                                 
605 #                                                                        
606 listen-address 127.0.0.1:8118
607
608  
609 #  4.2. toggle
610 #  ===========
611 #  
612 #  Specifies:
613 #     
614 #      Initial state of "toggle" status
615 #     
616 #  Type of value:
617 #     
618 #      1 or 0
619 #     
620 #  Default value:
621 #     
622 #      1
623 #     
624 #  Effect if unset:
625 #     
626 #      Act as if toggled on
627 #     
628 #  Notes:
629 #    
630 #      If set to 0, Privoxy will start in "toggled off" mode, i.e.
631 #      behave like a normal, content-neutral proxy. See
632 #      enable-remote-toggle below. This is not really useful anymore,
633 #      since toggling is much easier via the web interface then via
634 #      editing the conf file.
635 #     
636 #      The windows version will only display the toggle icon in the
637 #      system tray if this option is present.
638 #    
639
640 toggle 1
641
642
643 #  4.3. enable-remote-toggle
644 #  =========================
645 #  
646 #  Specifies:
647 #     
648 #      Whether or not the web-based toggle feature may be used
649 #     
650 #  Type of value:
651 #     
652 #      0 or 1
653 #     
654 #  Default value:
655 #     
656 #      1
657 #     
658 #  Effect if unset:
659 #     
660 #      The web-based toggle feature is disabled.
661 #     
662 #  Notes:
663 #     
664 #      When toggled off, Privoxy acts like a normal, content-neutral
665 #      proxy, i.e. it acts as if none of the actions applied to any
666 #      URL.
667 #     
668 #      For the time being, access to the toggle feature can not be
669 #      controlled separately by "ACLs" or HTTP authentication, so that
670 #      everybody who can access Privoxy (see "ACLs" and listen-address
671 #      above) can toggle it for all users. So this option is not
672 #      recommended for multi-user environments with untrusted users.
673 #     
674 #      Note that you must have compiled Privoxy with support for this
675 #      feature, otherwise this option has no effect.
676 #    
677 enable-remote-toggle 1
678
679
680 #  4.4. enable-edit-actions
681 #  ========================
682 #  
683 #  Specifies:
684 #     
685 #      Whether or not the web-based actions file editor may be used
686 #     
687 #  Type of value:
688 #     
689 #      0 or 1
690 #     
691 #  Default value:
692 #     
693 #      1
694 #     
695 #  Effect if unset:
696 #     
697 #      The web-based actions file editor is disabled.
698 #     
699 #  Notes:
700 #     
701 #      For the time being, access to the editor can not be controlled
702 #      separately by "ACLs" or HTTP authentication, so that everybody
703 #      who can access Privoxy (see "ACLs" and listen-address above) can
704 #      modify its configuration for all users. So this option is not
705 #      recommended for multi-user environments with untrusted users.
706 #     
707 #      Note that you must have compiled Privoxy with support for this
708 #      feature, otherwise this option has no effect.
709 #    
710 enable-edit-actions 1
711
712
713 #  4.5. ACLs: permit-access and deny-access
714 #  ========================================
715 #  
716 #  Specifies:
717 #     
718 #      Who can access what.
719 #     
720 #  Type of value:
721 #     
722 #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
723 #     
724 #      Where src_addr and dst_addr are IP addresses in dotted decimal
725 #      notation or valid DNS names, and src_masklen and dst_masklen are
726 #      subnet masks in CIDR notation, i.e. integer values from 2 to 32
727 #      representing the length (in bits) of the network address. The
728 #      masks and the whole destination part are optional.
729 #    
730 #  Default value:
731 #     
732 #      Unset
733 #     
734 #  Effect if unset:
735 #     
736 #      Don't restrict access further than implied by listen-address
737 #     
738 #  Notes:
739 #     
740 #      Access controls are included at the request of ISPs and systems
741 #      administrators, and are not usually needed by individual users.
742 #      For a typical home user, it will normally suffice to ensure that
743 #      Privoxy only listens on the localhost or internal (home) network
744 #      address by means of the listen-address option.
745 #     
746 #      Please see the warnings in the FAQ that this proxy is not
747 #      intended to be a substitute for a firewall or to encourage anyone
748 #      to defer addressing basic security weaknesses.
749 #     
750 #      Multiple ACL lines are OK. If any ACLs are specified, then the
751 #      Privoxy talks only to IP addresses that match at least one
752 #      permit-access line and don't match any subsequent deny-access
753 #      line. In other words, the last match wins, with the default being
754 #      deny-access.
755 #     
756 #      If Privoxy is using a forwarder (see forward below) for a
757 #      particular destination URL, the dst_addr that is examined is the
758 #      address of the forwarder and NOT the address of the ultimate
759 #      target. This is necessary because it may be impossible for the
760 #      local Privoxy to determine the IP address of the ultimate target
761 #      (that's often what gateways are used for).
762 #     
763 #      You should prefer using IP addresses over DNS names, because the
764 #      address lookups take time. All DNS names must resolve! You can
765 #      not use domain patterns like "*.org" or partial domain names. If
766 #      a DNS name resolves to multiple IP addresses, only the first one
767 #      is used.
768 #     
769 #      Denying access to particular sites by ACL may have undesired side
770 #      effects if the site in question is hosted on a machine which also
771 #      hosts other sites.
772 #     
773 #  Examples:
774 #     
775 #      Explicitly define the default behavior if no ACL and
776 #      listen-address are set: "localhost" is OK. The absence of a
777 #      dst_addr implies that all destination addresses are OK:
778 #     
779 #        permit-access  localhost                                         
780 #                                                                        
781 #    
782 #      Allow any host on the same class C subnet as www.privoxy.org
783 #      access to nothing but www.example.com:
784 #     
785 #        permit-access  www.privoxy.org/24 www.example.com/32             
786 #                                                                         
787 #     
788 #      Allow access from any host on the 26-bit subnet 192.168.45.64 to
789 #      anywhere, with the exception that 192.168.45.73 may not access
790 #      www.dirty-stuff.example.com:
791 #     
792 #        permit-access  192.168.45.64/26                                  
793 #        deny-access    192.168.45.73    www.dirty-stuff.example.com      
794 #                                                                        
795
796
797 #  4.6. buffer-limit
798 #  =================
799 #  
800 #  Specifies:
801 #     
802 #      Maximum size of the buffer for content filtering.
803 #     
804 #  Type of value:
805 #     
806 #      Size in Kbytes
807 #     
808 #  Default value:
809 #     
810 #      4096
811 #     
812 #  Effect if unset:
813 #     
814 #      Use a 4MB (4096 KB) limit.
815 #     
816 #  Notes:
817 #     
818 #      For content filtering, i.e. the +filter and +deanimate-gif
819 #      actions, it is necessary that Privoxy buffers the entire document
820 #      body. This can be potentially dangerous, since a server could
821 #      just keep sending data indefinitely and wait for your RAM to
822 #      exhaust -- with nasty consequences. Hence this option.
823 #     
824 #      When a document buffer size reaches the buffer-limit, it is
825 #      flushed to the client unfiltered and no further attempt to filter
826 #      the rest of the document is made. Remember that there may be
827 #      multiple threads running, which might require up to buffer-limit
828 #      Kbytes each, unless you have enabled "single-threaded" above.
829 #    
830 buffer-limit 4096
831
832
833 #  5. FORWARDING
834 #  =============
835 #  
836 #  This feature allows routing of HTTP requests through a chain of
837 #  multiple proxies. It can be used to better protect privacy and
838 #  confidentiality when accessing specific domains by routing requests
839 #  to those domains through an anonymous public proxy (see e.g.
840 #  http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
841 #  speed up browsing. Or chaining to a parent proxy may be necessary
842 #  because the machine that Privoxy runs on has no direct Internet
843 #  access.
844 #  
845 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
846 #  and SOCKS 4A protocols.
847
848
849
850 #  5.1. forward
851 #  ============
852 #
853 #  Specifies:
854 #     
855 #      To which parent HTTP proxy specific requests should be routed.
856 #     
857 #  Type of value:
858 #     
859 #      target_domain[:port] http_parent[:port]
860 #     
861 #      Where target_domain is a domain name pattern (see the chapter on
862 #      domain matching in the actions file), http_parent is the address
863 #      of the parent HTTP proxy as an IP addresses in dotted decimal
864 #      notation or as a valid DNS name (or "." to denote "no
865 #      forwarding", and the optional port parameters are TCP ports, i.e.
866 #      integer values from 1 to 64535
867 #     
868 #  Default value:
869 #     
870 #      Unset
871 #     
872 #  Effect if unset:
873 #     
874 #      Don't use parent HTTP proxies.
875 #     
876 #  Notes:
877 #     
878 #      If http_parent is ".", then requests are not forwarded to another
879 #      HTTP proxy but are made directly to the web servers.
880 #     
881 #      Multiple lines are OK, they are checked in sequence, and the last
882 #      match wins.
883 #     
884 #  Examples:
885 #    
886 #      Everything goes to an example anonymizing proxy, except SSL on
887 #      port 443 (which it doesn't handle):
888 #     
889 #        forward   .*     anon-proxy.example.org:8080                     
890 #        forward   :443   .                                               
891 #                                                                         
892 #     
893 #      Everything goes to our example ISP's caching proxy, except for
894 #      requests to that ISP's sites:
895 #     
896 #        forward   .*.                caching-proxy.example-isp.net:8000  
897 #        forward   .example-isp.net   .                                   
898 #                                                                         
899
900
901 #  5.2. forward-socks4 and forward-socks4a
902 #  =======================================
903 #
904 #  Specifies:
905 #     
906 #      Through which SOCKS proxy (and to which parent HTTP proxy)
907 #      specific requests should be routed.
908 #     
909 #  Type of value:
910 #     
911 #      target_domain[:port] socks_proxy[:port] http_parent[:port]
912 #     
913 #      Where target_domain is a domain name pattern (see the chapter on
914 #      domain matching in the actions file), http_parent and socks_proxy
915 #      are IP addresses in dotted decimal notation or valid DNS names
916 #      (http_parent may be "." to denote "no HTTP forwarding"), and the
917 #      optional port parameters are TCP ports, i.e. integer values from
918 #      1 to 64535
919 #     
920 #  Default value:
921 #     
922 #      Unset
923 #     
924 #  Effect if unset:
925 #     
926 #      Don't use SOCKS proxies.
927 #     
928 #  Notes:
929 #     
930 #      Multiple lines are OK, they are checked in sequence, and the last
931 #      match wins.
932 #     
933 #      The difference between forward-socks4 and forward-socks4a is that
934 #      in the SOCKS 4A protocol, the DNS resolution of the target
935 #      hostname happens on the SOCKS server, while in SOCKS 4 it happens
936 #      locally.
937 #    
938 #      If http_parent is ".", then requests are not forwarded to another
939 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
940 #      albeit through a SOCKS proxy.
941 #     
942 #  Examples:
943 #     
944 #      From the company example.com, direct connections are made to all
945 #      "internal" domains, but everything outbound goes through their
946 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
947 #      the Internet.
948 #     
949 #        forward-socks4a   .*.           socks-gw.example.com:1080  www-cache.example-isp.net:8080 
950 #        forward           .example.com   .
951 #                                                                                                  
952 #    
953 #      A rule that uses a SOCKS 4 gateway for all destinations but no
954 #      HTTP parent looks like this:
955 #     
956 #        forward-socks4   .*.            socks-gw.example.com:1080  .     
957 #                                                                         
958 #      See the user manual for more advanced examples.
959 #    
960
961
962 #  6. WINDOWS GUI OPTIONS
963 #  ======================
964 #  
965 #  Privoxy has a number of options specific to the Windows GUI
966 #  interface:
967 #  
968 #  If "activity-animation" is set to 1, the Privoxy icon will animate
969 #  when "Privoxy" is active. To turn off, set to 0.
970
971 #activity-animation 1
972
973 #  If "log-messages" is set to 1, Privoxy will log messages to the
974 #  console window:
975
976 #log-messages 1
977    
978 #  If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
979 #  the amount of memory used for the log messages displayed in the
980 #  console window, will be limited to "log-max-lines" (see below).
981 #  
982 #  Warning: Setting this to 0 will result in the buffer to grow
983 #  infinitely and eat up all your memory!
984
985 #log-buffer-size 1
986
987 #  log-max-lines is the maximum number of lines held in the log buffer.
988 #  See above.
989
990 #log-max-lines 200
991
992 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
993 #  portions of the log messages with a bold-faced font:
994
995 #log-highlight-messages 1
996 #    
997  
998 #  The font used in the console window:
999
1000 #log-font-name Comic Sans MS
1001 #    
1002  
1003 #  Font size used in the console window:
1004
1005 #log-font-size 8
1006 #    
1007  
1008 #  "show-on-task-bar" controls whether or not Privoxy will appear as a
1009 #  button on the Task bar when minimized:
1010
1011 #show-on-task-bar 0
1012 #    
1013  
1014 #  If "close-button-minimizes" is set to 1, the Windows close button
1015 #  will minimize Privoxy instead of closing the program (close with the
1016 #  exit option on the File menu).
1017
1018 #close-button-minimizes 1
1019 #    
1020  
1021 #  The "hide-console" option is specific to the MS-Win console version
1022 #  of Privoxy. If this option is used, Privoxy will disconnect from and
1023 #  hide the command console.
1024
1025 #hide-console
1026 #