Include recent changes.
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy v3.0.7
2 #
3 #  $Id: config,v 1.59 2007/11/15 02:46:31 hal9 Exp $
4 #
5 #  Copyright (C) 2001-2007 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 /home/halb/privoxy/share/doc/privoxy/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 /home/halb/privoxy/etc
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 /home/halb/privoxy/var/log/privoxy
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 #      Logging is disabled unless --no-daemon mode is used.
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 privacy
441 #      risk if third parties can get access to it. As most users will never
442 #      look at it, Privoxy 3.0.7 and later only log fatal errors by default.
443 #
444 #      For most troubleshooting purposes, you will have to change that, please
445 #      refer to the debugging section for details.
446 #
447 #      Your logfile will grow indefinitely, and you will probably
448 #      want to periodically remove it. On Unix systems, you can do
449 #      this with a cron job (see "man cron"). For Red Hat based Linux
450 #      distributions, a logrotate script has been included.
451 #
452 #      Any log files must be writable by whatever user Privoxy is
453 #      being run as (on Unix, default user id is "privoxy").
454 #
455 #logfile logfile
456 #
457 #
458 #  2.7. jarfile
459 #
460 #  Specifies:
461 #
462 #      The file to store intercepted cookies in
463 #
464 #  Type of value:
465 #
466 #      File name, relative to logdir
467 #
468 #  Default value:
469 #
470 #      Unset (commented out). When activated: jarfile (Unix) or
471 #      privoxy.jar (Windows).
472 #
473 #  Effect if unset:
474 #
475 #      Intercepted cookies are not stored in a dedicated log file.
476 #
477 #  Notes:
478 #
479 #      The jarfile may grow to ridiculous sizes over time.
480 #
481 #      If debug 8 (show header parsing) is enabled, cookies are also
482 #      written to the logfile with the rest of the headers. Therefore
483 #      this option isn't very useful and may be removed in future
484 #      releases. Please report to the developers if you are still
485 #      using it.
486 #
487 #jarfile jarfile
488 #
489 #
490 #  2.8. trustfile
491 #
492 #  Specifies:
493 #
494 #      The name of the trust file to use
495 #
496 #  Type of value:
497 #
498 #      File name, relative to confdir
499 #
500 #  Default value:
501 #
502 #      Unset (commented out). When activated: trust (Unix) or trust.txt
503 #      (Windows)
504 #
505 #  Effect if unset:
506 #
507 #      The entire trust mechanism is disabled.
508 #
509 #  Notes:
510 #
511 #      The trust mechanism is an experimental feature for building
512 #      white-lists and should be used with care. It is NOT recommended
513 #      for the casual user.
514 #
515 #      If you specify a trust file, Privoxy will only allow access to
516 #      sites that are specified in the trustfile. Sites can be listed
517 #      in one of two ways:
518 #
519 #      Prepending a ~ character limits access to this site only (and
520 #      any sub-paths within this site), e.g. ~www.example.com allows
521 #      access to ~www.example.com/ features/news.html, etc.
522 #
523 #      Or, you can designate sites as trusted referrers, by prepending
524 #      the name with a + character. The effect is that access to
525 #      untrusted sites will be granted -- but only if a link from
526 #      this trusted referrer was used to get there. The link target
527 #      will then be added to the "trustfile" so that future, direct
528 #      accesses will be granted. Sites added via this mechanism do
529 #      not become trusted referrers themselves (i.e. they are added
530 #      with a ~ designation). There is a limit of 512 such entries,
531 #      after which new entries will not be made.
532 #
533 #      If you use the + operator in the trust file, it may grow
534 #      considerably over time.
535 #
536 #      It is recommended that Privoxy be compiled with the
537 #      --disable-force, --disable-toggle and --disable-editor options,
538 #      if this feature is to be used.
539 #
540 #      Possible applications include limiting Internet access for
541 #      children.
542 #
543 #trustfile trust
544 #
545 #
546 #  3. DEBUGGING
547 #
548 #  These options are mainly useful when tracing a problem. Note that
549 #  you might also want to invoke Privoxy with the --no-daemon command
550 #  line option when debugging.
551 #
552 #
553 #
554 #  3.1. debug
555 #
556 #  Specifies:
557 #
558 #      Key values that determine what information gets logged to
559 #      the logfile.
560 #
561 #  Type of value:
562 #
563 #      Integer values
564 #
565 #  Default value:
566 #
567 #      12289 (i.e.: URLs plus informational and warning messages)
568 #
569 #  Effect if unset:
570 #
571 #      Nothing gets logged.
572 #
573 #  Notes:
574 #
575 #      The available debug levels are:
576 #
577 #        debug         1 # show each GET/POST/CONNECT 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 # debug kill pop-ups 
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 you
598 #      will notice when things go wrong. The other levels are probably only
599 #      of interest if you are hunting down a specific problem. They can
600 #      produce a hell of an output (especially 16).
601 #
602 #      Privoxy used to ship with the debug levels recommended above enabled
603 #      by default, but due to privacy concerns 3.0.7 and later are
604 #      configured to only log fatal errors.
605
606 #      If you are used to the more verbose settings, simply enable the debug
607 #      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 reproduce
617 #      the problem with increased debug level first. Once you read the log
618 #      messages, you may even be able to solve the problem on your own.
619 #
620 #debug   1    # show each GET/POST/CONNECT request
621 #debug   4096 # Startup banner and warnings
622 #debug   8192 # Errors - *we highly recommended enabling this*
623 #
624 #
625 #  3.2. single-threaded
626 #
627 #  Specifies:
628 #
629 #      Whether to run only one server thread.
630 #
631 #  Type of value:
632 #
633 #      None
634 #
635 #  Default value:
636 #
637 #      Unset
638 #
639 #  Effect if unset:
640 #
641 #      Multi-threaded (or, where unavailable: forked) operation,
642 #      i.e. the ability to serve multiple requests simultaneously.
643 #
644 #  Notes:
645 #
646 #      This option is only there for debugging purposes. It will
647 #      drastically reduce performance.
648 #
649 #single-threaded
650 #
651 #
652 #  4. ACCESS CONTROL AND SECURITY
653 #
654 #  This section of the config file controls the security-relevant
655 #  aspects of Privoxy's configuration.
656 #
657 #
658 #
659 #  4.1. listen-address
660 #
661 #  Specifies:
662 #
663 #      The IP address and TCP port on which Privoxy will listen for
664 #      client requests.
665 #
666 #  Type of value:
667 #
668 #      [IP-Address]:Port
669 #
670 #  Default value:
671 #
672 #      127.0.0.1:8118
673 #
674 #  Effect if unset:
675 #
676 #      Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
677 #      recommended for home users who run Privoxy on the same machine
678 #      as their browser.
679 #
680 #  Notes:
681 #
682 #      You will need to configure your browser(s) to this proxy address
683 #      and port.
684 #
685 #      If you already have another service running on port 8118, or
686 #      if you want to serve requests from other machines (e.g. on your
687 #      local network) as well, you will need to override the default.
688 #
689 #      If you leave out the IP address, Privoxy will bind to all
690 #      interfaces (addresses) on your machine and may become reachable
691 #      from the Internet. In that case, consider using access control
692 #      lists (ACL's, see below), and/or a firewall.
693 #
694 #      If you open Privoxy to untrusted users, you will also
695 #      want to make sure that the following actions are disabled:
696 #      enable-edit-actions and enable-remote-toggle
697 #
698 #  Example:
699 #
700 #      Suppose you are running Privoxy on a machine which has the
701 #      address 192.168.0.1 on your local private network (192.168.0.0)
702 #      and has another outside connection with a different address. You
703 #      want it to serve requests from inside only:
704 #
705 #        listen-address  192.168.0.1:8118
706 #
707 #
708 listen-address  127.0.0.1:8118
709 #
710 #
711 #  4.2. toggle
712 #
713 #  Specifies:
714 #
715 #      Initial state of "toggle" status
716 #
717 #  Type of value:
718 #
719 #      1 or 0
720 #
721 #  Default value:
722 #
723 #      1
724 #
725 #  Effect if unset:
726 #
727 #      Act as if toggled on
728 #
729 #  Notes:
730 #
731 #      If set to 0, Privoxy will start in "toggled off" mode,
732 #      i.e. mostly behave like a normal, content-neutral proxy
733 #      with both ad blocking and content filtering disabled. See
734 #      enable-remote-toggle below.
735 #
736 #      The windows version will only display the toggle icon in the
737 #      system tray if this option is present.
738 #
739 toggle  1
740 #
741 #
742 #  4.3. enable-remote-toggle
743 #
744 #  Specifies:
745 #
746 #      Whether or not the web-based toggle feature may be used
747 #
748 #  Type of value:
749 #
750 #      0 or 1
751 #
752 #  Default value:
753 #
754 #      0
755 #
756 #  Effect if unset:
757 #
758 #      The web-based toggle feature is disabled.
759 #
760 #  Notes:
761 #
762 #      When toggled off, Privoxy mostly acts like a normal,
763 #      content-neutral proxy, i.e. doesn't block ads or filter content.
764 #
765 #      Access to the toggle feature can not be controlled separately by
766 #      "ACLs" or HTTP authentication, so that everybody who can access
767 #      Privoxy (see "ACLs" and listen-address above) can toggle it
768 #      for all users. So this option is not recommended for multi-user
769 #      environments with untrusted users.
770 #
771 #      Note that malicious client side code (e.g Java) is also capable
772 #      of using this option.
773 #
774 #      As a lot of Privoxy users don't read documentation, this feature
775 #      is disabled by default.
776 #
777 #      Note that you must have compiled Privoxy with support for this
778 #      feature, otherwise this option has no effect.
779 #
780 enable-remote-toggle  0
781 #
782 #
783 #  4.4. enable-remote-http-toggle
784 #
785 #  Specifies:
786 #
787 #      Whether or not Privoxy recognizes special HTTP headers to change
788 #      its behaviour.
789 #
790 #  Type of value:
791 #
792 #      0 or 1
793 #
794 #  Default value:
795 #
796 #      0
797 #
798 #  Effect if unset:
799 #
800 #      Privoxy ignores special HTTP headers.
801 #
802 #  Notes:
803 #
804 #      When toggled on, the client can change Privoxy's behaviour by
805 #      setting special HTTP headers. Currently the only supported
806 #      special header is "X-Filter: No", to disable filtering for
807 #      the ongoing request, even if it is enabled in one of the
808 #      action files.
809 #
810 #      This feature is disabled by default. If you are using Privoxy in
811 #      a environment with trusted clients, you may enable this feature
812 #      at your discretion. Note that malicious client side code (e.g
813 #      Java) is also capable of using this feature.
814 #
815 #      This option will be removed in future releases as it has been
816 #      obsoleted by the more general header taggers.
817 #
818 enable-remote-http-toggle  0
819 #
820 #
821 #  4.5. enable-edit-actions
822 #
823 #  Specifies:
824 #
825 #      Whether or not the web-based actions file editor may be used
826 #
827 #  Type of value:
828 #
829 #      0 or 1
830 #
831 #  Default value:
832 #
833 #      0
834 #
835 #  Effect if unset:
836 #
837 #      The web-based actions file editor is disabled.
838 #
839 #  Notes:
840 #
841 #      Access to the editor can not be controlled separately by
842 #      "ACLs" or HTTP authentication, so that everybody who can access
843 #      Privoxy (see "ACLs" and listen-address above) can modify its
844 #      configuration for all users.
845 #
846 #      This option is not recommended for environments with untrusted
847 #      users and as a lot of Privoxy users don't read documentation,
848 #      this feature is disabled by default.
849 #
850 #      Note that malicious client side code (e.g Java) is also capable
851 #      of using the actions editor and you shouldn't enable this
852 #      options unless you understand the consequences and are sure
853 #      your browser is configured correctly.
854 #
855 #      Note that you must have compiled Privoxy with support for this
856 #      feature, otherwise this option has no effect.
857 #
858 enable-edit-actions 0
859 #
860 #
861 #  4.6. enforce-blocks
862 #
863 #  Specifies:
864 #
865 #      Whether the user is allowed to ignore blocks and can "go there
866 #      anyway".
867 #
868 #  Type of value:
869 #
870 #      0 or 1
871 #
872 #  Default value:
873 #
874 #      0
875 #
876 #  Effect if unset:
877 #
878 #      Blocks are not enforced.
879 #
880 #  Notes:
881 #
882 #      Privoxy is mainly used to block and filter requests as a service
883 #      to the user, for example to block ads and other junk that clogs
884 #      the pipes.  Privoxy's configuration isn't perfect and sometimes
885 #      innocent pages are blocked. In this situation it makes sense to
886 #      allow the user to enforce the request and have Privoxy ignore
887 #      the block.
888 #
889 #      In the default configuration Privoxy's "Blocked" page contains
890 #      a "go there anyway" link to adds a special string (the force
891 #      prefix) to the request URL. If that link is used, Privoxy
892 #      will detect the force prefix, remove it again and let the
893 #      request pass.
894 #
895 #      Of course Privoxy can also be used to enforce a network
896 #      policy. In that case the user obviously should not be able to
897 #      bypass any blocks, and that's what the "enforce-blocks" option
898 #      is for. If it's enabled, Privoxy hides the "go there anyway"
899 #      link. If the user adds the force prefix by hand, it will not
900 #      be accepted and the circumvention attempt is logged.
901 #
902 #  Examples:
903 #
904 #      enforce-blocks 1
905 #
906 enforce-blocks 0
907 #
908 #
909 #  4.7. ACLs: permit-access and deny-access
910 #
911 #  Specifies:
912 #
913 #      Who can access what.
914 #
915 #  Type of value:
916 #
917 #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
918 #
919 #      Where src_addr and dst_addr are IP addresses in dotted decimal
920 #      notation or valid DNS names, and src_masklen and dst_masklen are
921 #      subnet masks in CIDR notation, i.e. integer values from 2 to 30
922 #      representing the length (in bits) of the network address. The
923 #      masks and the whole destination part are optional.
924 #
925 #  Default value:
926 #
927 #      Unset
928 #
929 #  Effect if unset:
930 #
931 #      Don't restrict access further than implied by listen-address
932 #
933 #  Notes:
934 #
935 #      Access controls are included at the request of ISPs and systems
936 #      administrators, and are not usually needed by individual
937 #      users. For a typical home user, it will normally suffice to
938 #      ensure that Privoxy only listens on the localhost (127.0.0.1)
939 #      or internal (home) network address by means of the listen-address
940 #      option.
941 #
942 #      Please see the warnings in the FAQ that Privoxy is not intended
943 #      to be a substitute for a firewall or to encourage anyone to
944 #      defer addressing basic security weaknesses.
945 #
946 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
947 #      only talks to IP addresses that match at least one permit-access
948 #      line and don't match any subsequent deny-access line. In other
949 #      words, the last match wins, with the default being deny-access.
950 #
951 #      If Privoxy is using a forwarder (see forward below) for a
952 #      particular destination URL, the dst_addr that is examined is
953 #      the address of the forwarder and NOT the address of the ultimate
954 #      target. This is necessary because it may be impossible for the
955 #      local Privoxy to determine the IP address of the ultimate target
956 #      (that's often what gateways are used for).
957 #
958 #      You should prefer using IP addresses over DNS names, because
959 #      the address lookups take time. All DNS names must resolve! You
960 #      can not use domain patterns like "*.org" or partial domain
961 #      names. If a DNS name resolves to multiple IP addresses, only
962 #      the first one is used.
963 #
964 #      Denying access to particular sites by ACL may have undesired
965 #      side effects if the site in question is hosted on a machine
966 #      which also hosts other sites (most sites are).
967 #
968 #  Examples:
969 #
970 #      Explicitly define the default behavior if no ACL and
971 #      listen-address are set: "localhost" is OK. The absence of a
972 #      dst_addr implies that all destination addresses are OK:
973 #
974 #        permit-access  localhost
975 #
976 #
977 #      Allow any host on the same class C subnet as www.privoxy.org
978 #      access to nothing but www.example.com (or other domains hosted
979 #      on the same system):
980 #
981 #        permit-access  www.privoxy.org/24 www.example.com/32
982 #
983 #
984 #      Allow access from any host on the 26-bit subnet 192.168.45.64 to
985 #      anywhere, with the exception that 192.168.45.73 may not access
986 #      the IP address behind www.dirty-stuff.example.com:
987 #
988 #        permit-access  192.168.45.64/26 
989 #        deny-access   192.168.45.73  www.dirty-stuff.example.com
990 #
991 #
992 #
993 #  4.8. buffer-limit
994 #
995 #  Specifies:
996 #
997 #      Maximum size of the buffer for content filtering.
998 #
999 #  Type of value:
1000 #
1001 #      Size in Kbytes
1002 #
1003 #  Default value:
1004 #
1005 #      4096
1006 #
1007 #  Effect if unset:
1008 #
1009 #      Use a 4MB (4096 KB) limit.
1010 #
1011 #  Notes:
1012 #
1013 #      For content filtering, i.e. the +filter and +deanimate-gif
1014 #      actions, it is necessary that Privoxy buffers the entire document
1015 #      body. This can be potentially dangerous, since a server could
1016 #      just keep sending data indefinitely and wait for your RAM to
1017 #      exhaust -- with nasty consequences.  Hence this option.
1018 #
1019 #      When a document buffer size reaches the buffer-limit, it is
1020 #      flushed to the client unfiltered and no further attempt to filter
1021 #      the rest of the document is made. Remember that there may be
1022 #      multiple threads running, which might require up to buffer-limit
1023 #      Kbytes each, unless you have enabled "single-threaded" above.
1024 #
1025 buffer-limit 4096
1026 #
1027 #
1028 #  5. FORWARDING
1029 #
1030 #  This feature allows routing of HTTP requests through a chain of
1031 #  multiple proxies.
1032 #
1033 #  Forwarding can be used to chain Privoxy with a caching proxy to
1034 #  speed up browsing. Using a parent proxy may also be necessary if
1035 #  the machine that Privoxy runs on has no direct Internet access.
1036 #
1037 #  Note that parent proxies can severely decrease your privacy
1038 #  level. For example a parent proxy could add your IP address to the
1039 #  request headers and if it's a caching proxy it may add the "Etag"
1040 #  header to revalidation requests again, even though you configured
1041 #  Privoxy to remove it. It may also ignore Privoxy's header time
1042 #  randomization and use the original values which could be used by
1043 #  the server as cookie replacement to track your steps between visits.
1044 #
1045 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1046 #  4 and SOCKS 4A protocols.
1047 #
1048 #
1049 #
1050 #  5.1. forward
1051 #
1052 #  Specifies:
1053 #
1054 #      To which parent HTTP proxy specific requests should be routed.
1055 #
1056 #  Type of value:
1057 #
1058 #      target_pattern http_parent[:port]
1059 #
1060 #      where target_pattern is a URL pattern that specifies to which
1061 #      requests (i.e. URLs) this forward rule shall apply. Use /
1062 #      to denote "all URLs".  http_parent[:port] is the DNS name or
1063 #      IP address of the parent HTTP proxy through which the requests
1064 #      should be forwarded, optionally followed by its listening port
1065 #      (default: 8080). Use a single dot (.) to denote "no forwarding".
1066 #
1067 #  Default value:
1068 #
1069 #      Unset
1070 #
1071 #  Effect if unset:
1072 #
1073 #      Don't use parent HTTP proxies.
1074 #
1075 #  Notes:
1076 #
1077 #      If http_parent is ".", then requests are not forwarded to
1078 #      another HTTP proxy but are made directly to the web servers.
1079 #
1080 #      Multiple lines are OK, they are checked in sequence, and the
1081 #      last match wins.
1082 #
1083 #  Examples:
1084 #
1085 #      Everything goes to an example parent proxy, except SSL on port
1086 #      443 (which it doesn't handle):
1087 #
1088 #        forward   /      parent-proxy.example.org:8080 
1089 #        forward   :443   .
1090 #
1091 #
1092 #      Everything goes to our example ISP's caching proxy, except for
1093 #      requests to that ISP's sites:
1094 #
1095 #        forward   /                  caching-proxy.isp.example.net:8000
1096 #        forward   .isp.example.net   .
1097 #
1098 #
1099 #
1100 #
1101 #  5.2. forward-socks4 and forward-socks4a
1102 #
1103 #  Specifies:
1104 #
1105 #      Through which SOCKS proxy (and optionally to which parent HTTP
1106 #      proxy) specific requests should be routed.
1107 #
1108 #  Type of value:
1109 #
1110 #      target_pattern socks_proxy[:port] http_parent[:port]
1111 #
1112 #      where target_pattern is a URL pattern that specifies to which
1113 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1114 #      denote "all URLs".  http_parent and socks_proxy are IP addresses
1115 #      in dotted decimal notation or valid DNS names (http_parent may
1116 #      be "." to denote "no HTTP forwarding"), and the optional port
1117 #      parameters are TCP ports, i.e. integer values from 1 to 64535
1118 #
1119 #  Default value:
1120 #
1121 #      Unset
1122 #
1123 #  Effect if unset:
1124 #
1125 #      Don't use SOCKS proxies.
1126 #
1127 #  Notes:
1128 #
1129 #      Multiple lines are OK, they are checked in sequence, and the
1130 #      last match wins.
1131 #
1132 #      The difference between forward-socks4 and forward-socks4a
1133 #      is that in the SOCKS 4A protocol, the DNS resolution of the
1134 #      target hostname happens on the SOCKS server, while in SOCKS 4
1135 #      it happens locally.
1136 #
1137 #      If http_parent is ".", then requests are not forwarded to another
1138 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
1139 #      albeit through a SOCKS proxy.
1140 #
1141 #  Examples:
1142 #
1143 #      From the company example.com, direct connections are made to all
1144 #      "internal" domains, but everything outbound goes through their
1145 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
1146 #      to the Internet.
1147 #
1148 #        forward-socks4a   /       socks-gw.example.com:1080    www-cache.isp.example.net:8080 
1149 #        forward           .example.com        .
1150 #
1151 #
1152 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1153 #      HTTP parent looks like this:
1154 #
1155 #        forward-socks4   /               socks-gw.example.com:1080  .
1156 #
1157 #
1158 #      To chain Privoxy and Tor, both running on the same system,
1159 #      you would use something like:
1160 #
1161 #        forward-socks4a   /               127.0.0.1:9050 .
1162 #
1163 #
1164 #      The public Tor network can't be used to reach your local network,
1165 #      if you need to access local servers you therefore might want
1166 #      to make some exceptions:
1167 #
1168 #        forward         192.168.*.*/     .  
1169 #        forward         10.*.*.*/        .  
1170 #        forward         127.*.*.*/       .
1171 #
1172 #
1173 #      Unencrypted connections to systems in these address ranges will
1174 #      be as (un) secure as the local network is, but the alternative
1175 #      is that you can't reach the local network through Privoxy at
1176 #      all. Of course this may actually be desired and there is no
1177 #      reason to make these exceptions if you aren't sure you need them.
1178 #
1179 #      If you also want to be able to reach servers in your local
1180 #      network by using their names, you will need additional exceptions
1181 #      that look like this:
1182 #
1183 #       forward           localhost/     .
1184 #
1185 #
1186 #
1187 #
1188 #  5.3. forwarded-connect-retries
1189 #
1190 #  Specifies:
1191 #
1192 #      How often Privoxy retries if a forwarded connection request
1193 #      fails.
1194 #
1195 #  Type of value:
1196 #
1197 #      Number of retries.
1198 #
1199 #  Default value:
1200 #
1201 #      0
1202 #
1203 #  Effect if unset:
1204 #
1205 #      Connections forwarded through other proxies are treated like
1206 #      direct connections and no retry attempts are made.
1207 #
1208 #  Notes:
1209 #
1210 #      forwarded-connect-retries is mainly interesting for socks4a
1211 #      connections, where Privoxy can't detect why the connections
1212 #      failed. The connection might have failed because of a DNS timeout
1213 #      in which case a retry makes sense, but it might also have failed
1214 #      because the server doesn't exist or isn't reachable. In this
1215 #      case the retry will just delay the appearance of Privoxy's
1216 #      error message.
1217 #
1218 #      Note that in the context of this option, "forwarded connections"
1219 #      includes all connections that Privoxy forwards through other
1220 #      proxies. This option is not limited to the HTTP CONNECT method.
1221 #
1222 #      Only use this option, if you are getting lots of
1223 #      forwarding-related error messages that go away when you try again
1224 #      manually. Start with a small value and check Privoxy's logfile
1225 #      from time to time, to see how many retries are usually needed.
1226 #
1227 #  Examples:
1228 #
1229 #      forwarded-connect-retries 1
1230 #
1231 forwarded-connect-retries  0
1232 #
1233 #
1234 #  5.4. accept-intercepted-requests
1235 #
1236 #  Specifies:
1237 #
1238 #      Whether intercepted requests should be treated as valid.
1239 #
1240 #  Type of value:
1241 #
1242 #      0 or 1
1243 #
1244 #  Default value:
1245 #
1246 #      0
1247 #
1248 #  Effect if unset:
1249 #
1250 #      Only proxy requests are accepted, intercepted requests are
1251 #      treated as invalid.
1252 #
1253 #  Notes:
1254 #
1255 #      If you don't trust your clients and want to force them to use
1256 #      Privoxy, enable this option and configure your packet filter
1257 #      to redirect outgoing HTTP connections into Privoxy.
1258 #
1259 #      Make sure that Privoxy's own requests aren't redirected as well.
1260 #      Additionally take care that Privoxy can't intentionally connect
1261 #      to itself, otherwise you could run into redirection loops if
1262 #      Privoxy's listening port is reachable by the outside or an
1263 #      attacker has access to the pages you visit.
1264 #
1265 #  Examples:
1266 #
1267 #      accept-intercepted-requests 1
1268 #
1269 accept-intercepted-requests 0
1270 #
1271 #
1272 #  5.5. allow-cgi-request-crunching
1273 #
1274 #  Specifies:
1275 #
1276 #      Whether requests to Privoxy's CGI pages can be blocked or
1277 #      redirected.
1278 #
1279 #  Type of value:
1280 #
1281 #      0 or 1
1282 #
1283 #  Default value:
1284 #
1285 #      0
1286 #
1287 #  Effect if unset:
1288 #
1289 #      Privoxy ignores block and redirect actions for its CGI pages.
1290 #
1291 #  Notes:
1292 #
1293 #      By default Privoxy ignores block or redirect actions for
1294 #      its CGI pages.  Intercepting these requests can be useful in
1295 #      multi-user setups to implement fine-grained access control,
1296 #      but it can also render the complete web interface useless and
1297 #      make debugging problems painful if done without care.
1298 #
1299 #      Don't enable this option unless you're sure that you really
1300 #      need it.
1301 #
1302 #  Examples:
1303 #
1304 #      allow-cgi-request-crunching 1
1305 #
1306 allow-cgi-request-crunching 0
1307 #
1308 #
1309 #  5.6. split-large-forms
1310 #
1311 #  Specifies:
1312 #
1313 #      Whether the CGI interface should stay compatible with broken
1314 #      HTTP clients.
1315 #
1316 #  Type of value:
1317 #
1318 #      0 or 1
1319 #
1320 #  Default value:
1321 #
1322 #      0
1323 #
1324 #  Effect if unset:
1325 #
1326 #      The CGI form generate long GET URLs.
1327 #
1328 #  Notes:
1329 #
1330 #      Privoxy's CGI forms can lead to rather long URLs. This isn't
1331 #      a problem as far as the HTTP standard is concerned, but it can
1332 #      confuse clients with arbitrary URL length limitations.
1333 #
1334 #      Enabling split-large-forms causes Privoxy to divide big forms
1335 #      into smaller ones to keep the URL length down. It makes editing
1336 #      a lot less convenient and you can no longer submit all changes
1337 #      at once, but at least it works around this browser bug.
1338 #
1339 #      If you don't notice any editing problems, there is no reason
1340 #      to enable this option, but if one of the submit buttons appears
1341 #      to be broken, you should give it a try.
1342 #
1343 #  Examples:
1344 #
1345 #      split-large-forms 1
1346 #
1347 split-large-forms 0
1348 #
1349 #
1350 #  6. WINDOWS GUI OPTIONS
1351 #
1352 #  Privoxy has a number of options specific to the Windows GUI
1353 #  interface:
1354 #
1355
1356 #  If "activity-animation" is set to 1, the Privoxy icon will animate
1357 #  when "Privoxy" is active. To turn off, set to 0.
1358 #
1359 #activity-animation   1
1360
1361 #  If "log-messages" is set to 1, Privoxy will log messages to the
1362 #  console window:
1363 #
1364 #log-messages   1
1365
1366 #  If "log-buffer-size" is set to 1, the size of the log buffer,
1367 #  i.e. the amount of memory used for the log messages displayed in
1368 #  the console window, will be limited to "log-max-lines" (see below).
1369 #
1370 #  Warning: Setting this to 0 will result in the buffer to grow
1371 #  infinitely and eat up all your memory!
1372 #
1373 #log-buffer-size 1
1374
1375 #  log-max-lines is the maximum number of lines held in the log
1376 #  buffer. See above.
1377 #
1378 #log-max-lines 200
1379
1380 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
1381 #  portions of the log messages with a bold-faced font:
1382 #
1383 #log-highlight-messages 1
1384
1385 #  The font used in the console window:
1386 #
1387 #log-font-name Comic Sans MS
1388
1389 #  Font size used in the console window:
1390 #
1391 #log-font-size 8
1392
1393 #  "show-on-task-bar" controls whether or not Privoxy will appear as
1394 #  a button on the Task bar when minimized:
1395 #
1396 #show-on-task-bar 0
1397
1398 #  If "close-button-minimizes" is set to 1, the Windows close button
1399 #  will minimize Privoxy instead of closing the program (close with
1400 #  the exit option on the File menu).
1401 #
1402 #close-button-minimizes 1
1403
1404 #  The "hide-console" option is specific to the MS-Win console version
1405 #  of Privoxy.  If this option is used, Privoxy will disconnect from
1406 #  and hide the command console.
1407 #
1408 #hide-console
1409 #
1410 #