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