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