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