Bump the copyright for the website
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy v3.0.20
2 #
3 #  $Id: config,v 1.100 2013/01/09 15:07:39 fabiankeil Exp $
4 #
5 #  Copyright (C) 2001-2013 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
34 #  before you see the result of your changes. Requests that are
35 #  dropped due 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
40 #  directory 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 '#' is
55 #  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
76 #  yourself, it might be a good idea to let them know how to reach
77 #  you, what 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
104 #      on Privoxy, and is used for help links from some of the
105 #      internal CGI pages. The manual itself is normally packaged
106 #      with the binary distributions, so you probably want to set
107 #      this to a 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 #      The User Manual is then available to anyone with access to
117 #      Privoxy, by following the built-in URL: http://
118 #      config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
119 #      user-manual/).
120 #
121 #      If the documentation is not on the local system, it can be
122 #      accessed from a remote server, as:
123 #
124 #        user-manual  http://example.com/privoxy/user-manual/
125 #
126 #      WARNING!!!
127 #
128 #          If set, this option should be the first option in the
129 #          config file, because it is used while the config file is
130 #          being read.
131 #
132 #user-manual http://www.privoxy.org/user-manual/
133 #
134 #
135 #  1.2. trust-info-url
136 #  ====================
137 #
138 #  Specifies:
139 #
140 #      A URL to be displayed in the error page that users will see if
141 #      access to an untrusted page is denied.
142 #
143 #  Type of value:
144 #
145 #      URL
146 #
147 #  Default value:
148 #
149 #      Unset
150 #
151 #  Effect if unset:
152 #
153 #      No links are displayed on the "untrusted" error page.
154 #
155 #  Notes:
156 #
157 #      The value of this option only matters if the experimental
158 #      trust mechanism has been activated. (See trustfile below.)
159 #
160 #      If you use the trust mechanism, it is a good idea to write up
161 #      some on-line documentation about your trust policy and to
162 #      specify the URL(s) here. Use multiple times for multiple URLs.
163 #
164 #      The URL(s) should be added to the trustfile as well, so users
165 #      don't end up locked out from the information on why they were
166 #      locked out in the first place!
167 #
168 #trust-info-url  http://www.example.com/why_we_block.html
169 #trust-info-url  http://www.example.com/what_we_allow.html
170 #
171 #
172 #  1.3. admin-address
173 #  ===================
174 #
175 #  Specifies:
176 #
177 #      An email address to reach the Privoxy administrator.
178 #
179 #  Type of value:
180 #
181 #      Email address
182 #
183 #  Default value:
184 #
185 #      Unset
186 #
187 #  Effect if unset:
188 #
189 #      No email address is displayed on error pages and the CGI user
190 #      interface.
191 #
192 #  Notes:
193 #
194 #      If both admin-address and proxy-info-url are unset, the whole
195 #      "Local Privoxy Support" box on all generated pages will not be
196 #      shown.
197 #
198 #admin-address privoxy-admin@example.com
199 #
200 #
201 #  1.4. proxy-info-url
202 #  ====================
203 #
204 #  Specifies:
205 #
206 #      A URL to documentation about the local Privoxy setup,
207 #      configuration or policies.
208 #
209 #  Type of value:
210 #
211 #      URL
212 #
213 #  Default value:
214 #
215 #      Unset
216 #
217 #  Effect if unset:
218 #
219 #      No link to local documentation is displayed on error pages and
220 #      the CGI user interface.
221 #
222 #  Notes:
223 #
224 #      If both admin-address and proxy-info-url are unset, the whole
225 #      "Local Privoxy Support" box on all generated pages will not be
226 #      shown.
227 #
228 #      This URL shouldn't be blocked ;-)
229 #
230 #proxy-info-url http://www.example.com/proxy-service.html
231 #
232 #
233 #  2. CONFIGURATION AND LOG FILE LOCATIONS
234 #  ========================================
235 #
236 #  Privoxy can (and normally does) use a number of other files for
237 #  additional configuration, help and logging. This section of the
238 #  configuration file tells Privoxy where to find those other files.
239 #
240 #  The user running Privoxy, must have read permission for all
241 #  configuration files, and write permission to any files that would
242 #  be modified, such as log files and actions files.
243 #
244 #
245 #
246 #  2.1. confdir
247 #  =============
248 #
249 #  Specifies:
250 #
251 #      The directory where the other configuration files are located.
252 #
253 #  Type of value:
254 #
255 #      Path name
256 #
257 #  Default value:
258 #
259 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
260 #
261 #  Effect if unset:
262 #
263 #      Mandatory
264 #
265 #  Notes:
266 #
267 #      No trailing "/", please.
268 #
269 confdir .
270 #
271 #
272 #  2.2. templdir
273 #  ==============
274 #
275 #  Specifies:
276 #
277 #      An alternative directory where the templates are loaded from.
278 #
279 #  Type of value:
280 #
281 #      Path name
282 #
283 #  Default value:
284 #
285 #      unset
286 #
287 #  Effect if unset:
288 #
289 #      The templates are assumed to be located in confdir/template.
290 #
291 #  Notes:
292 #
293 #      Privoxy's original templates are usually overwritten with each
294 #      update. Use this option to relocate customized templates that
295 #      should be kept. As template variables might change between
296 #      updates, you shouldn't expect templates to work with Privoxy
297 #      releases other than the one they were part of, though.
298 #
299 #templdir .
300 #
301 #
302 #  2.3. logdir
303 #  ============
304 #
305 #  Specifies:
306 #
307 #      The directory where all logging takes place (i.e. where the
308 #      logfile is located).
309 #
310 #  Type of value:
311 #
312 #      Path name
313 #
314 #  Default value:
315 #
316 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
317 #
318 #  Effect if unset:
319 #
320 #      Mandatory
321 #
322 #  Notes:
323 #
324 #      No trailing "/", please.
325 #
326 logdir .
327 #
328 #
329 #  2.4. actionsfile
330 #  =================
331 #
332 #  Specifies:
333 #
334 #      The actions file(s) to use
335 #
336 #  Type of value:
337 #
338 #      Complete file name, relative to confdir
339 #
340 #  Default values:
341 #
342 #        match-all.action # Actions that are applied to all sites and maybe overruled later on.
343 #
344 #        default.action   # Main actions file
345 #
346 #        user.action      # User customizations
347 #
348 #  Effect if unset:
349 #
350 #      No actions are taken at all. More or less neutral proxying.
351 #
352 #  Notes:
353 #
354 #      Multiple actionsfile lines are permitted, and are in fact
355 #      recommended!
356 #
357 #      The default values are default.action, which is the "main"
358 #      actions file maintained by the developers, and user.action,
359 #      where you can make your personal additions.
360 #
361 #      Actions files contain all the per site and per URL
362 #      configuration for ad blocking, cookie management, privacy
363 #      considerations, etc. There is no point in using Privoxy
364 #      without at least one actions file.
365 #
366 #      Note that since Privoxy 3.0.7, the complete filename,
367 #      including the ".action" extension has to be specified. The
368 #      syntax change was necessary to be consistent with the other
369 #      file options and to allow previously forbidden characters.
370 #
371 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
372 actionsfile default.action   # Main actions file
373 actionsfile user.action      # User customizations
374 #
375 #
376 #  2.5. filterfile
377 #  ================
378 #
379 #  Specifies:
380 #
381 #      The filter file(s) to use
382 #
383 #  Type of value:
384 #
385 #      File name, relative to confdir
386 #
387 #  Default value:
388 #
389 #      default.filter (Unix) or default.filter.txt (Windows)
390 #
391 #  Effect if unset:
392 #
393 #      No textual content filtering takes place, i.e. all +filter{name}
394 #      actions in the actions files are turned neutral.
395 #
396 #  Notes:
397 #
398 #      Multiple filterfile lines are permitted.
399 #
400 #      The filter files contain content modification rules that use
401 #      regular expressions. These rules permit powerful changes on
402 #      the content of Web pages, and optionally the headers as well,
403 #      e.g., you could try to disable your favorite JavaScript
404 #      annoyances, re-write the actual displayed text, or just have
405 #      some fun playing buzzword bingo with web pages.
406 #
407 #      The +filter{name} actions rely on the relevant filter (name)
408 #      to be defined in a filter file!
409 #
410 #      A pre-defined filter file called default.filter that contains
411 #      a number of useful filters for common problems is included in
412 #      the distribution. See the section on the filter action for a
413 #      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
446 #      with the debug option (see below). The logfile can be useful
447 #      for tracking down a problem with Privoxy (e.g., it's not
448 #      blocking an ad you think it should block) and it can help you
449 #      to monitor 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
457 #      that, 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").
462 #
463 #      Any log files must be writable by whatever user Privoxy is
464 #      being run as (on Unix, default user id is "privoxy").
465 #
466 logfile logfile
467 #
468 #
469 #  2.7. trustfile
470 #  ===============
471 #
472 #  Specifies:
473 #
474 #      The name of the trust file to use
475 #
476 #  Type of value:
477 #
478 #      File name, relative to confdir
479 #
480 #  Default value:
481 #
482 #      Unset (commented out). When activated: trust (Unix) or
483 #      trust.txt (Windows)
484 #
485 #  Effect if unset:
486 #
487 #      The entire trust mechanism is disabled.
488 #
489 #  Notes:
490 #
491 #      The trust mechanism is an experimental feature for building
492 #      white-lists and should be used with care. It is NOT
493 #      recommended for the casual user.
494 #
495 #      If you specify a trust file, Privoxy will only allow access to
496 #      sites that are specified in the trustfile. Sites can be listed
497 #      in one of two ways:
498 #
499 #      Prepending a ~ character limits access to this site only (and
500 #      any sub-paths within this site), e.g. ~www.example.com allows
501 #      access to ~www.example.com/features/news.html, etc.
502 #
503 #      Or, you can designate sites as trusted referrers, by
504 #      prepending the name with a + character. The effect is that
505 #      access to untrusted sites will be granted -- but only if a
506 #      link from this trusted referrer was used to get there. The
507 #      link target will then be added to the "trustfile" so that
508 #      future, direct accesses will be granted. Sites added via this
509 #      mechanism do not become trusted referrers themselves (i.e.
510 #      they are added with a ~ designation). There is a limit of 512
511 #      such entries, after which new entries will not be made.
512 #
513 #      If you use the + operator in the trust file, it may grow
514 #      considerably over time.
515 #
516 #      It is recommended that Privoxy be compiled with the
517 #      --disable-force, --disable-toggle and --disable-editor
518 #      options, if this feature is to be used.
519 #
520 #      Possible applications include limiting Internet access for
521 #      children.
522 #
523 #trustfile trust
524 #
525 #
526 #  3. DEBUGGING
527 #  =============
528 #
529 #  These options are mainly useful when tracing a problem. Note that
530 #  you might also want to invoke Privoxy with the --no-daemon command
531 #  line option when debugging.
532 #
533 #
534 #
535 #  3.1. debug
536 #  ===========
537 #
538 #  Specifies:
539 #
540 #      Key values that determine what information gets logged.
541 #
542 #  Type of value:
543 #
544 #      Integer values
545 #
546 #  Default value:
547 #
548 #      0 (i.e.: only fatal errors (that cause Privoxy to exit) are
549 #      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
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 #        debug 32768 # log all data read from the network
574 #        debug 65536 # Log the applying actions
575 #
576 #      To select multiple debug levels, you can either add them or
577 #      use multiple debug lines.
578 #
579 #      A debug level of 1 is informative because it will show you
580 #      each request as it happens. 1, 1024, 4096 and 8192 are
581 #      recommended so that you will notice when things go wrong. The
582 #      other levels are probably only of interest if you are hunting
583 #      down a specific problem. They can produce a hell of an output
584 #      (especially 16).
585 #
586 #      Privoxy used to ship with the debug levels recommended above
587 #      enabled by default, but due to privacy concerns 3.0.7 and
588 #      later are configured to only log fatal errors.
589 #
590 #      If you are used to the more verbose settings, simply enable
591 #      the debug lines below again.
592 #
593 #      If you want to use pure CLF (Common Log Format), you should
594 #      set "debug 512" ONLY and not enable anything else.
595 #
596 #      Privoxy has a hard-coded limit for the length of log messages.
597 #      If it's reached, messages are logged truncated and marked with
598 #      "... [too long, truncated]".
599 #
600 #      Please don't file any support requests without trying to
601 #      reproduce the problem with increased debug level first. Once
602 #      you read the log messages, you may even be able to solve the
603 #      problem on your own.
604 #
605 #debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
606 #debug  1024 # Actions that are applied to all sites and maybe overruled later on.
607 #debug  4096 # Startup banner and warnings
608 #debug  8192 # Non-fatal errors
609 #
610 #
611 #  3.2. single-threaded
612 #  =====================
613 #
614 #  Specifies:
615 #
616 #      Whether to run only one server thread.
617 #
618 #  Type of value:
619 #
620 #      None
621 #
622 #  Default value:
623 #
624 #      Unset
625 #
626 #  Effect if unset:
627 #
628 #      Multi-threaded (or, where unavailable: forked) operation, i.e.
629 #      the ability to serve multiple requests simultaneously.
630 #
631 #  Notes:
632 #
633 #      This option is only there for debugging purposes. It will
634 #      drastically reduce performance.
635 #
636 #single-threaded
637 #
638 #
639 #  3.3. hostname
640 #  ==============
641 #
642 #  Specifies:
643 #
644 #      The hostname shown on the CGI pages.
645 #
646 #  Type of value:
647 #
648 #      Text
649 #
650 #  Default value:
651 #
652 #      Unset
653 #
654 #  Effect if unset:
655 #
656 #      The hostname provided by the operating system is used.
657 #
658 #  Notes:
659 #
660 #      On some misconfigured systems resolving the hostname fails or
661 #      takes too much time and slows Privoxy down. Setting a fixed
662 #      hostname works around the problem.
663 #
664 #      In other circumstances it might be desirable to show a
665 #      hostname other than the one returned by the operating system.
666 #      For example if the system has several different hostnames and
667 #      you don't want to use the first one.
668 #
669 #      Note that Privoxy does not validate the specified hostname
670 #      value.
671 #
672 #hostname hostname.example.org
673 #
674 #
675 #  4. ACCESS CONTROL AND SECURITY
676 #  ===============================
677 #
678 #  This section of the config file controls the security-relevant
679 #  aspects of Privoxy's configuration.
680 #
681 #
682 #
683 #  4.1. listen-address
684 #  ====================
685 #
686 #  Specifies:
687 #
688 #      The address and TCP port on which Privoxy will listen for
689 #      client requests.
690 #
691 #  Type of value:
692 #
693 #      [IP-Address]:Port
694 #
695 #      [Hostname]:Port
696 #
697 #  Default value:
698 #
699 #      127.0.0.1:8118
700 #
701 #  Effect if unset:
702 #
703 #      Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
704 #      suitable and recommended for home users who run Privoxy on the
705 #      same machine as their browser.
706 #
707 #  Notes:
708 #
709 #      You will need to configure your browser(s) to this proxy
710 #      address and port.
711 #
712 #      If you already have another service running on port 8118, or
713 #      if you want to serve requests from other machines (e.g. on
714 #      your local network) as well, you will need to override the
715 #      default.
716 #
717 #      You can use this statement multiple times to make Privoxy
718 #      listen on more ports or more IP addresses. Suitable if your
719 #      operating system does not support sharing IPv6 and IPv4
720 #      protocols on the same socket.
721 #
722 #      If a hostname is used instead of an IP address, Privoxy will
723 #      try to resolve it to an IP address and if there are multiple,
724 #      use the first one returned.
725 #
726 #      If the address for the hostname isn't already known on the
727 #      system (for example because it's in /etc/hostname), this may
728 #      result in DNS traffic.
729 #
730 #      If the specified address isn't available on the system, or if
731 #      the hostname can't be resolved, Privoxy will fail to start.
732 #
733 #      IPv6 addresses containing colons have to be quoted by
734 #      brackets. They can only be used if Privoxy has been compiled
735 #      with IPv6 support. If you aren't sure if your version supports
736 #      it, have a look at http://config.privoxy.org/show-status.
737 #
738 #      Some operating systems will prefer IPv6 to IPv4 addresses even
739 #      if the system has no IPv6 connectivity which is usually not
740 #      expected by the user. Some even rely on DNS to resolve
741 #      localhost which mean the "localhost" address used may not
742 #      actually be local.
743 #
744 #      It is therefore recommended to explicitly configure the
745 #      intended IP address instead of relying on the operating
746 #      system, unless there's a strong reason not to.
747 #
748 #      If you leave out the address, Privoxy will bind to all IPv4
749 #      interfaces (addresses) on your machine and may become
750 #      reachable from the Internet and/or the local network. Be aware
751 #      that some GNU/Linux distributions modify that behaviour
752 #      without updating the documentation. Check for non-standard
753 #      patches if your Privoxy version behaves differently.
754 #
755 #      If you configure Privoxy to be reachable from the network,
756 #      consider using access control lists (ACL's, see below), and/or
757 #      a firewall.
758 #
759 #      If you open Privoxy to untrusted users, you will also want to
760 #      make sure that the following actions are disabled:
761 #      enable-edit-actions and enable-remote-toggle
762 #
763 #  Example:
764 #
765 #      Suppose you are running Privoxy on a machine which has the
766 #      address 192.168.0.1 on your local private network
767 #      (192.168.0.0) and has another outside connection with a
768 #      different address. You want it to serve requests from inside
769 #      only:
770 #
771 #        listen-address  192.168.0.1:8118
772 #
773 #      Suppose you are running Privoxy on an IPv6-capable machine and
774 #      you want it to listen on the IPv6 address of the loopback
775 #      device:
776 #
777 #        listen-address [::1]:8118
778 #
779 listen-address  127.0.0.1:8118
780 #
781 #
782 #  4.2. toggle
783 #  ============
784 #
785 #  Specifies:
786 #
787 #      Initial state of "toggle" status
788 #
789 #  Type of value:
790 #
791 #      1 or 0
792 #
793 #  Default value:
794 #
795 #      1
796 #
797 #  Effect if unset:
798 #
799 #      Act as if toggled on
800 #
801 #  Notes:
802 #
803 #      If set to 0, Privoxy will start in "toggled off" mode, i.e.
804 #      mostly behave like a normal, content-neutral proxy with both
805 #      ad blocking and content filtering disabled. See
806 #      enable-remote-toggle below.
807 #
808 toggle  1
809 #
810 #
811 #  4.3. enable-remote-toggle
812 #  ==========================
813 #
814 #  Specifies:
815 #
816 #      Whether or not the web-based toggle feature may be used
817 #
818 #  Type of value:
819 #
820 #      0 or 1
821 #
822 #  Default value:
823 #
824 #      0
825 #
826 #  Effect if unset:
827 #
828 #      The web-based toggle feature is disabled.
829 #
830 #  Notes:
831 #
832 #      When toggled off, Privoxy mostly acts like a normal,
833 #      content-neutral proxy, i.e. doesn't block ads or filter
834 #      content.
835 #
836 #      Access to the toggle feature can not be controlled separately
837 #      by "ACLs" or HTTP authentication, so that everybody who can
838 #      access Privoxy (see "ACLs" and listen-address above) can
839 #      toggle it for all users. So this option is not recommended for
840 #      multi-user environments with untrusted users.
841 #
842 #      Note that malicious client side code (e.g Java) is also
843 #      capable of using this option.
844 #
845 #      As a lot of Privoxy users don't read documentation, this
846 #      feature is disabled by default.
847 #
848 #      Note that you must have compiled Privoxy with support for this
849 #      feature, otherwise this option has no effect.
850 #
851 enable-remote-toggle  0
852 #
853 #
854 #  4.4. enable-remote-http-toggle
855 #  ===============================
856 #
857 #  Specifies:
858 #
859 #      Whether or not Privoxy recognizes special HTTP headers to
860 #      change its behaviour.
861 #
862 #  Type of value:
863 #
864 #      0 or 1
865 #
866 #  Default value:
867 #
868 #      0
869 #
870 #  Effect if unset:
871 #
872 #      Privoxy ignores special HTTP headers.
873 #
874 #  Notes:
875 #
876 #      When toggled on, the client can change Privoxy's behaviour by
877 #      setting special HTTP headers. Currently the only supported
878 #      special header is "X-Filter: No", to disable filtering for the
879 #      ongoing request, even if it is enabled in one of the action
880 #      files.
881 #
882 #      This feature is disabled by default. If you are using Privoxy
883 #      in a environment with trusted clients, you may enable this
884 #      feature at your discretion. Note that malicious client side
885 #      code (e.g Java) is also capable of using this feature.
886 #
887 #      This option will be removed in future releases as it has been
888 #      obsoleted by the more general header taggers.
889 #
890 enable-remote-http-toggle  0
891 #
892 #
893 #  4.5. enable-edit-actions
894 #  =========================
895 #
896 #  Specifies:
897 #
898 #      Whether or not the web-based actions file editor may be used
899 #
900 #  Type of value:
901 #
902 #      0 or 1
903 #
904 #  Default value:
905 #
906 #      0
907 #
908 #  Effect if unset:
909 #
910 #      The web-based actions file editor is disabled.
911 #
912 #  Notes:
913 #
914 #      Access to the editor can not be controlled separately by
915 #      "ACLs" or HTTP authentication, so that everybody who can
916 #      access Privoxy (see "ACLs" and listen-address above) can
917 #      modify its configuration for all users.
918 #
919 #      This option is not recommended for environments with untrusted
920 #      users and as a lot of Privoxy users don't read documentation,
921 #      this feature is disabled by default.
922 #
923 #      Note that malicious client side code (e.g Java) is also
924 #      capable of using the actions editor and you shouldn't enable
925 #      this options unless you understand the consequences and are
926 #      sure your browser is configured correctly.
927 #
928 #      Note that you must have compiled Privoxy with support for this
929 #      feature, otherwise this option has no effect.
930 #
931 enable-edit-actions 0
932 #
933 #
934 #  4.6. enforce-blocks
935 #  ====================
936 #
937 #  Specifies:
938 #
939 #      Whether the user is allowed to ignore blocks and can "go there
940 #      anyway".
941 #
942 #  Type of value:
943 #
944 #      0 or 1
945 #
946 #  Default value:
947 #
948 #      0
949 #
950 #  Effect if unset:
951 #
952 #      Blocks are not enforced.
953 #
954 #  Notes:
955 #
956 #      Privoxy is mainly used to block and filter requests as a
957 #      service to the user, for example to block ads and other junk
958 #      that clogs the pipes. Privoxy's configuration isn't perfect
959 #      and sometimes innocent pages are blocked. In this situation it
960 #      makes sense to allow the user to enforce the request and have
961 #      Privoxy ignore the block.
962 #
963 #      In the default configuration Privoxy's "Blocked" page contains
964 #      a "go there anyway" link to adds a special string (the force
965 #      prefix) to the request URL. If that link is used, Privoxy will
966 #      detect the force prefix, remove it again and let the request
967 #      pass.
968 #
969 #      Of course Privoxy can also be used to enforce a network
970 #      policy. In that case the user obviously should not be able to
971 #      bypass any blocks, and that's what the "enforce-blocks" option
972 #      is for. If it's enabled, Privoxy hides the "go there anyway"
973 #      link. If the user adds the force prefix by hand, it will not
974 #      be accepted and the circumvention attempt is logged.
975 #
976 #  Examples:
977 #
978 #      enforce-blocks 1
979 #
980 enforce-blocks 0
981 #
982 #
983 #  4.7. ACLs: permit-access and deny-access
984 #  =========================================
985 #
986 #  Specifies:
987 #
988 #      Who can access what.
989 #
990 #  Type of value:
991 #
992 #      src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
993 #
994 #      Where src_addr and dst_addr are IPv4 addresses in dotted
995 #      decimal notation or valid DNS names, port is a port number,
996 #      and src_masklen and dst_masklen are subnet masks in CIDR
997 #      notation, i.e. integer values from 2 to 30 representing the
998 #      length (in bits) of the network address. The masks and the
999 #      whole destination part are optional.
1000 #
1001 #      If your system implements RFC 3493, then src_addr and dst_addr
1002 #      can be IPv6 addresses delimeted by brackets, port can be a
1003 #      number or a service name, and src_masklen and dst_masklen can
1004 #      be a number from 0 to 128.
1005 #
1006 #  Default value:
1007 #
1008 #      Unset
1009 #
1010 #      If no port is specified, any port will match. If no
1011 #      src_masklen or src_masklen is given, the complete IP address
1012 #      has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1013 #
1014 #  Effect if unset:
1015 #
1016 #      Don't restrict access further than implied by listen-address
1017 #
1018 #  Notes:
1019 #
1020 #      Access controls are included at the request of ISPs and
1021 #      systems administrators, and are not usually needed by
1022 #      individual users. For a typical home user, it will normally
1023 #      suffice to ensure that Privoxy only listens on the localhost
1024 #      (127.0.0.1) or internal (home) network address by means of the
1025 #      listen-address option.
1026 #
1027 #      Please see the warnings in the FAQ that Privoxy is not
1028 #      intended to be a substitute for a firewall or to encourage
1029 #      anyone to defer addressing basic security weaknesses.
1030 #
1031 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1032 #      only talks to IP addresses that match at least one
1033 #      permit-access line and don't match any subsequent deny-access
1034 #      line. In other words, the last match wins, with the default
1035 #      being deny-access.
1036 #
1037 #      If Privoxy is using a forwarder (see forward below) for a
1038 #      particular destination URL, the dst_addr that is examined is
1039 #      the address of the forwarder and NOT the address of the
1040 #      ultimate target. This is necessary because it may be
1041 #      impossible for the local Privoxy to determine the IP address
1042 #      of the ultimate target (that's often what gateways are used
1043 #      for).
1044 #
1045 #      You should prefer using IP addresses over DNS names, because
1046 #      the address lookups take time. All DNS names must resolve! You
1047 #      can not use domain patterns like "*.org" or partial domain
1048 #      names. If a DNS name resolves to multiple IP addresses, only
1049 #      the first one is used.
1050 #
1051 #      Some systems allow IPv4 clients to connect to IPv6 server
1052 #      sockets. Then the client's IPv4 address will be translated by
1053 #      the system into IPv6 address space with special prefix
1054 #      ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1055 #      can handle it and maps such ACL addresses automatically.
1056 #
1057 #      Denying access to particular sites by ACL may have undesired
1058 #      side effects if the site in question is hosted on a machine
1059 #      which also hosts other sites (most sites are).
1060 #
1061 #  Examples:
1062 #
1063 #      Explicitly define the default behavior if no ACL and
1064 #      listen-address are set: "localhost" is OK. The absence of a
1065 #      dst_addr implies that all destination addresses are OK:
1066 #
1067 #        permit-access  localhost
1068 #
1069 #      Allow any host on the same class C subnet as www.privoxy.org
1070 #      access to nothing but www.example.com (or other domains hosted
1071 #      on the same system):
1072 #
1073 #        permit-access  www.privoxy.org/24 www.example.com/32
1074 #
1075 #      Allow access from any host on the 26-bit subnet 192.168.45.64
1076 #      to anywhere, with the exception that 192.168.45.73 may not
1077 #      access the IP address behind www.dirty-stuff.example.com:
1078 #
1079 #        permit-access  192.168.45.64/26
1080 #        deny-access    192.168.45.73    www.dirty-stuff.example.com
1081 #
1082 #      Allow access from the IPv4 network 192.0.2.0/24 even if
1083 #      listening on an IPv6 wild card address (not supported on all
1084 #      platforms):
1085 #
1086 #        permit-access  192.0.2.0/24
1087 #
1088 #      This is equivalent to the following line even if listening on
1089 #      an IPv4 address (not supported on all platforms):
1090 #
1091 #        permit-access  [::ffff:192.0.2.0]/120
1092 #
1093 #
1094 #
1095 #  4.8. buffer-limit
1096 #  ==================
1097 #
1098 #  Specifies:
1099 #
1100 #      Maximum size of the buffer for content filtering.
1101 #
1102 #  Type of value:
1103 #
1104 #      Size in Kbytes
1105 #
1106 #  Default value:
1107 #
1108 #      4096
1109 #
1110 #  Effect if unset:
1111 #
1112 #      Use a 4MB (4096 KB) limit.
1113 #
1114 #  Notes:
1115 #
1116 #      For content filtering, i.e. the +filter and +deanimate-gif
1117 #      actions, it is necessary that Privoxy buffers the entire
1118 #      document body. This can be potentially dangerous, since a
1119 #      server could just keep sending data indefinitely and wait for
1120 #      your RAM to exhaust -- with nasty consequences. Hence this
1121 #      option.
1122 #
1123 #      When a document buffer size reaches the buffer-limit, it is
1124 #      flushed to the client unfiltered and no further attempt to
1125 #      filter the rest of the document is made. Remember that there
1126 #      may be multiple threads running, which might require up to
1127 #      buffer-limit Kbytes each, unless you have enabled
1128 #      "single-threaded" above.
1129 #
1130 buffer-limit 4096
1131 #
1132 #
1133 #  5. FORWARDING
1134 #  ==============
1135 #
1136 #  This feature allows routing of HTTP requests through a chain of
1137 #  multiple proxies.
1138 #
1139 #  Forwarding can be used to chain Privoxy with a caching proxy to
1140 #  speed up browsing. Using a parent proxy may also be necessary if
1141 #  the machine that Privoxy runs on has no direct Internet access.
1142 #
1143 #  Note that parent proxies can severely decrease your privacy level.
1144 #  For example a parent proxy could add your IP address to the
1145 #  request headers and if it's a caching proxy it may add the "Etag"
1146 #  header to revalidation requests again, even though you configured
1147 #  Privoxy to remove it. It may also ignore Privoxy's header time
1148 #  randomization and use the original values which could be used by
1149 #  the server as cookie replacement to track your steps between
1150 #  visits.
1151 #
1152 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1153 #  4 and SOCKS 4A protocols.
1154 #
1155 #
1156 #
1157 #  5.1. forward
1158 #  =============
1159 #
1160 #  Specifies:
1161 #
1162 #      To which parent HTTP proxy specific requests should be routed.
1163 #
1164 #  Type of value:
1165 #
1166 #      target_pattern http_parent[:port]
1167 #
1168 #      where target_pattern is a URL pattern that specifies to which
1169 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1170 #      denote "all URLs". http_parent[:port] is the DNS name or IP
1171 #      address of the parent HTTP proxy through which the requests
1172 #      should be forwarded, optionally followed by its listening port
1173 #      (default: 8000). Use a single dot (.) to denote "no
1174 #      forwarding".
1175 #
1176 #  Default value:
1177 #
1178 #      Unset
1179 #
1180 #  Effect if unset:
1181 #
1182 #      Don't use parent HTTP proxies.
1183 #
1184 #  Notes:
1185 #
1186 #      If http_parent is ".", then requests are not forwarded to
1187 #      another HTTP proxy but are made directly to the web servers.
1188 #
1189 #      http_parent can be a numerical IPv6 address (if RFC 3493 is
1190 #      implemented). To prevent clashes with the port delimiter, the
1191 #      whole IP address has to be put into brackets. On the other
1192 #      hand a target_pattern containing an IPv6 address has to be put
1193 #      into angle brackets (normal brackets are reserved for regular
1194 #      expressions already).
1195 #
1196 #      Multiple lines are OK, they are checked in sequence, and the
1197 #      last match wins.
1198 #
1199 #  Examples:
1200 #
1201 #      Everything goes to an example parent proxy, except SSL on port
1202 #      443 (which it doesn't handle):
1203 #
1204 #        forward   /      parent-proxy.example.org:8080
1205 #        forward   :443   .
1206 #
1207 #      Everything goes to our example ISP's caching proxy, except for
1208 #      requests to that ISP's sites:
1209 #
1210 #        forward   /                  caching-proxy.isp.example.net:8000
1211 #        forward   .isp.example.net   .
1212 #
1213 #      Parent proxy specified by an IPv6 address:
1214 #
1215 #        forward   /                   [2001:DB8::1]:8000
1216 #
1217 #      Suppose your parent proxy doesn't support IPv6:
1218 #
1219 #        forward  /                        parent-proxy.example.org:8000
1220 #        forward  ipv6-server.example.org  .
1221 #        forward  <[2-3][0-9a-f][0-9a-f][0-9a-f]:*>   .
1222 #
1223 #
1224 #
1225 #  5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1226 #  =========================================================================
1227 #
1228 #  Specifies:
1229 #
1230 #      Through which SOCKS proxy (and optionally to which parent HTTP
1231 #      proxy) specific requests should be routed.
1232 #
1233 #  Type of value:
1234 #
1235 #      target_pattern socks_proxy[:port] http_parent[:port]
1236 #
1237 #      where target_pattern is a URL pattern that specifies to which
1238 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1239 #      denote "all URLs". http_parent and socks_proxy are IP
1240 #      addresses in dotted decimal notation or valid DNS names (
1241 #      http_parent may be "." to denote "no HTTP forwarding"), and
1242 #      the optional port parameters are TCP ports, i.e. integer
1243 #      values from 1 to 65535
1244 #
1245 #  Default value:
1246 #
1247 #      Unset
1248 #
1249 #  Effect if unset:
1250 #
1251 #      Don't use SOCKS proxies.
1252 #
1253 #  Notes:
1254 #
1255 #      Multiple lines are OK, they are checked in sequence, and the
1256 #      last match wins.
1257 #
1258 #      The difference between forward-socks4 and forward-socks4a is
1259 #      that in the SOCKS 4A protocol, the DNS resolution of the
1260 #      target hostname happens on the SOCKS server, while in SOCKS 4
1261 #      it happens locally.
1262 #
1263 #      With forward-socks5 the DNS resolution will happen on the
1264 #      remote server as well.
1265 #
1266 #      forward-socks5t works like vanilla forward-socks5 but lets
1267 #      Privoxy additionally use Tor-specific SOCKS extensions.
1268 #      Currently the only supported SOCKS extension is optimistic
1269 #      data which can reduce the latency for the first request made
1270 #      on a newly created connection.
1271 #
1272 #      socks_proxy and http_parent can be a numerical IPv6 address
1273 #      (if RFC 3493 is implemented). To prevent clashes with the port
1274 #      delimiter, the whole IP address has to be put into brackets.
1275 #      On the other hand a target_pattern containing an IPv6 address
1276 #      has to be put into angle brackets (normal brackets are
1277 #      reserved for regular expressions already).
1278 #
1279 #      If http_parent is ".", then requests are not forwarded to
1280 #      another HTTP proxy but are made (HTTP-wise) directly to the
1281 #      web servers, albeit through a SOCKS proxy.
1282 #
1283 #  Examples:
1284 #
1285 #      From the company example.com, direct connections are made to
1286 #      all "internal" domains, but everything outbound goes through
1287 #      their ISP's proxy by way of example.com's corporate SOCKS 4A
1288 #      gateway to the Internet.
1289 #
1290 #        forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
1291 #        forward           .example.com   .
1292 #
1293 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1294 #      HTTP parent looks like this:
1295 #
1296 #        forward-socks4   /               socks-gw.example.com:1080  .
1297 #
1298 #      To chain Privoxy and Tor, both running on the same system, you
1299 #      would use something like:
1300 #
1301 #        forward-socks5   /               127.0.0.1:9050 .
1302 #
1303 #      The public Tor network can't be used to reach your local
1304 #      network, if you need to access local servers you therefore
1305 #      might want to make some exceptions:
1306 #
1307 #        forward         192.168.*.*/     .
1308 #        forward            10.*.*.*/     .
1309 #        forward           127.*.*.*/     .
1310 #
1311 #      Unencrypted connections to systems in these address ranges
1312 #      will be as (un)secure as the local network is, but the
1313 #      alternative is that you can't reach the local network through
1314 #      Privoxy at all. Of course this may actually be desired and
1315 #      there is no reason to make these exceptions if you aren't sure
1316 #      you need them.
1317 #
1318 #      If you also want to be able to reach servers in your local
1319 #      network by using their names, you will need additional
1320 #      exceptions that look like this:
1321 #
1322 #       forward           localhost/     .
1323 #
1324 #
1325 #
1326 #  5.3. forwarded-connect-retries
1327 #  ===============================
1328 #
1329 #  Specifies:
1330 #
1331 #      How often Privoxy retries if a forwarded connection request
1332 #      fails.
1333 #
1334 #  Type of value:
1335 #
1336 #      Number of retries.
1337 #
1338 #  Default value:
1339 #
1340 #      0
1341 #
1342 #  Effect if unset:
1343 #
1344 #      Connections forwarded through other proxies are treated like
1345 #      direct connections and no retry attempts are made.
1346 #
1347 #  Notes:
1348 #
1349 #      forwarded-connect-retries is mainly interesting for socks4a
1350 #      connections, where Privoxy can't detect why the connections
1351 #      failed. The connection might have failed because of a DNS
1352 #      timeout in which case a retry makes sense, but it might also
1353 #      have failed because the server doesn't exist or isn't
1354 #      reachable. In this case the retry will just delay the
1355 #      appearance of Privoxy's error message.
1356 #
1357 #      Note that in the context of this option, "forwarded
1358 #      connections" includes all connections that Privoxy forwards
1359 #      through other proxies. This option is not limited to the HTTP
1360 #      CONNECT method.
1361 #
1362 #      Only use this option, if you are getting lots of
1363 #      forwarding-related error messages that go away when you try
1364 #      again manually. Start with a small value and check Privoxy's
1365 #      logfile from time to time, to see how many retries are usually
1366 #      needed.
1367 #
1368 #  Examples:
1369 #
1370 #      forwarded-connect-retries 1
1371 #
1372 forwarded-connect-retries  0
1373 #
1374 #
1375 #  6. MISCELLANEOUS
1376 #  =================
1377 #
1378 #
1379 #  6.1. accept-intercepted-requests
1380 #  =================================
1381 #
1382 #  Specifies:
1383 #
1384 #      Whether intercepted requests should be treated as valid.
1385 #
1386 #  Type of value:
1387 #
1388 #      0 or 1
1389 #
1390 #  Default value:
1391 #
1392 #      0
1393 #
1394 #  Effect if unset:
1395 #
1396 #      Only proxy requests are accepted, intercepted requests are
1397 #      treated as invalid.
1398 #
1399 #  Notes:
1400 #
1401 #      If you don't trust your clients and want to force them to use
1402 #      Privoxy, enable this option and configure your packet filter
1403 #      to redirect outgoing HTTP connections into Privoxy.
1404 #
1405 #      Make sure that Privoxy's own requests aren't redirected as
1406 #      well. Additionally take care that Privoxy can't intentionally
1407 #      connect to itself, otherwise you could run into redirection
1408 #      loops if Privoxy's listening port is reachable by the outside
1409 #      or an attacker has access to the pages you visit.
1410 #
1411 #  Examples:
1412 #
1413 #      accept-intercepted-requests 1
1414 #
1415 accept-intercepted-requests 0
1416 #
1417 #
1418 #  6.2. allow-cgi-request-crunching
1419 #  =================================
1420 #
1421 #  Specifies:
1422 #
1423 #      Whether requests to Privoxy's CGI pages can be blocked or
1424 #      redirected.
1425 #
1426 #  Type of value:
1427 #
1428 #      0 or 1
1429 #
1430 #  Default value:
1431 #
1432 #      0
1433 #
1434 #  Effect if unset:
1435 #
1436 #      Privoxy ignores block and redirect actions for its CGI pages.
1437 #
1438 #  Notes:
1439 #
1440 #      By default Privoxy ignores block or redirect actions for its
1441 #      CGI pages. Intercepting these requests can be useful in
1442 #      multi-user setups to implement fine-grained access control,
1443 #      but it can also render the complete web interface useless and
1444 #      make debugging problems painful if done without care.
1445 #
1446 #      Don't enable this option unless you're sure that you really
1447 #      need it.
1448 #
1449 #  Examples:
1450 #
1451 #      allow-cgi-request-crunching 1
1452 #
1453 allow-cgi-request-crunching 0
1454 #
1455 #
1456 #  6.3. split-large-forms
1457 #  =======================
1458 #
1459 #  Specifies:
1460 #
1461 #      Whether the CGI interface should stay compatible with broken
1462 #      HTTP clients.
1463 #
1464 #  Type of value:
1465 #
1466 #      0 or 1
1467 #
1468 #  Default value:
1469 #
1470 #      0
1471 #
1472 #  Effect if unset:
1473 #
1474 #      The CGI form generate long GET URLs.
1475 #
1476 #  Notes:
1477 #
1478 #      Privoxy's CGI forms can lead to rather long URLs. This isn't a
1479 #      problem as far as the HTTP standard is concerned, but it can
1480 #      confuse clients with arbitrary URL length limitations.
1481 #
1482 #      Enabling split-large-forms causes Privoxy to divide big forms
1483 #      into smaller ones to keep the URL length down. It makes
1484 #      editing a lot less convenient and you can no longer submit all
1485 #      changes at once, but at least it works around this browser
1486 #      bug.
1487 #
1488 #      If you don't notice any editing problems, there is no reason
1489 #      to enable this option, but if one of the submit buttons
1490 #      appears to be broken, you should give it a try.
1491 #
1492 #  Examples:
1493 #
1494 #      split-large-forms 1
1495 #
1496 split-large-forms 0
1497 #
1498 #
1499 #  6.4. keep-alive-timeout
1500 #  ========================
1501 #
1502 #  Specifies:
1503 #
1504 #      Number of seconds after which an open connection will no
1505 #      longer be reused.
1506 #
1507 #  Type of value:
1508 #
1509 #      Time in seconds.
1510 #
1511 #  Default value:
1512 #
1513 #      None
1514 #
1515 #  Effect if unset:
1516 #
1517 #      Connections are not kept alive.
1518 #
1519 #  Notes:
1520 #
1521 #      This option allows clients to keep the connection to Privoxy
1522 #      alive. If the server supports it, Privoxy will keep the
1523 #      connection to the server alive as well. Under certain
1524 #      circumstances this may result in speed-ups.
1525 #
1526 #      By default, Privoxy will close the connection to the server if
1527 #      the client connection gets closed, or if the specified timeout
1528 #      has been reached without a new request coming in. This
1529 #      behaviour can be changed with the connection-sharing option.
1530 #
1531 #      This option has no effect if Privoxy has been compiled without
1532 #      keep-alive support.
1533 #
1534 #      Note that a timeout of five seconds as used in the default
1535 #      configuration file significantly decreases the number of
1536 #      connections that will be reused. The value is used because
1537 #      some browsers limit the number of connections they open to a
1538 #      single host and apply the same limit to proxies. This can
1539 #      result in a single website "grabbing" all the connections the
1540 #      browser allows, which means connections to other websites
1541 #      can't be opened until the connections currently in use time
1542 #      out.
1543 #
1544 #      Several users have reported this as a Privoxy bug, so the
1545 #      default value has been reduced. Consider increasing it to 300
1546 #      seconds or even more if you think your browser can handle it.
1547 #      If your browser appears to be hanging, it probably can't.
1548 #
1549 #  Examples:
1550 #
1551 #      keep-alive-timeout 300
1552 #
1553 keep-alive-timeout 5
1554 #
1555 #
1556 #  6.5. tolerate-pipelining
1557 #  =========================
1558 #
1559 #  Specifies:
1560 #
1561 #      Whether or not pipelined requests should be served.
1562 #
1563 #  Type of value:
1564 #
1565 #      0 or 1.
1566 #
1567 #  Default value:
1568 #
1569 #      None
1570 #
1571 #  Effect if unset:
1572 #
1573 #      If Privoxy receives more than one request at once, it
1574 #      terminates the client connection after serving the first one.
1575 #
1576 #  Notes:
1577 #
1578 #      Privoxy currently doesn't pipeline outgoing requests, thus
1579 #      allowing pipelining on the client connection is not guaranteed
1580 #      to improve the performance.
1581 #
1582 #      By default Privoxy tries to discourage clients from pipelining
1583 #      by discarding aggressively pipelined requests, which forces
1584 #      the client to resend them through a new connection.
1585 #
1586 #      This option lets Privoxy tolerate pipelining. Whether or not
1587 #      that improves performance mainly depends on the client
1588 #      configuration.
1589 #
1590 #      If you are seeing problems with pages not properly loading,
1591 #      disabling this option could work around the problem.
1592 #
1593 #  Examples:
1594 #
1595 #      tolerate-pipelining 1
1596 #
1597 tolerate-pipelining 1
1598 #
1599 #
1600 #  6.6. default-server-timeout
1601 #  ============================
1602 #
1603 #  Specifies:
1604 #
1605 #      Assumed server-side keep-alive timeout if not specified by the
1606 #      server.
1607 #
1608 #  Type of value:
1609 #
1610 #      Time in seconds.
1611 #
1612 #  Default value:
1613 #
1614 #      None
1615 #
1616 #  Effect if unset:
1617 #
1618 #      Connections for which the server didn't specify the keep-alive
1619 #      timeout are not reused.
1620 #
1621 #  Notes:
1622 #
1623 #      Enabling this option significantly increases the number of
1624 #      connections that are reused, provided the keep-alive-timeout
1625 #      option is also enabled.
1626 #
1627 #      While it also increases the number of connections problems
1628 #      when Privoxy tries to reuse a connection that already has been
1629 #      closed on the server side, or is closed while Privoxy is
1630 #      trying to reuse it, this should only be a problem if it
1631 #      happens for the first request sent by the client. If it
1632 #      happens for requests on reused client connections, Privoxy
1633 #      will simply close the connection and the client is supposed to
1634 #      retry the request without bothering the user.
1635 #
1636 #      Enabling this option is therefore only recommended if the
1637 #      connection-sharing option is disabled.
1638 #
1639 #      It is an error to specify a value larger than the
1640 #      keep-alive-timeout value.
1641 #
1642 #      This option has no effect if Privoxy has been compiled without
1643 #      keep-alive support.
1644 #
1645 #  Examples:
1646 #
1647 #      default-server-timeout 60
1648 #
1649 #default-server-timeout 60
1650 #
1651 #
1652 #  6.7. connection-sharing
1653 #  ========================
1654 #
1655 #  Specifies:
1656 #
1657 #      Whether or not outgoing connections that have been kept alive
1658 #      should be shared between different incoming connections.
1659 #
1660 #  Type of value:
1661 #
1662 #      0 or 1
1663 #
1664 #  Default value:
1665 #
1666 #      None
1667 #
1668 #  Effect if unset:
1669 #
1670 #      Connections are not shared.
1671 #
1672 #  Notes:
1673 #
1674 #      This option has no effect if Privoxy has been compiled without
1675 #      keep-alive support, or if it's disabled.
1676 #
1677 #  Notes:
1678 #
1679 #      Note that reusing connections doesn't necessary cause
1680 #      speedups. There are also a few privacy implications you should
1681 #      be aware of.
1682 #
1683 #      If this option is effective, outgoing connections are shared
1684 #      between clients (if there are more than one) and closing the
1685 #      browser that initiated the outgoing connection does no longer
1686 #      affect the connection between Privoxy and the server unless
1687 #      the client's request hasn't been completed yet.
1688 #
1689 #      If the outgoing connection is idle, it will not be closed
1690 #      until either Privoxy's or the server's timeout is reached.
1691 #      While it's open, the server knows that the system running
1692 #      Privoxy is still there.
1693 #
1694 #      If there are more than one client (maybe even belonging to
1695 #      multiple users), they will be able to reuse each others
1696 #      connections. This is potentially dangerous in case of
1697 #      authentication schemes like NTLM where only the connection is
1698 #      authenticated, instead of requiring authentication for each
1699 #      request.
1700 #
1701 #      If there is only a single client, and if said client can keep
1702 #      connections alive on its own, enabling this option has next to
1703 #      no effect. If the client doesn't support connection
1704 #      keep-alive, enabling this option may make sense as it allows
1705 #      Privoxy to keep outgoing connections alive even if the client
1706 #      itself doesn't support it.
1707 #
1708 #      You should also be aware that enabling this option increases
1709 #      the likelihood of getting the "No server or forwarder data"
1710 #      error message, especially if you are using a slow connection
1711 #      to the Internet.
1712 #
1713 #      This option should only be used by experienced users who
1714 #      understand the risks and can weight them against the benefits.
1715 #
1716 #  Examples:
1717 #
1718 #      connection-sharing 1
1719 #
1720 #connection-sharing 1
1721 #
1722 #
1723 #  6.8. socket-timeout
1724 #  ====================
1725 #
1726 #  Specifies:
1727 #
1728 #      Number of seconds after which a socket times out if no data is
1729 #      received.
1730 #
1731 #  Type of value:
1732 #
1733 #      Time in seconds.
1734 #
1735 #  Default value:
1736 #
1737 #      None
1738 #
1739 #  Effect if unset:
1740 #
1741 #      A default value of 300 seconds is used.
1742 #
1743 #  Notes:
1744 #
1745 #      The default is quite high and you probably want to reduce it.
1746 #      If you aren't using an occasionally slow proxy like Tor,
1747 #      reducing it to a few seconds should be fine.
1748 #
1749 #  Examples:
1750 #
1751 #      socket-timeout 300
1752 #
1753 socket-timeout 300
1754 #
1755 #
1756 #  6.9. max-client-connections
1757 #  ============================
1758 #
1759 #  Specifies:
1760 #
1761 #      Maximum number of client connections that will be served.
1762 #
1763 #  Type of value:
1764 #
1765 #      Positive number.
1766 #
1767 #  Default value:
1768 #
1769 #      None
1770 #
1771 #  Effect if unset:
1772 #
1773 #      Connections are served until a resource limit is reached.
1774 #
1775 #  Notes:
1776 #
1777 #      Privoxy creates one thread (or process) for every incoming
1778 #      client connection that isn't rejected based on the access
1779 #      control settings.
1780 #
1781 #      If the system is powerful enough, Privoxy can theoretically
1782 #      deal with several hundred (or thousand) connections at the
1783 #      same time, but some operating systems enforce resource limits
1784 #      by shutting down offending processes and their default limits
1785 #      may be below the ones Privoxy would require under heavy load.
1786 #
1787 #      Configuring Privoxy to enforce a connection limit below the
1788 #      thread or process limit used by the operating system makes
1789 #      sure this doesn't happen. Simply increasing the operating
1790 #      system's limit would work too, but if Privoxy isn't the only
1791 #      application running on the system, you may actually want to
1792 #      limit the resources used by Privoxy.
1793 #
1794 #      If Privoxy is only used by a single trusted user, limiting the
1795 #      number of client connections is probably unnecessary. If there
1796 #      are multiple possibly untrusted users you probably still want
1797 #      to additionally use a packet filter to limit the maximal
1798 #      number of incoming connections per client. Otherwise a
1799 #      malicious user could intentionally create a high number of
1800 #      connections to prevent other users from using Privoxy.
1801 #
1802 #      Obviously using this option only makes sense if you choose a
1803 #      limit below the one enforced by the operating system.
1804 #
1805 #  Examples:
1806 #
1807 #      max-client-connections 256
1808 #
1809 #max-client-connections 256
1810 #
1811 #  1.6.10. handle-as-empty-doc-returns-ok
1812 #
1813 #  Specifies:
1814 #
1815 #      The status code Privoxy returns for pages blocked with
1816 #      +handle-as-empty-document.
1817 #
1818 #  Type of value:
1819 #
1820 #      0 or 1
1821 #
1822 #  Default value:
1823 #
1824 #      0
1825 #
1826 #  Effect if unset:
1827 #
1828 #      Privoxy returns a status 403(forbidden) for all blocked pages.
1829 #
1830 #  Effect if set:
1831 #
1832 #      Privoxy returns a status 200(OK) for pages blocked with
1833 #      +handle-as-empty-document and a status 403(Forbidden) for all
1834 #      other blocked pages.
1835 #
1836 #  Notes:
1837 #
1838 #      This is a work-around for Firefox bug 492459: " Websites are
1839 #      no longer rendered if SSL requests for JavaScripts are blocked
1840 #      by a proxy. " (https://bugzilla.mozilla.org/show_bug.cgi?id=
1841 #      492459) As the bug has been fixed for quite some time this
1842 #      option should no longer be needed and will be removed in a
1843 #      future release. Please speak up if you have a reason why the
1844 #      option should be kept around.
1845 #
1846 #handle-as-empty-doc-returns-ok 1
1847 #
1848 #  1.6.11. enable-compression
1849 #
1850 #  Specifies:
1851 #
1852 #      Whether or not buffered content is compressed before delivery.
1853 #
1854 #  Type of value:
1855 #
1856 #      0 or 1
1857 #
1858 #  Default value:
1859 #
1860 #      0
1861 #
1862 #  Effect if unset:
1863 #
1864 #      Privoxy does not compress buffered content.
1865 #
1866 #  Effect if set:
1867 #
1868 #      Privoxy compresses buffered content before delivering it to
1869 #      the client, provided the client supports it.
1870 #
1871 #  Notes:
1872 #
1873 #      This directive is only supported if Privoxy has been compiled
1874 #      with FEATURE_COMPRESSION, which should not to be confused with
1875 #      FEATURE_ZLIB.
1876 #
1877 #      Compressing buffered content is mainly useful if Privoxy and
1878 #      the client are running on different systems. If they are
1879 #      running on the same system, enabling compression is likely to
1880 #      slow things down. If you didn't measure otherwise, you should
1881 #      assume that it does and keep this option disabled.
1882 #
1883 #      Privoxy will not compress buffered content below a certain
1884 #      length.
1885 #
1886 #enable-compression 1
1887 #
1888 #  1.6.12. compression-level
1889 #
1890 #  Specifies:
1891 #
1892 #      The compression level that is passed to the zlib library when
1893 #      compressing buffered content.
1894 #
1895 #  Type of value:
1896 #
1897 #      Positive number ranging from 0 to 9.
1898 #
1899 #  Default value:
1900 #
1901 #      1
1902 #
1903 #  Notes:
1904 #
1905 #      Compressing the data more takes usually longer than
1906 #      compressing it less or not compressing it at all. Which level
1907 #      is best depends on the connection between Privoxy and the
1908 #      client. If you can't be bothered to benchmark it for yourself,
1909 #      you should stick with the default and keep compression
1910 #      disabled.
1911 #
1912 #      If compression is disabled, the compression level is
1913 #      irrelevant.
1914 #
1915 #  Examples:
1916 #
1917 #          # Best speed (compared to the other levels)
1918 #          compression-level 1
1919 #
1920 #          # Best compression
1921 #          compression-level 9
1922 #
1923 #          # No compression. Only useful for testing as the added header
1924 #          # slightly increases the amount of data that has to be sent.
1925 #          # If your benchmark shows that using this compression level
1926 #          # is superior to using no compression at all, the benchmark
1927 #          # is likely to be flawed.
1928 #          compression-level 0
1929 #
1930 #
1931 #compression-level 1
1932 #
1933 #  1.6.13. client-header-order
1934 #
1935 #  Specifies:
1936 #
1937 #      The order in which client headers are sorted before forwarding
1938 #      them.
1939 #
1940 #  Type of value:
1941 #
1942 #      Client header names delimited by spaces or tabs
1943 #
1944 #  Default value:
1945 #
1946 #      None
1947 #
1948 #  Notes:
1949 #
1950 #      By default Privoxy leaves the client headers in the order they
1951 #      were sent by the client. Headers are modified in-place, new
1952 #      headers are added at the end of the already existing headers.
1953 #
1954 #      The header order can be used to fingerprint client requests
1955 #      independently of other headers like the User-Agent.
1956 #
1957 #      This directive allows to sort the headers differently to
1958 #      better mimic a different User-Agent. Client headers will be
1959 #      emitted in the order given, headers whose name isn't
1960 #      explicitly specified are added at the end.
1961 #
1962 #      Note that sorting headers in an uncommon way will make
1963 #      fingerprinting actually easier. Encrypted headers are not
1964 #      affected by this directive.
1965 #
1966 #client-header-order Host \
1967 #   Accept \
1968 #   Accept-Language \
1969 #   Accept-Encoding \
1970 #   Proxy-Connection \
1971 #   Referer \
1972 #   Cookie \
1973 #   If-Modified-Since \
1974 #   Cache-Control \
1975 #   Content-Length \
1976 #   Content-Type
1977 #
1978 #
1979 #
1980 #  7. WINDOWS GUI OPTIONS
1981 #  =======================
1982 #
1983 #  Privoxy has a number of options specific to the Windows GUI
1984 #  interface:
1985 #
1986 #
1987 #
1988 #  If "activity-animation" is set to 1, the Privoxy icon will animate
1989 #  when "Privoxy" is active. To turn off, set to 0.
1990 #
1991 #activity-animation   1
1992 #
1993 #
1994 #
1995 #  If "log-messages" is set to 1, Privoxy copies log messages to the
1996 #  console window. The log detail depends on the debug directive.
1997 #
1998 #log-messages   1
1999 #
2000 #
2001 #
2002 #  If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2003 #  the amount of memory used for the log messages displayed in the
2004 #  console window, will be limited to "log-max-lines" (see below).
2005 #
2006 #  Warning: Setting this to 0 will result in the buffer to grow
2007 #  infinitely and eat up all your memory!
2008 #
2009 #log-buffer-size 1
2010 #
2011 #
2012 #
2013 #  log-max-lines is the maximum number of lines held in the log
2014 #  buffer. See above.
2015 #
2016 #log-max-lines 200
2017 #
2018 #
2019 #
2020 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
2021 #  portions of the log messages with a bold-faced font:
2022 #
2023 #log-highlight-messages 1
2024 #
2025 #
2026 #
2027 #  The font used in the console window:
2028 #
2029 #log-font-name Comic Sans MS
2030 #
2031 #
2032 #
2033 #  Font size used in the console window:
2034 #
2035 #log-font-size 8
2036 #
2037 #
2038 #
2039 #  "show-on-task-bar" controls whether or not Privoxy will appear as
2040 #  a button on the Task bar when minimized:
2041 #
2042 #show-on-task-bar 0
2043 #
2044 #
2045 #
2046 #  If "close-button-minimizes" is set to 1, the Windows close button
2047 #  will minimize Privoxy instead of closing the program (close with
2048 #  the exit option on the File menu).
2049 #
2050 #close-button-minimizes 1
2051 #
2052 #
2053 #
2054 #  The "hide-console" option is specific to the MS-Win console
2055 #  version of Privoxy. If this option is used, Privoxy will
2056 #  disconnect from and hide the command console.
2057 #
2058 #hide-console
2059 #
2060 #
2061 #