Bump version only.
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy v3.0.10
2 #
3 #  $Id: config,v 1.65 2008/06/13 15:41:42 fabiankeil Exp $
4 #
5 #  Copyright (C) 2001-2008 Privoxy Developers http://www.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 Privoxy's main configuration. Privoxy detects
28 #  configuration changes automatically, so you don't have to restart
29 #  it unless you want to load a different configuration file.
30 #
31 #  The configuration will be reloaded with the first request after
32 #  the change was done, this request itself will still use the old
33 #  configuration, though. In other words: it takes two requests before
34 #  you see the result of your changes.  Requests that are dropped due
35 #  to ACL don't trigger reloads.
36 #
37 #  When starting Privoxy on Unix systems, give the location of this
38 #  file as last argument. On Windows systems, Privoxy will look for
39 #  this file with the name 'config.txt' in the current working directory
40 #  of the Privoxy process.
41 #
42 #
43 #  II. FORMAT OF THE CONFIGURATION FILE
44 #  ====================================
45 #
46 #  Configuration lines consist of an initial keyword followed by a
47 #  list of values, all separated by whitespace (any number of spaces
48 #  or tabs). For example,
49 #
50 #  actionsfile default.action
51 #
52 #  Indicates that the actionsfile is named 'default.action'.
53 #
54 #  The '#' indicates a comment. Any part of a line following a '#'
55 #  is ignored, except if the '#' is preceded by a '\'.
56 #
57 #  Thus, by placing a # at the start of an existing configuration
58 #  line, you can make it a comment and it will be treated as if it
59 #  weren't there. This is called "commenting out" an option and can
60 #  be useful. Removing the # again is called "uncommenting".
61 #
62 #  Note that commenting out an option and leaving it at its default
63 #  are two completely different things! Most options behave very
64 #  differently when unset.  See the "Effect if unset" explanation in
65 #  each option's description for details.
66 #
67 #  Long lines can be continued on the next line by using a `\' as the
68 #  last character.
69 #
70 #
71 #
72 #  1. LOCAL SET-UP DOCUMENTATION
73 #  ==============================
74 #
75 #  If you intend to operate Privoxy for more users than just yourself,
76 #  it might be a good idea to let them know how to reach you, what
77 #  you block and why you do that, your policies, etc.
78 #
79 #
80 #
81 #  1.1. user-manual
82 #  =================
83 #
84 #  Specifies:
85 #
86 #      Location of the Privoxy User Manual.
87 #
88 #  Type of value:
89 #
90 #      A fully qualified URI
91 #
92 #  Default value:
93 #
94 #      Unset
95 #
96 #  Effect if unset:
97 #
98 #      http://www.privoxy.org/version/user-manual/ will be used,
99 #      where version is the Privoxy version.
100 #
101 #  Notes:
102 #
103 #      The User Manual URI is the single best source of information on
104 #      Privoxy, and is used for help links from some of the internal
105 #      CGI pages. The manual itself is normally packaged with the
106 #      binary distributions, so you probably want to set this to a
107 #      locally installed copy.
108 #
109 #      Examples:
110 #
111 #      The best all purpose solution is simply to put the full local
112 #      PATH to where the User Manual is located:
113 #
114 #        user-manual  /usr/share/doc/privoxy/user-manual
115 #
116 #
117 #      The User Manual is then available to anyone with
118 #      access to Privoxy, by following the built-in URL:
119 #      http://config.privoxy.org/user-manual/ (or the shortcut:
120 #      http://p.p/user-manual/).
121 #
122 #      If the documentation is not on the local system, it can be
123 #      accessed from a remote server, as:
124 #
125 #        user-manual  http://example.com/privoxy/user-manual/
126 #
127 #
128 #      WARNING!!!
129 #
130 #          If set, this option should be the first option in the config
131 #          file, because it is used while the config file is being read.
132 #
133 #user-manual http://www.privoxy.org/user-manual/
134 #
135 #
136 #  1.2. trust-info-url
137 #  ====================
138 #
139 #  Specifies:
140 #
141 #      A URL to be displayed in the error page that users will see if
142 #      access to an untrusted page is denied.
143 #
144 #  Type of value:
145 #
146 #      URL
147 #
148 #  Default value:
149 #
150 #      Two example URLs are provided
151 #
152 #  Effect if unset:
153 #
154 #      No links are displayed on the "untrusted" error page.
155 #
156 #  Notes:
157 #
158 #      The value of this option only matters if the experimental trust
159 #      mechanism has been activated. (See trustfile below.)
160 #
161 #      If you use the trust mechanism, it is a good idea to write
162 #      up some on-line documentation about your trust policy and to
163 #      specify the URL(s) here. Use multiple times for multiple URLs.
164 #
165 #      The URL(s) should be added to the trustfile as well, so users
166 #      don't end up locked out from the information on why they were
167 #      locked out in the first place!
168 #
169 trust-info-url  http://www.example.com/why_we_block.html
170 trust-info-url  http://www.example.com/what_we_allow.html
171 #
172 #
173 #  1.3. admin-address
174 #  ===================
175 #
176 #  Specifies:
177 #
178 #      An email address to reach the Privoxy administrator.
179 #
180 #  Type of value:
181 #
182 #      Email address
183 #
184 #  Default value:
185 #
186 #      Unset
187 #
188 #  Effect if unset:
189 #
190 #      No email address is displayed on error pages and the CGI user
191 #      interface.
192 #
193 #  Notes:
194 #
195 #      If both admin-address and proxy-info-url are unset, the whole
196 #      "Local Privoxy Support" box on all generated pages will not
197 #      be shown.
198 #
199 #admin-address privoxy-admin@example.com
200 #
201 #
202 #  1.4. proxy-info-url
203 #  ====================
204 #
205 #  Specifies:
206 #
207 #      A URL to documentation about the local Privoxy setup,
208 #      configuration or policies.
209 #
210 #  Type of value:
211 #
212 #      URL
213 #
214 #  Default value:
215 #
216 #      Unset
217 #
218 #  Effect if unset:
219 #
220 #      No link to local documentation is displayed on error pages and
221 #      the CGI user interface.
222 #
223 #  Notes:
224 #
225 #      If both admin-address and proxy-info-url are unset, the whole
226 #      "Local Privoxy Support" box on all generated pages will not
227 #      be shown.
228 #
229 #      This URL shouldn't be blocked ;-)
230 #
231 #proxy-info-url http://www.example.com/proxy-service.html
232 #
233 #
234 #  2. CONFIGURATION AND LOG FILE LOCATIONS
235 #  ========================================
236 #
237 #  Privoxy can (and normally does) use a number of other files for
238 #  additional configuration, help and logging. This section of the
239 #  configuration file tells Privoxy where to find those other files.
240 #
241 #  The user running Privoxy, must have read permission for all
242 #  configuration files, and write permission to any files that would
243 #  be modified, such as log files and actions files.
244 #
245 #
246 #
247 #  2.1. confdir
248 #  =============
249 #
250 #  Specifies:
251 #
252 #      The directory where the other configuration files are located.
253 #
254 #  Type of value:
255 #
256 #      Path name
257 #
258 #  Default value:
259 #
260 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
261 #
262 #  Effect if unset:
263 #
264 #      Mandatory
265 #
266 #  Notes:
267 #
268 #      No trailing "/", please.
269 #
270 confdir .
271 #
272 #
273 #  2.2. templdir
274 #  ==============
275 #
276 #  Specifies:
277 #
278 #      An alternative directory where the templates are loaded from.
279 #
280 #  Type of value:
281 #
282 #      Path name
283 #
284 #  Default value:
285 #
286 #      unset
287 #
288 #  Effect if unset:
289 #
290 #      The templates are assumed to be located in confdir/template.
291 #
292 #  Notes:
293 #
294 #      Privoxy's original templates are usually overwritten with each
295 #      update. Use this option to relocate customized templates that
296 #      should be kept. As template variables might change between
297 #      updates, you shouldn't expect templates to work with Privoxy
298 #      releases other than the one they were part of, though.
299 #
300 #templdir .
301 #
302 #
303 #  2.3. logdir
304 #  ============
305 #
306 #  Specifies:
307 #
308 #      The directory where all logging takes place (i.e. where logfile
309 #      and jarfile are located).
310 #
311 #  Type of value:
312 #
313 #      Path name
314 #
315 #  Default value:
316 #
317 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
318 #
319 #  Effect if unset:
320 #
321 #      Mandatory
322 #
323 #  Notes:
324 #
325 #      No trailing "/", please.
326 #
327 logdir .
328 #
329 #
330 #  2.4. actionsfile
331 #  =================
332 #
333 #  Specifies:
334 #
335 #      The actions file(s) to use
336 #
337 #  Type of value:
338 #
339 #      Complete file name, relative to confdir
340 #
341 #  Default values:
342 #
343 #        standard.action     # Internal purposes, no editing recommended
344 #
345 #        default.action      # Main actions file
346 #
347 #        user.action         # User customizations
348 #
349 #  Effect if unset:
350 #
351 #      No actions are taken at all. More or less neutral proxying.
352 #
353 #  Notes:
354 #
355 #      Multiple actionsfile lines are permitted, and are in fact
356 #      recommended!
357 #
358 #      The default values include standard.action, which is used
359 #      for internal purposes and should be loaded, default.action,
360 #      which is the "main" actions file maintained by the developers,
361 #      and user.action, where you can make your personal additions.
362 #
363 #      Actions files contain all the per site and per URL configuration
364 #      for ad blocking, cookie management, privacy considerations,
365 #      etc. There is no point in using Privoxy without at least one
366 #      actions file.
367 #
368 #      Note that since Privoxy 3.0.7, the complete filename, including
369 #      the ".action" extension has to be specified. The syntax change
370 #      was necessary to be consistent with the other file options and
371 #      to allow previously forbidden characters.
372 #
373 actionsfile standard.action  # Internal purpose, recommended
374 actionsfile default.action   # Main actions file
375 actionsfile user.action      # User customizations
376 #
377 #
378 #  2.5. filterfile
379 #  ================
380 #
381 #  Specifies:
382 #
383 #      The filter file(s) to use
384 #
385 #  Type of value:
386 #
387 #      File name, relative to confdir
388 #
389 #  Default value:
390 #
391 #      default.filter (Unix) or default.filter.txt (Windows)
392 #
393 #  Effect if unset:
394 #
395 #      No textual content filtering takes place, i.e. all +filter{name}
396 #      actions in the actions files are turned neutral.
397 #
398 #  Notes:
399 #
400 #      Multiple filterfile lines are permitted.
401 #
402 #      The filter files contain content modification rules that use
403 #      regular expressions. These rules permit powerful changes on the
404 #      content of Web pages, and optionally the headers as well, e.g.,
405 #      you could try to disable your favorite JavaScript annoyances,
406 #      re-write the actual displayed text, or just have some fun
407 #      playing buzzword bingo with web pages.
408 #
409 #      The +filter{name} actions rely on the relevant filter (name)
410 #      to be defined in a filter file!
411 #
412 #      A pre-defined filter file called default.filter that contains a
413 #      number of useful filters for common problems is included in the
414 #      distribution. See the section on the filter action for a list.
415 #
416 #      It is recommended to place any locally adapted filters into a
417 #      separate file, such as user.filter.
418 #
419 filterfile default.filter
420 #filterfile user.filter      # User customizations
421 #
422 #
423 #  2.6. logfile
424 #  =============
425 #
426 #  Specifies:
427 #
428 #      The log file to use
429 #
430 #  Type of value:
431 #
432 #      File name, relative to logdir
433 #
434 #  Default value:
435 #
436 #      Unset (commented out). When activated: logfile (Unix) or
437 #      privoxy.log (Windows).
438 #
439 #  Effect if unset:
440 #
441 #      No logfile is written.
442 #
443 #  Notes:
444 #
445 #      The logfile is where all logging and error messages are
446 #      written. The level of detail and number of messages are set with
447 #      the debug option (see below).  The logfile can be useful for
448 #      tracking down a problem with Privoxy (e.g., it's not blocking
449 #      an ad you think it should block) and it can help you to monitor
450 #      what your browser is doing.
451 #
452 #      Depending on the debug options below, the logfile may be a
453 #      privacy risk if third parties can get access to it. As most
454 #      users will never look at it, Privoxy 3.0.7 and later only log
455 #      fatal errors by default.
456 #
457 #      For most troubleshooting purposes, you will have to change that,
458 #      please refer to the debugging section for details.
459 #
460 #      Your logfile will grow indefinitely, and you will probably
461 #      want to periodically remove it. On Unix systems, you can do
462 #      this with a cron job (see "man cron"). For Red Hat based Linux
463 #      distributions, a logrotate script has been included.
464 #
465 #      Any log files must be writable by whatever user Privoxy is
466 #      being run as (on Unix, default user id is "privoxy").
467 #
468 logfile logfile
469 #
470 #
471 #  2.7. jarfile
472 #  =============
473 #
474 #  Specifies:
475 #
476 #      The file to store intercepted cookies in
477 #
478 #  Type of value:
479 #
480 #      File name, relative to logdir
481 #
482 #  Default value:
483 #
484 #      Unset (commented out). When activated: jarfile (Unix) or
485 #      privoxy.jar (Windows).
486 #
487 #  Effect if unset:
488 #
489 #      Intercepted cookies are not stored in a dedicated log file.
490 #
491 #  Notes:
492 #
493 #      The jarfile may grow to ridiculous sizes over time.
494 #
495 #      If debug 8 (show header parsing) is enabled, cookies are also
496 #      written to the logfile with the rest of the headers. Therefore
497 #      this option isn't very useful and may be removed in future
498 #      releases. Please report to the developers if you are still
499 #      using it.
500 #
501 #jarfile jarfile
502 #
503 #
504 #  2.8. trustfile
505 #  ===============
506 #
507 #  Specifies:
508 #
509 #      The name of the trust file to use
510 #
511 #  Type of value:
512 #
513 #      File name, relative to confdir
514 #
515 #  Default value:
516 #
517 #      Unset (commented out). When activated: trust (Unix) or trust.txt
518 #      (Windows)
519 #
520 #  Effect if unset:
521 #
522 #      The entire trust mechanism is disabled.
523 #
524 #  Notes:
525 #
526 #      The trust mechanism is an experimental feature for building
527 #      white-lists and should be used with care. It is NOT recommended
528 #      for the casual user.
529 #
530 #      If you specify a trust file, Privoxy will only allow access to
531 #      sites that are specified in the trustfile. Sites can be listed
532 #      in one of two ways:
533 #
534 #      Prepending a ~ character limits access to this site only (and
535 #      any sub-paths within this site), e.g. ~www.example.com allows
536 #      access to ~www.example.com/ features/news.html, etc.
537 #
538 #      Or, you can designate sites as trusted referrers, by prepending
539 #      the name with a + character. The effect is that access to
540 #      untrusted sites will be granted -- but only if a link from
541 #      this trusted referrer was used to get there. The link target
542 #      will then be added to the "trustfile" so that future, direct
543 #      accesses will be granted. Sites added via this mechanism do
544 #      not become trusted referrers themselves (i.e. they are added
545 #      with a ~ designation). There is a limit of 512 such entries,
546 #      after which new entries will not be made.
547 #
548 #      If you use the + operator in the trust file, it may grow
549 #      considerably over time.
550 #
551 #      It is recommended that Privoxy be compiled with the
552 #      --disable-force, --disable-toggle and --disable-editor options,
553 #      if this feature is to be used.
554 #
555 #      Possible applications include limiting Internet access for
556 #      children.
557 #
558 #trustfile trust
559 #
560 #
561 #  3. DEBUGGING
562 #  =============
563 #
564 #  These options are mainly useful when tracing a problem. Note that
565 #  you might also want to invoke Privoxy with the --no-daemon command
566 #  line option when debugging.
567 #
568 #
569 #
570 #  3.1. debug
571 #  ===========
572 #
573 #  Specifies:
574 #
575 #      Key values that determine what information gets logged.
576 #
577 #  Type of value:
578 #
579 #      Integer values
580 #
581 #  Default value:
582 #
583 #      0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)
584 #
585 #  Effect if unset:
586 #
587 #      Default value is used (see above).
588 #
589 #  Notes:
590 #
591 #      The available debug levels are:
592 #
593 #        debug         1 # log each request destination (and the crunch reason if Privoxy intercepted the request)
594 #        debug         2 # show each connection status
595 #        debug         4 # show I/O status
596 #        debug         8 # show header parsing
597 #        debug        16 # log all data written to the network into the logfile
598 #        debug        32 # debug force feature
599 #        debug        64 # debug regular expression filters
600 #        debug       128 # debug redirects
601 #        debug       256 # debug GIF de-animation
602 #        debug       512 # Common Log Format
603 #        debug      1024 # Unused
604 #        debug      2048 # CGI user interface
605 #        debug      4096 # Startup banner and warnings.
606 #        debug      8192 # Non-fatal errors
607 #
608 #
609 #      To select multiple debug levels, you can either add them or
610 #      use multiple debug lines.
611 #
612 #      A debug level of 1 is informative because it will show you each
613 #      request as it happens. 1, 4096 and 8192 are recommended so that
614 #      you will notice when things go wrong. The other levels are
615 #      probably only of interest if you are hunting down a specific
616 #      problem. They can produce a hell of an output (especially 16).
617 #
618 #      Privoxy used to ship with the debug levels recommended above
619 #      enabled by default, but due to privacy concerns 3.0.7 and later
620 #      are configured to only log fatal errors.
621 #
622 #      If you are used to the more verbose settings, simply enable
623 #      the debug lines below again.
624 #
625 #      If you want to use pure CLF (Common Log Format), you should set
626 #      "debug 512" ONLY and not enable anything else.
627 #
628 #      Privoxy has a hard-coded limit for the length of log messages. If
629 #      it's reached, messages are logged truncated and marked with
630 #      "... [too long, truncated]".
631 #
632 #      Please don't file any support requests without trying to
633 #      reproduce the problem with increased debug level first. Once
634 #      you read the log messages, you may even be able to solve the
635 #      problem on your own.
636 #
637 #debug      1 # log each request destination (and the crunch reason if Privoxy intercepted the request)
638 #debug   4096 # Startup banner and warnings
639 #debug   8192 # Non-fatal errors
640 #
641 #
642 #  3.2. single-threaded
643 #  =====================
644 #
645 #  Specifies:
646 #
647 #      Whether to run only one server thread.
648 #
649 #  Type of value:
650 #
651 #      None
652 #
653 #  Default value:
654 #
655 #      Unset
656 #
657 #  Effect if unset:
658 #
659 #      Multi-threaded (or, where unavailable: forked) operation,
660 #      i.e. the ability to serve multiple requests simultaneously.
661 #
662 #  Notes:
663 #
664 #      This option is only there for debugging purposes. It will
665 #      drastically reduce performance.
666 #
667 #single-threaded
668 #
669 #
670 #  3.3. hostname
671 #  ==============
672 #
673 #  Specifies:
674 #
675 #      The hostname shown on the CGI pages.
676 #
677 #  Type of value:
678 #
679 #      Text
680 #
681 #  Default value:
682 #
683 #      Unset
684 #
685 #  Effect if unset:
686 #
687 #      The hostname provided by the operating system is used.
688 #
689 #  Notes:
690 #
691 #      On some misconfigured systems resolving the hostname fails or
692 #      takes too much time and slows Privoxy down. Setting a fixed
693 #      hostname works around the problem.
694 #
695 #      In other circumstances it might be desirable to show a hostname
696 #      other than the one returned by the operating system. For example
697 #      if the system has several different hostnames and you don't
698 #      want to use the first one.
699 #
700 #      Note that Privoxy does not validate the specified hostname value.
701 #
702 #hostname hostname.example.org
703 #
704 #
705 #  4. ACCESS CONTROL AND SECURITY
706 #  ===============================
707 #
708 #  This section of the config file controls the security-relevant
709 #  aspects of Privoxy's configuration.
710 #
711 #
712 #
713 #  4.1. listen-address
714 #  ====================
715 #
716 #  Specifies:
717 #
718 #      The IP address and TCP port on which Privoxy will listen for
719 #      client requests.
720 #
721 #  Type of value:
722 #
723 #      [IP-Address]:Port
724 #
725 #  Default value:
726 #
727 #      127.0.0.1:8118
728 #
729 #  Effect if unset:
730 #
731 #      Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
732 #      recommended for home users who run Privoxy on the same machine
733 #      as their browser.
734 #
735 #  Notes:
736 #
737 #      You will need to configure your browser(s) to this proxy address
738 #      and port.
739 #
740 #      If you already have another service running on port 8118, or
741 #      if you want to serve requests from other machines (e.g. on your
742 #      local network) as well, you will need to override the default.
743 #
744 #      If you leave out the IP address, Privoxy will bind to all
745 #      interfaces (addresses) on your machine and may become reachable
746 #      from the Internet. In that case, consider using access control
747 #      lists (ACL's, see below), and/or a firewall.
748 #
749 #      If you open Privoxy to untrusted users, you will also
750 #      want to make sure that the following actions are disabled:
751 #      enable-edit-actions and enable-remote-toggle
752 #
753 #  Example:
754 #
755 #      Suppose you are running Privoxy on a machine which has the
756 #      address 192.168.0.1 on your local private network (192.168.0.0)
757 #      and has another outside connection with a different address. You
758 #      want it to serve requests from inside only:
759 #
760 #        listen-address  192.168.0.1:8118
761 #
762 #
763 listen-address  127.0.0.1:8118
764 #
765 #
766 #  4.2. toggle
767 #  ============
768 #
769 #  Specifies:
770 #
771 #      Initial state of "toggle" status
772 #
773 #  Type of value:
774 #
775 #      1 or 0
776 #
777 #  Default value:
778 #
779 #      1
780 #
781 #  Effect if unset:
782 #
783 #      Act as if toggled on
784 #
785 #  Notes:
786 #
787 #      If set to 0, Privoxy will start in "toggled off" mode,
788 #      i.e. mostly behave like a normal, content-neutral proxy
789 #      with both ad blocking and content filtering disabled. See
790 #      enable-remote-toggle below.
791 #
792 #      The windows version will only display the toggle icon in the
793 #      system tray if this option is present.
794 #
795 toggle  1
796 #
797 #
798 #  4.3. enable-remote-toggle
799 #  ==========================
800 #
801 #  Specifies:
802 #
803 #      Whether or not the web-based toggle feature may be used
804 #
805 #  Type of value:
806 #
807 #      0 or 1
808 #
809 #  Default value:
810 #
811 #      0
812 #
813 #  Effect if unset:
814 #
815 #      The web-based toggle feature is disabled.
816 #
817 #  Notes:
818 #
819 #      When toggled off, Privoxy mostly acts like a normal,
820 #      content-neutral proxy, i.e. doesn't block ads or filter content.
821 #
822 #      Access to the toggle feature can not be controlled separately by
823 #      "ACLs" or HTTP authentication, so that everybody who can access
824 #      Privoxy (see "ACLs" and listen-address above) can toggle it
825 #      for all users. So this option is not recommended for multi-user
826 #      environments with untrusted users.
827 #
828 #      Note that malicious client side code (e.g Java) is also capable
829 #      of using this option.
830 #
831 #      As a lot of Privoxy users don't read documentation, this feature
832 #      is disabled by default.
833 #
834 #      Note that you must have compiled Privoxy with support for this
835 #      feature, otherwise this option has no effect.
836 #
837 enable-remote-toggle  0
838 #
839 #
840 #  4.4. enable-remote-http-toggle
841 #  ===============================
842 #
843 #  Specifies:
844 #
845 #      Whether or not Privoxy recognizes special HTTP headers to change
846 #      its behaviour.
847 #
848 #  Type of value:
849 #
850 #      0 or 1
851 #
852 #  Default value:
853 #
854 #      0
855 #
856 #  Effect if unset:
857 #
858 #      Privoxy ignores special HTTP headers.
859 #
860 #  Notes:
861 #
862 #      When toggled on, the client can change Privoxy's behaviour by
863 #      setting special HTTP headers. Currently the only supported
864 #      special header is "X-Filter: No", to disable filtering for
865 #      the ongoing request, even if it is enabled in one of the
866 #      action files.
867 #
868 #      This feature is disabled by default. If you are using Privoxy in
869 #      a environment with trusted clients, you may enable this feature
870 #      at your discretion. Note that malicious client side code (e.g
871 #      Java) is also capable of using this feature.
872 #
873 #      This option will be removed in future releases as it has been
874 #      obsoleted by the more general header taggers.
875 #
876 enable-remote-http-toggle  0
877 #
878 #
879 #  4.5. enable-edit-actions
880 #  =========================
881 #
882 #  Specifies:
883 #
884 #      Whether or not the web-based actions file editor may be used
885 #
886 #  Type of value:
887 #
888 #      0 or 1
889 #
890 #  Default value:
891 #
892 #      0
893 #
894 #  Effect if unset:
895 #
896 #      The web-based actions file editor is disabled.
897 #
898 #  Notes:
899 #
900 #      Access to the editor can not be controlled separately by
901 #      "ACLs" or HTTP authentication, so that everybody who can access
902 #      Privoxy (see "ACLs" and listen-address above) can modify its
903 #      configuration for all users.
904 #
905 #      This option is not recommended for environments with untrusted
906 #      users and as a lot of Privoxy users don't read documentation,
907 #      this feature is disabled by default.
908 #
909 #      Note that malicious client side code (e.g Java) is also capable
910 #      of using the actions editor and you shouldn't enable this
911 #      options unless you understand the consequences and are sure
912 #      your browser is configured correctly.
913 #
914 #      Note that you must have compiled Privoxy with support for this
915 #      feature, otherwise this option has no effect.
916 #
917 enable-edit-actions 0
918 #
919 #
920 #  4.6. enforce-blocks
921 #  ====================
922 #
923 #  Specifies:
924 #
925 #      Whether the user is allowed to ignore blocks and can "go there
926 #      anyway".
927 #
928 #  Type of value:
929 #
930 #      0 or 1
931 #
932 #  Default value:
933 #
934 #      0
935 #
936 #  Effect if unset:
937 #
938 #      Blocks are not enforced.
939 #
940 #  Notes:
941 #
942 #      Privoxy is mainly used to block and filter requests as a service
943 #      to the user, for example to block ads and other junk that clogs
944 #      the pipes.  Privoxy's configuration isn't perfect and sometimes
945 #      innocent pages are blocked. In this situation it makes sense to
946 #      allow the user to enforce the request and have Privoxy ignore
947 #      the block.
948 #
949 #      In the default configuration Privoxy's "Blocked" page contains
950 #      a "go there anyway" link to adds a special string (the force
951 #      prefix) to the request URL. If that link is used, Privoxy
952 #      will detect the force prefix, remove it again and let the
953 #      request pass.
954 #
955 #      Of course Privoxy can also be used to enforce a network
956 #      policy. In that case the user obviously should not be able to
957 #      bypass any blocks, and that's what the "enforce-blocks" option
958 #      is for. If it's enabled, Privoxy hides the "go there anyway"
959 #      link. If the user adds the force prefix by hand, it will not
960 #      be accepted and the circumvention attempt is logged.
961 #
962 #  Examples:
963 #
964 #      enforce-blocks 1
965 #
966 enforce-blocks 0
967 #
968 #
969 #  4.7. ACLs: permit-access and deny-access
970 #  =========================================
971 #
972 #  Specifies:
973 #
974 #      Who can access what.
975 #
976 #  Type of value:
977 #
978 #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
979 #
980 #      Where src_addr and dst_addr are IP addresses in dotted decimal
981 #      notation or valid DNS names, and src_masklen and dst_masklen are
982 #      subnet masks in CIDR notation, i.e. integer values from 2 to 30
983 #      representing the length (in bits) of the network address. The
984 #      masks and the whole destination part are optional.
985 #
986 #  Default value:
987 #
988 #      Unset
989 #
990 #  Effect if unset:
991 #
992 #      Don't restrict access further than implied by listen-address
993 #
994 #  Notes:
995 #
996 #      Access controls are included at the request of ISPs and systems
997 #      administrators, and are not usually needed by individual
998 #      users. For a typical home user, it will normally suffice to
999 #      ensure that Privoxy only listens on the localhost (127.0.0.1)
1000 #      or internal (home) network address by means of the listen-address
1001 #      option.
1002 #
1003 #      Please see the warnings in the FAQ that Privoxy is not intended
1004 #      to be a substitute for a firewall or to encourage anyone to
1005 #      defer addressing basic security weaknesses.
1006 #
1007 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1008 #      only talks to IP addresses that match at least one permit-access
1009 #      line and don't match any subsequent deny-access line. In other
1010 #      words, the last match wins, with the default being deny-access.
1011 #
1012 #      If Privoxy is using a forwarder (see forward below) for a
1013 #      particular destination URL, the dst_addr that is examined is
1014 #      the address of the forwarder and NOT the address of the ultimate
1015 #      target. This is necessary because it may be impossible for the
1016 #      local Privoxy to determine the IP address of the ultimate target
1017 #      (that's often what gateways are used for).
1018 #
1019 #      You should prefer using IP addresses over DNS names, because
1020 #      the address lookups take time. All DNS names must resolve! You
1021 #      can not use domain patterns like "*.org" or partial domain
1022 #      names. If a DNS name resolves to multiple IP addresses, only
1023 #      the first one is used.
1024 #
1025 #      Denying access to particular sites by ACL may have undesired
1026 #      side effects if the site in question is hosted on a machine
1027 #      which also hosts other sites (most sites are).
1028 #
1029 #  Examples:
1030 #
1031 #      Explicitly define the default behavior if no ACL and
1032 #      listen-address are set: "localhost" is OK. The absence of a
1033 #      dst_addr implies that all destination addresses are OK:
1034 #
1035 #        permit-access  localhost
1036 #
1037 #
1038 #      Allow any host on the same class C subnet as www.privoxy.org
1039 #      access to nothing but www.example.com (or other domains hosted
1040 #      on the same system):
1041 #
1042 #        permit-access  www.privoxy.org/24 www.example.com/32
1043 #
1044 #
1045 #      Allow access from any host on the 26-bit subnet 192.168.45.64 to
1046 #      anywhere, with the exception that 192.168.45.73 may not access
1047 #      the IP address behind www.dirty-stuff.example.com:
1048 #
1049 #        permit-access  192.168.45.64/26 
1050 #        deny-access   192.168.45.73  www.dirty-stuff.example.com
1051 #
1052 #
1053 #
1054 #  4.8. buffer-limit
1055 #  ==================
1056 #
1057 #  Specifies:
1058 #
1059 #      Maximum size of the buffer for content filtering.
1060 #
1061 #  Type of value:
1062 #
1063 #      Size in Kbytes
1064 #
1065 #  Default value:
1066 #
1067 #      4096
1068 #
1069 #  Effect if unset:
1070 #
1071 #      Use a 4MB (4096 KB) limit.
1072 #
1073 #  Notes:
1074 #
1075 #      For content filtering, i.e. the +filter and +deanimate-gif
1076 #      actions, it is necessary that Privoxy buffers the entire document
1077 #      body. This can be potentially dangerous, since a server could
1078 #      just keep sending data indefinitely and wait for your RAM to
1079 #      exhaust -- with nasty consequences.  Hence this option.
1080 #
1081 #      When a document buffer size reaches the buffer-limit, it is
1082 #      flushed to the client unfiltered and no further attempt to filter
1083 #      the rest of the document is made. Remember that there may be
1084 #      multiple threads running, which might require up to buffer-limit
1085 #      Kbytes each, unless you have enabled "single-threaded" above.
1086 #
1087 buffer-limit 4096
1088 #
1089 #
1090 #  5. FORWARDING
1091 #  ==============
1092 #
1093 #  This feature allows routing of HTTP requests through a chain of
1094 #  multiple proxies.
1095 #
1096 #  Forwarding can be used to chain Privoxy with a caching proxy to
1097 #  speed up browsing. Using a parent proxy may also be necessary if
1098 #  the machine that Privoxy runs on has no direct Internet access.
1099 #
1100 #  Note that parent proxies can severely decrease your privacy
1101 #  level. For example a parent proxy could add your IP address to the
1102 #  request headers and if it's a caching proxy it may add the "Etag"
1103 #  header to revalidation requests again, even though you configured
1104 #  Privoxy to remove it. It may also ignore Privoxy's header time
1105 #  randomization and use the original values which could be used by
1106 #  the server as cookie replacement to track your steps between visits.
1107 #
1108 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1109 #  4 and SOCKS 4A protocols.
1110 #
1111 #
1112 #
1113 #  5.1. forward
1114 #  =============
1115 #
1116 #  Specifies:
1117 #
1118 #      To which parent HTTP proxy specific requests should be routed.
1119 #
1120 #  Type of value:
1121 #
1122 #      target_pattern http_parent[:port]
1123 #
1124 #      where target_pattern is a URL pattern that specifies to which
1125 #      requests (i.e. URLs) this forward rule shall apply. Use /
1126 #      to denote "all URLs".  http_parent[:port] is the DNS name or
1127 #      IP address of the parent HTTP proxy through which the requests
1128 #      should be forwarded, optionally followed by its listening port
1129 #      (default: 8080). Use a single dot (.) to denote "no forwarding".
1130 #
1131 #  Default value:
1132 #
1133 #      Unset
1134 #
1135 #  Effect if unset:
1136 #
1137 #      Don't use parent HTTP proxies.
1138 #
1139 #  Notes:
1140 #
1141 #      If http_parent is ".", then requests are not forwarded to
1142 #      another HTTP proxy but are made directly to the web servers.
1143 #
1144 #      Multiple lines are OK, they are checked in sequence, and the
1145 #      last match wins.
1146 #
1147 #  Examples:
1148 #
1149 #      Everything goes to an example parent proxy, except SSL on port
1150 #      443 (which it doesn't handle):
1151 #
1152 #        forward   /      parent-proxy.example.org:8080 
1153 #        forward   :443   .
1154 #
1155 #
1156 #      Everything goes to our example ISP's caching proxy, except for
1157 #      requests to that ISP's sites:
1158 #
1159 #        forward   /                  caching-proxy.isp.example.net:8000
1160 #        forward   .isp.example.net   .
1161 #
1162 #
1163 #
1164 #
1165 #  5.2. forward-socks4, forward-socks4a and forward-socks5
1166 #  ========================================================
1167 #
1168 #  Specifies:
1169 #
1170 #      Through which SOCKS proxy (and optionally to which parent HTTP
1171 #      proxy) specific requests should be routed.
1172 #
1173 #  Type of value:
1174 #
1175 #      target_pattern socks_proxy[:port] http_parent[:port]
1176 #
1177 #      where target_pattern is a URL pattern that specifies to which
1178 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1179 #      denote "all URLs".  http_parent and socks_proxy are IP addresses
1180 #      in dotted decimal notation or valid DNS names (http_parent may
1181 #      be "." to denote "no HTTP forwarding"), and the optional port
1182 #      parameters are TCP ports, i.e. integer values from 1 to 65535
1183 #
1184 #  Default value:
1185 #
1186 #      Unset
1187 #
1188 #  Effect if unset:
1189 #
1190 #      Don't use SOCKS proxies.
1191 #
1192 #  Notes:
1193 #
1194 #      Multiple lines are OK, they are checked in sequence, and the
1195 #      last match wins.
1196 #
1197 #      The difference between forward-socks4 and forward-socks4a
1198 #      is that in the SOCKS 4A protocol, the DNS resolution of the
1199 #      target hostname happens on the SOCKS server, while in SOCKS 4
1200 #      it happens locally.
1201 #
1202 #      With forward-socks5 the DNS resolution will happen on the remote
1203 #      server as well.
1204 #
1205 #      If http_parent is ".", then requests are not forwarded to another
1206 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
1207 #      albeit through a SOCKS proxy.
1208 #
1209 #  Examples:
1210 #
1211 #      From the company example.com, direct connections are made to all
1212 #      "internal" domains, but everything outbound goes through their
1213 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
1214 #      to the Internet.
1215 #
1216 #        forward-socks4a   /       socks-gw.example.com:1080    www-cache.isp.example.net:8080 
1217 #        forward           .example.com        .
1218 #
1219 #
1220 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1221 #      HTTP parent looks like this:
1222 #
1223 #        forward-socks4   /               socks-gw.example.com:1080  .
1224 #
1225 #
1226 #      To chain Privoxy and Tor, both running on the same system,
1227 #      you would use something like:
1228 #
1229 #        forward-socks4a   /               127.0.0.1:9050 .
1230 #
1231 #
1232 #      The public Tor network can't be used to reach your local network,
1233 #      if you need to access local servers you therefore might want
1234 #      to make some exceptions:
1235 #
1236 #        forward         192.168.*.*/     .  
1237 #        forward         10.*.*.*/        .  
1238 #        forward         127.*.*.*/       .
1239 #
1240 #
1241 #      Unencrypted connections to systems in these address ranges will
1242 #      be as (un) secure as the local network is, but the alternative
1243 #      is that you can't reach the local network through Privoxy at
1244 #      all. Of course this may actually be desired and there is no
1245 #      reason to make these exceptions if you aren't sure you need them.
1246 #
1247 #      If you also want to be able to reach servers in your local
1248 #      network by using their names, you will need additional exceptions
1249 #      that look like this:
1250 #
1251 #       forward           localhost/     .
1252 #
1253 #
1254 #
1255 #
1256 #  5.3. forwarded-connect-retries
1257 #  ===============================
1258 #
1259 #  Specifies:
1260 #
1261 #      How often Privoxy retries if a forwarded connection request
1262 #      fails.
1263 #
1264 #  Type of value:
1265 #
1266 #      Number of retries.
1267 #
1268 #  Default value:
1269 #
1270 #      0
1271 #
1272 #  Effect if unset:
1273 #
1274 #      Connections forwarded through other proxies are treated like
1275 #      direct connections and no retry attempts are made.
1276 #
1277 #  Notes:
1278 #
1279 #      forwarded-connect-retries is mainly interesting for socks4a
1280 #      connections, where Privoxy can't detect why the connections
1281 #      failed. The connection might have failed because of a DNS timeout
1282 #      in which case a retry makes sense, but it might also have failed
1283 #      because the server doesn't exist or isn't reachable. In this
1284 #      case the retry will just delay the appearance of Privoxy's
1285 #      error message.
1286 #
1287 #      Note that in the context of this option, "forwarded connections"
1288 #      includes all connections that Privoxy forwards through other
1289 #      proxies. This option is not limited to the HTTP CONNECT method.
1290 #
1291 #      Only use this option, if you are getting lots of
1292 #      forwarding-related error messages that go away when you try again
1293 #      manually. Start with a small value and check Privoxy's logfile
1294 #      from time to time, to see how many retries are usually needed.
1295 #
1296 #  Examples:
1297 #
1298 #      forwarded-connect-retries 1
1299 #
1300 forwarded-connect-retries  0
1301 #
1302 #
1303 #  5.4. accept-intercepted-requests
1304 #  =================================
1305 #
1306 #  Specifies:
1307 #
1308 #      Whether intercepted requests should be treated as valid.
1309 #
1310 #  Type of value:
1311 #
1312 #      0 or 1
1313 #
1314 #  Default value:
1315 #
1316 #      0
1317 #
1318 #  Effect if unset:
1319 #
1320 #      Only proxy requests are accepted, intercepted requests are
1321 #      treated as invalid.
1322 #
1323 #  Notes:
1324 #
1325 #      If you don't trust your clients and want to force them to use
1326 #      Privoxy, enable this option and configure your packet filter
1327 #      to redirect outgoing HTTP connections into Privoxy.
1328 #
1329 #      Make sure that Privoxy's own requests aren't redirected as well.
1330 #      Additionally take care that Privoxy can't intentionally connect
1331 #      to itself, otherwise you could run into redirection loops if
1332 #      Privoxy's listening port is reachable by the outside or an
1333 #      attacker has access to the pages you visit.
1334 #
1335 #  Examples:
1336 #
1337 #      accept-intercepted-requests 1
1338 #
1339 accept-intercepted-requests 0
1340 #
1341 #
1342 #  5.5. allow-cgi-request-crunching
1343 #  =================================
1344 #
1345 #  Specifies:
1346 #
1347 #      Whether requests to Privoxy's CGI pages can be blocked or
1348 #      redirected.
1349 #
1350 #  Type of value:
1351 #
1352 #      0 or 1
1353 #
1354 #  Default value:
1355 #
1356 #      0
1357 #
1358 #  Effect if unset:
1359 #
1360 #      Privoxy ignores block and redirect actions for its CGI pages.
1361 #
1362 #  Notes:
1363 #
1364 #      By default Privoxy ignores block or redirect actions for
1365 #      its CGI pages.  Intercepting these requests can be useful in
1366 #      multi-user setups to implement fine-grained access control,
1367 #      but it can also render the complete web interface useless and
1368 #      make debugging problems painful if done without care.
1369 #
1370 #      Don't enable this option unless you're sure that you really
1371 #      need it.
1372 #
1373 #  Examples:
1374 #
1375 #      allow-cgi-request-crunching 1
1376 #
1377 allow-cgi-request-crunching 0
1378 #
1379 #
1380 #  5.6. split-large-forms
1381 #  =======================
1382 #
1383 #  Specifies:
1384 #
1385 #      Whether the CGI interface should stay compatible with broken
1386 #      HTTP clients.
1387 #
1388 #  Type of value:
1389 #
1390 #      0 or 1
1391 #
1392 #  Default value:
1393 #
1394 #      0
1395 #
1396 #  Effect if unset:
1397 #
1398 #      The CGI form generate long GET URLs.
1399 #
1400 #  Notes:
1401 #
1402 #      Privoxy's CGI forms can lead to rather long URLs. This isn't
1403 #      a problem as far as the HTTP standard is concerned, but it can
1404 #      confuse clients with arbitrary URL length limitations.
1405 #
1406 #      Enabling split-large-forms causes Privoxy to divide big forms
1407 #      into smaller ones to keep the URL length down. It makes editing
1408 #      a lot less convenient and you can no longer submit all changes
1409 #      at once, but at least it works around this browser bug.
1410 #
1411 #      If you don't notice any editing problems, there is no reason
1412 #      to enable this option, but if one of the submit buttons appears
1413 #      to be broken, you should give it a try.
1414 #
1415 #  Examples:
1416 #
1417 #      split-large-forms 1
1418 #
1419 split-large-forms 0
1420 #
1421 #
1422 #  6. WINDOWS GUI OPTIONS
1423 #  =======================
1424 #
1425 #  Privoxy has a number of options specific to the Windows GUI
1426 #  interface:
1427 #
1428 #
1429 #  If "activity-animation" is set to 1, the Privoxy icon will animate
1430 #  when "Privoxy" is active. To turn off, set to 0.
1431 #
1432 #activity-animation   1
1433 #
1434 #  If "log-messages" is set to 1, Privoxy will log messages to the
1435 #  console window:
1436 #
1437 #log-messages   1
1438 #
1439 #  If "log-buffer-size" is set to 1, the size of the log buffer,
1440 #  i.e. the amount of memory used for the log messages displayed in
1441 #  the console window, will be limited to "log-max-lines" (see below).
1442 #
1443 #  Warning: Setting this to 0 will result in the buffer to grow
1444 #  infinitely and eat up all your memory!
1445 #
1446 #log-buffer-size 1
1447 #
1448 #  log-max-lines is the maximum number of lines held in the log
1449 #  buffer. See above.
1450 #
1451 #log-max-lines 200
1452 #
1453 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
1454 #  portions of the log messages with a bold-faced font:
1455 #
1456 #log-highlight-messages 1
1457 #
1458 #  The font used in the console window:
1459 #
1460 #log-font-name Comic Sans MS
1461 #
1462 #  Font size used in the console window:
1463 #
1464 #log-font-size 8
1465 #
1466 #  "show-on-task-bar" controls whether or not Privoxy will appear as
1467 #  a button on the Task bar when minimized:
1468 #
1469 #show-on-task-bar 0
1470 #
1471 #  If "close-button-minimizes" is set to 1, the Windows close button
1472 #  will minimize Privoxy instead of closing the program (close with
1473 #  the exit option on the File menu).
1474 #
1475 #close-button-minimizes 1
1476 #
1477 #  The "hide-console" option is specific to the MS-Win console version
1478 #  of Privoxy.  If this option is used, Privoxy will disconnect from
1479 #  and hide the command console.
1480 #
1481 #hide-console
1482 #
1483 #