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