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