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