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