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