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