Regenerate config file
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy 3.0.29
2 #
3 # Copyright (C) 2001-2019 Privoxy Developers https://www.privoxy.org/
4 #
5 #####################################################################
6 #                                                                   #
7 #                      Table of Contents                            #
8 #                                                                   #
9 #        I. INTRODUCTION                                            #
10 #       II. FORMAT OF THE CONFIGURATION FILE                        #
11 #                                                                   #
12 #        1. LOCAL SET-UP DOCUMENTATION                              #
13 #        2. CONFIGURATION AND LOG FILE LOCATIONS                    #
14 #        3. DEBUGGING                                               #
15 #        4. ACCESS CONTROL AND SECURITY                             #
16 #        5. FORWARDING                                              #
17 #        6. MISCELLANEOUS                                           #
18 #        7. WINDOWS GUI OPTIONS                                     #
19 #                                                                   #
20 #####################################################################
21 #
22 #
23 #  I. INTRODUCTION
24 #   ===============
25 #
26 #  This file holds Privoxy's main configuration. Privoxy detects
27 #  configuration changes automatically, so you don't have to restart
28 #  it unless you want to load a different configuration file.
29 #
30 #  The configuration will be reloaded with the first request after
31 #  the change was done, this request itself will still use the old
32 #  configuration, though. In other words: it takes two requests
33 #  before you see the result of your changes. Requests that are
34 #  dropped due to ACL don't trigger reloads.
35 #
36 #  When starting Privoxy on Unix systems, give the location of this
37 #  file as last argument. On Windows systems, Privoxy will look for
38 #  this file with the name 'config.txt' in the current working
39 #  directory of the Privoxy process.
40 #
41 #
42 #  II. FORMAT OF THE CONFIGURATION FILE
43 #  ====================================
44 #
45 #  Configuration lines consist of an initial keyword followed by a
46 #  list of values, all separated by whitespace (any number of spaces
47 #  or tabs). For example,
48 #
49 #  actionsfile default.action
50 #
51 #  Indicates that the actionsfile is named 'default.action'.
52 #
53 #  The '#' indicates a comment. Any part of a line following a '#' is
54 #  ignored, except if the '#' is preceded by a '\'.
55 #
56 #  Thus, by placing a # at the start of an existing configuration
57 #  line, you can make it a comment and it will be treated as if it
58 #  weren't there. This is called "commenting out" an option and can
59 #  be useful. Removing the # again is called "uncommenting".
60 #
61 #  Note that commenting out an option and leaving it at its default
62 #  are two completely different things! Most options behave very
63 #  differently when unset. See the "Effect if unset" explanation in
64 #  each option's description for details.
65 #
66 #  Long lines can be continued on the next line by using a `\' as the
67 #  last character.
68 #
69 #
70 #  1. LOCAL SET-UP DOCUMENTATION
71 #  ==============================
72 #
73 #  If you intend to operate Privoxy for more users than just
74 #  yourself, it might be a good idea to let them know how to reach
75 #  you, what you block and why you do that, your policies, etc.
76 #
77 #
78 #  1.1. user-manual
79 #  =================
80 #
81 #  Specifies:
82 #
83 #      Location of the Privoxy User Manual.
84 #
85 #  Type of value:
86 #
87 #      A fully qualified URI
88 #
89 #  Default value:
90 #
91 #      Unset
92 #
93 #  Effect if unset:
94 #
95 #      https://www.privoxy.org/version/user-manual/ will be used,
96 #      where version is the Privoxy version.
97 #
98 #  Notes:
99 #
100 #      The User Manual URI is the single best source of information
101 #      on Privoxy, and is used for help links from some of the
102 #      internal CGI pages. The manual itself is normally packaged
103 #      with the binary distributions, so you probably want to set
104 #      this to a locally installed copy.
105 #
106 #      Examples:
107 #
108 #      The best all purpose solution is simply to put the full local
109 #      PATH to where the User Manual is located:
110 #
111 #        user-manual  /usr/share/doc/privoxy/user-manual
112 #
113 #      The User Manual is then available to anyone with access to
114 #      Privoxy, by following the built-in URL: http://
115 #      config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
116 #      user-manual/).
117 #
118 #      If the documentation is not on the local system, it can be
119 #      accessed from a remote server, as:
120 #
121 #        user-manual  http://example.com/privoxy/user-manual/
122 #
123 #      WARNING!!!
124 #
125 #          If set, this option should be the first option in the
126 #          config file, because it is used while the config file is
127 #          being read.
128 #
129 #user-manual https://www.privoxy.org/user-manual/
130 #
131 #  1.2. trust-info-url
132 #  ====================
133 #
134 #  Specifies:
135 #
136 #      A URL to be displayed in the error page that users will see if
137 #      access to an untrusted page is denied.
138 #
139 #  Type of value:
140 #
141 #      URL
142 #
143 #  Default value:
144 #
145 #      Unset
146 #
147 #  Effect if unset:
148 #
149 #      No links are displayed on the "untrusted" error page.
150 #
151 #  Notes:
152 #
153 #      The value of this option only matters if the experimental
154 #      trust mechanism has been activated. (See trustfile below.)
155 #
156 #      If you use the trust mechanism, it is a good idea to write up
157 #      some on-line documentation about your trust policy and to
158 #      specify the URL(s) here. Use multiple times for multiple URLs.
159 #
160 #      The URL(s) should be added to the trustfile as well, so users
161 #      don't end up locked out from the information on why they were
162 #      locked out in the first place!
163 #
164 #trust-info-url  http://www.example.com/why_we_block.html
165 #trust-info-url  http://www.example.com/what_we_allow.html
166 #
167 #  1.3. admin-address
168 #  ===================
169 #
170 #  Specifies:
171 #
172 #      An email address to reach the Privoxy administrator.
173 #
174 #  Type of value:
175 #
176 #      Email address
177 #
178 #  Default value:
179 #
180 #      Unset
181 #
182 #  Effect if unset:
183 #
184 #      No email address is displayed on error pages and the CGI user
185 #      interface.
186 #
187 #  Notes:
188 #
189 #      If both admin-address and proxy-info-url are unset, the whole
190 #      "Local Privoxy Support" box on all generated pages will not be
191 #      shown.
192 #
193 #admin-address privoxy-admin@example.com
194 #
195 #  1.4. proxy-info-url
196 #  ====================
197 #
198 #  Specifies:
199 #
200 #      A URL to documentation about the local Privoxy setup,
201 #      configuration or policies.
202 #
203 #  Type of value:
204 #
205 #      URL
206 #
207 #  Default value:
208 #
209 #      Unset
210 #
211 #  Effect if unset:
212 #
213 #      No link to local documentation is displayed on error pages and
214 #      the CGI user interface.
215 #
216 #  Notes:
217 #
218 #      If both admin-address and proxy-info-url are unset, the whole
219 #      "Local Privoxy Support" box on all generated pages will not be
220 #      shown.
221 #
222 #      This URL shouldn't be blocked ;-)
223 #
224 #proxy-info-url http://www.example.com/proxy-service.html
225 #
226 #  2. CONFIGURATION AND LOG FILE LOCATIONS
227 #  ========================================
228 #
229 #  Privoxy can (and normally does) use a number of other files for
230 #  additional configuration, help and logging. This section of the
231 #  configuration file tells Privoxy where to find those other files.
232 #
233 #  The user running Privoxy, must have read permission for all
234 #  configuration files, and write permission to any files that would
235 #  be modified, such as log files and actions files.
236 #
237 #
238 #  2.1. confdir
239 #  =============
240 #
241 #  Specifies:
242 #
243 #      The directory where the other configuration files are located.
244 #
245 #  Type of value:
246 #
247 #      Path name
248 #
249 #  Default value:
250 #
251 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
252 #
253 #  Effect if unset:
254 #
255 #      Mandatory
256 #
257 #  Notes:
258 #
259 #      No trailing "/", please.
260 #
261 confdir .
262 #
263 #  2.2. templdir
264 #  ==============
265 #
266 #  Specifies:
267 #
268 #      An alternative directory where the templates are loaded from.
269 #
270 #  Type of value:
271 #
272 #      Path name
273 #
274 #  Default value:
275 #
276 #      unset
277 #
278 #  Effect if unset:
279 #
280 #      The templates are assumed to be located in confdir/template.
281 #
282 #  Notes:
283 #
284 #      Privoxy's original templates are usually overwritten with each
285 #      update. Use this option to relocate customized templates that
286 #      should be kept. As template variables might change between
287 #      updates, you shouldn't expect templates to work with Privoxy
288 #      releases other than the one they were part of, though.
289 #
290 #templdir .
291 #
292 #  2.3. temporary-directory
293 #  =========================
294 #
295 #  Specifies:
296 #
297 #      A directory where Privoxy can create temporary files.
298 #
299 #  Type of value:
300 #
301 #      Path name
302 #
303 #  Default value:
304 #
305 #      unset
306 #
307 #  Effect if unset:
308 #
309 #      No temporary files are created, external filters don't work.
310 #
311 #  Notes:
312 #
313 #      To execute external filters, Privoxy has to create temporary
314 #      files. This directive specifies the directory the temporary
315 #      files should be written to.
316 #
317 #      It should be a directory only Privoxy (and trusted users) can
318 #      access.
319 #
320 #temporary-directory .
321 #
322 #  2.4. logdir
323 #  ============
324 #
325 #  Specifies:
326 #
327 #      The directory where all logging takes place (i.e. where the
328 #      logfile is located).
329 #
330 #  Type of value:
331 #
332 #      Path name
333 #
334 #  Default value:
335 #
336 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
337 #
338 #  Effect if unset:
339 #
340 #      Mandatory
341 #
342 #  Notes:
343 #
344 #      No trailing "/", please.
345 #
346 logdir .
347 #
348 #  2.5. actionsfile
349 #  =================
350 #
351 #  Specifies:
352 #
353 #      The actions file(s) to use
354 #
355 #  Type of value:
356 #
357 #      Complete file name, relative to confdir
358 #
359 #  Default values:
360 #
361 #        match-all.action # Actions that are applied to all sites and maybe overruled later on.
362 #
363 #        default.action   # Main actions file
364 #
365 #        user.action      # User customizations
366 #
367 #  Effect if unset:
368 #
369 #      No actions are taken at all. More or less neutral proxying.
370 #
371 #  Notes:
372 #
373 #      Multiple actionsfile lines are permitted, and are in fact
374 #      recommended!
375 #
376 #      The default values are default.action, which is the "main"
377 #      actions file maintained by the developers, and user.action,
378 #      where you can make your personal additions.
379 #
380 #      Actions files contain all the per site and per URL
381 #      configuration for ad blocking, cookie management, privacy
382 #      considerations, etc.
383 #
384 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
385 actionsfile default.action   # Main actions file
386 actionsfile user.action      # User customizations
387 #
388 #  2.6. filterfile
389 #  ================
390 #
391 #  Specifies:
392 #
393 #      The filter file(s) to use
394 #
395 #  Type of value:
396 #
397 #      File name, relative to confdir
398 #
399 #  Default value:
400 #
401 #      default.filter (Unix) or default.filter.txt (Windows)
402 #
403 #  Effect if unset:
404 #
405 #      No textual content filtering takes place, i.e. all +filter{name}
406 #      actions in the actions files are turned neutral.
407 #
408 #  Notes:
409 #
410 #      Multiple filterfile lines are permitted.
411 #
412 #      The filter files contain content modification rules that use
413 #      regular expressions. These rules permit powerful changes on
414 #      the content of Web pages, and optionally the headers as well,
415 #      e.g., you could try to disable your favorite JavaScript
416 #      annoyances, re-write the actual displayed text, or just have
417 #      some fun playing buzzword bingo with web pages.
418 #
419 #      The +filter{name} actions rely on the relevant filter (name)
420 #      to be defined in a filter file!
421 #
422 #      A pre-defined filter file called default.filter that contains
423 #      a number of useful filters for common problems is included in
424 #      the distribution. See the section on the filter action for a
425 #      list.
426 #
427 #      It is recommended to place any locally adapted filters into a
428 #      separate file, such as user.filter.
429 #
430 filterfile default.filter
431 filterfile user.filter      # User customizations
432 #
433 #  2.7. logfile
434 #  =============
435 #
436 #  Specifies:
437 #
438 #      The log file to use
439 #
440 #  Type of value:
441 #
442 #      File name, relative to logdir
443 #
444 #  Default value:
445 #
446 #      Unset (commented out). When activated: logfile (Unix) or
447 #      privoxy.log (Windows).
448 #
449 #  Effect if unset:
450 #
451 #      No logfile is written.
452 #
453 #  Notes:
454 #
455 #      The logfile is where all logging and error messages are
456 #      written. The level of detail and number of messages are set
457 #      with the debug option (see below). The logfile can be useful
458 #      for tracking down a problem with Privoxy (e.g., it's not
459 #      blocking an ad you think it should block) and it can help you
460 #      to monitor what your browser is doing.
461 #
462 #      Depending on the debug options below, the logfile may be a
463 #      privacy risk if third parties can get access to it. As most
464 #      users will never look at it, Privoxy only logs fatal errors by
465 #      default.
466 #
467 #      For most troubleshooting purposes, you will have to change
468 #      that, please refer to the debugging section for details.
469 #
470 #      Any log files must be writable by whatever user Privoxy is
471 #      being run as (on Unix, default user id is "privoxy").
472 #
473 #      To prevent the logfile from growing indefinitely, it is
474 #      recommended to periodically rotate or shorten it. Many
475 #      operating systems support log rotation out of the box, some
476 #      require additional software to do it. For details, please
477 #      refer to the documentation for your operating system.
478 #
479 logfile logfile
480 #
481 #  2.8. trustfile
482 #  ===============
483 #
484 #  Specifies:
485 #
486 #      The name of the trust file to use
487 #
488 #  Type of value:
489 #
490 #      File name, relative to confdir
491 #
492 #  Default value:
493 #
494 #      Unset (commented out). When activated: trust (Unix) or
495 #      trust.txt (Windows)
496 #
497 #  Effect if unset:
498 #
499 #      The entire trust mechanism is disabled.
500 #
501 #  Notes:
502 #
503 #      The trust mechanism is an experimental feature for building
504 #      white-lists and should be used with care. It is NOT
505 #      recommended for the casual user.
506 #
507 #      If you specify a trust file, Privoxy will only allow access to
508 #      sites that are specified in the trustfile. Sites can be listed
509 #      in one of two ways:
510 #
511 #      Prepending a ~ character limits access to this site only (and
512 #      any sub-paths within this site), e.g. ~www.example.com allows
513 #      access to ~www.example.com/features/news.html, etc.
514 #
515 #      Or, you can designate sites as trusted referrers, by
516 #      prepending the name with a + character. The effect is that
517 #      access to untrusted sites will be granted -- but only if a
518 #      link from this trusted referrer was used to get there. The
519 #      link target will then be added to the "trustfile" so that
520 #      future, direct accesses will be granted. Sites added via this
521 #      mechanism do not become trusted referrers themselves (i.e.
522 #      they are added with a ~ designation). There is a limit of 512
523 #      such entries, after which new entries will not be made.
524 #
525 #      If you use the + operator in the trust file, it may grow
526 #      considerably over time.
527 #
528 #      It is recommended that Privoxy be compiled with the
529 #      --disable-force, --disable-toggle and --disable-editor
530 #      options, if this feature is to be used.
531 #
532 #      Possible applications include limiting Internet access for
533 #      children.
534 #
535 #trustfile trust
536 #
537 #  3. DEBUGGING
538 #  =============
539 #
540 #  These options are mainly useful when tracing a problem. Note that
541 #  you might also want to invoke Privoxy with the --no-daemon command
542 #  line option when debugging.
543 #
544 #
545 #  3.1. debug
546 #  ===========
547 #
548 #  Specifies:
549 #
550 #      Key values that determine what information gets logged.
551 #
552 #  Type of value:
553 #
554 #      Integer values
555 #
556 #  Default value:
557 #
558 #      0 (i.e.: only fatal errors (that cause Privoxy to exit) are
559 #      logged)
560 #
561 #  Effect if unset:
562 #
563 #      Default value is used (see above).
564 #
565 #  Notes:
566 #
567 #      The available debug levels are:
568 #
569 #        debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
570 #        debug     2 # show each connection status
571 #        debug     4 # show I/O status
572 #        debug     8 # show header parsing
573 #        debug    16 # log all data written to the network
574 #        debug    32 # debug force feature
575 #        debug    64 # debug regular expression filters
576 #        debug   128 # debug redirects
577 #        debug   256 # debug GIF de-animation
578 #        debug   512 # Common Log Format
579 #        debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
580 #        debug  2048 # CGI user interface
581 #        debug  4096 # Startup banner and warnings.
582 #        debug  8192 # Non-fatal errors
583 #        debug 32768 # log all data read from the network
584 #        debug 65536 # Log the applying actions
585 #
586 #      To select multiple debug levels, you can either add them or
587 #      use multiple debug lines.
588 #
589 #      A debug level of 1 is informative because it will show you
590 #      each request as it happens. 1, 1024, 4096 and 8192 are
591 #      recommended so that you will notice when things go wrong. The
592 #      other levels are probably only of interest if you are hunting
593 #      down a specific problem. They can produce a hell of an output
594 #      (especially 16).
595 #
596 #      If you are used to the more verbose settings, simply enable
597 #      the debug lines below again.
598 #
599 #      If you want to use pure CLF (Common Log Format), you should
600 #      set "debug 512" ONLY and not enable anything else.
601 #
602 #      Privoxy has a hard-coded limit for the length of log messages.
603 #      If it's reached, messages are logged truncated and marked with
604 #      "... [too long, truncated]".
605 #
606 #      Please don't file any support requests without trying to
607 #      reproduce the problem with increased debug level first. Once
608 #      you read the log messages, you may even be able to solve the
609 #      problem on your own.
610 #
611 #debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
612 #debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
613 #debug  4096 # Startup banner and warnings
614 #debug  8192 # Non-fatal errors
615 #
616 #  3.2. single-threaded
617 #  =====================
618 #
619 #  Specifies:
620 #
621 #      Whether to run only one server thread.
622 #
623 #  Type of value:
624 #
625 #      1 or 0
626 #
627 #  Default value:
628 #
629 #      0
630 #
631 #  Effect if unset:
632 #
633 #      Multi-threaded (or, where unavailable: forked) operation, i.e.
634 #      the ability to serve multiple requests simultaneously.
635 #
636 #  Notes:
637 #
638 #      This option is only there for debugging purposes. It will
639 #      drastically reduce performance.
640 #
641 #single-threaded 1
642 #
643 #  3.3. hostname
644 #  ==============
645 #
646 #  Specifies:
647 #
648 #      The hostname shown on the CGI pages.
649 #
650 #  Type of value:
651 #
652 #      Text
653 #
654 #  Default value:
655 #
656 #      Unset
657 #
658 #  Effect if unset:
659 #
660 #      The hostname provided by the operating system is used.
661 #
662 #  Notes:
663 #
664 #      On some misconfigured systems resolving the hostname fails or
665 #      takes too much time and slows Privoxy down. Setting a fixed
666 #      hostname works around the problem.
667 #
668 #      In other circumstances it might be desirable to show a
669 #      hostname other than the one returned by the operating system.
670 #      For example if the system has several different hostnames and
671 #      you don't want to use the first one.
672 #
673 #      Note that Privoxy does not validate the specified hostname
674 #      value.
675 #
676 #hostname hostname.example.org
677 #
678 #  4. ACCESS CONTROL AND SECURITY
679 #  ===============================
680 #
681 #  This section of the config file controls the security-relevant
682 #  aspects of Privoxy's configuration.
683 #
684 #
685 #  4.1. listen-address
686 #  ====================
687 #
688 #  Specifies:
689 #
690 #      The address and TCP port on which Privoxy will listen for
691 #      client requests.
692 #
693 #  Type of value:
694 #
695 #      [IP-Address]:Port
696 #
697 #      [Hostname]:Port
698 #
699 #  Default value:
700 #
701 #      127.0.0.1:8118
702 #
703 #  Effect if unset:
704 #
705 #      Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
706 #      suitable and recommended for home users who run Privoxy on the
707 #      same machine as their browser.
708 #
709 #  Notes:
710 #
711 #      You will need to configure your browser(s) to this proxy
712 #      address and port.
713 #
714 #      If you already have another service running on port 8118, or
715 #      if you want to serve requests from other machines (e.g. on
716 #      your local network) as well, you will need to override the
717 #      default.
718 #
719 #      You can use this statement multiple times to make Privoxy
720 #      listen on more ports or more IP addresses. Suitable if your
721 #      operating system does not support sharing IPv6 and IPv4
722 #      protocols on the same socket.
723 #
724 #      If a hostname is used instead of an IP address, Privoxy will
725 #      try to resolve it to an IP address and if there are multiple,
726 #      use the first one returned.
727 #
728 #      If the address for the hostname isn't already known on the
729 #      system (for example because it's in /etc/hostname), this may
730 #      result in DNS traffic.
731 #
732 #      If the specified address isn't available on the system, or if
733 #      the hostname can't be resolved, Privoxy will fail to start.
734 #
735 #      IPv6 addresses containing colons have to be quoted by
736 #      brackets. They can only be used if Privoxy has been compiled
737 #      with IPv6 support. If you aren't sure if your version supports
738 #      it, have a look at http://config.privoxy.org/show-status.
739 #
740 #      Some operating systems will prefer IPv6 to IPv4 addresses even
741 #      if the system has no IPv6 connectivity which is usually not
742 #      expected by the user. Some even rely on DNS to resolve
743 #      localhost which mean the "localhost" address used may not
744 #      actually be local.
745 #
746 #      It is therefore recommended to explicitly configure the
747 #      intended IP address instead of relying on the operating
748 #      system, unless there's a strong reason not to.
749 #
750 #      If you leave out the address, Privoxy will bind to all IPv4
751 #      interfaces (addresses) on your machine and may become
752 #      reachable from the Internet and/or the local network. Be aware
753 #      that some GNU/Linux distributions modify that behaviour
754 #      without updating the documentation. Check for non-standard
755 #      patches if your Privoxy version behaves differently.
756 #
757 #      If you configure Privoxy to be reachable from the network,
758 #      consider using access control lists (ACL's, see below), and/or
759 #      a firewall.
760 #
761 #      If you open Privoxy to untrusted users, you will also want to
762 #      make sure that the following actions are disabled:
763 #      enable-edit-actions and enable-remote-toggle
764 #
765 #  Example:
766 #
767 #      Suppose you are running Privoxy on a machine which has the
768 #      address 192.168.0.1 on your local private network
769 #      (192.168.0.0) and has another outside connection with a
770 #      different address. You want it to serve requests from inside
771 #      only:
772 #
773 #        listen-address  192.168.0.1:8118
774 #
775 #      Suppose you are running Privoxy on an IPv6-capable machine and
776 #      you want it to listen on the IPv6 address of the loopback
777 #      device:
778 #
779 #        listen-address [::1]:8118
780 #
781 listen-address  127.0.0.1:8118
782 #
783 #  4.2. toggle
784 #  ============
785 #
786 #  Specifies:
787 #
788 #      Initial state of "toggle" status
789 #
790 #  Type of value:
791 #
792 #      1 or 0
793 #
794 #  Default value:
795 #
796 #      1
797 #
798 #  Effect if unset:
799 #
800 #      Act as if toggled on
801 #
802 #  Notes:
803 #
804 #      If set to 0, Privoxy will start in "toggled off" mode, i.e.
805 #      mostly behave like a normal, content-neutral proxy with both
806 #      ad blocking and content filtering disabled. See
807 #      enable-remote-toggle below.
808 #
809 toggle  1
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 #  4.4. enable-remote-http-toggle
854 #  ===============================
855 #
856 #  Specifies:
857 #
858 #      Whether or not Privoxy recognizes special HTTP headers to
859 #      change its behaviour.
860 #
861 #  Type of value:
862 #
863 #      0 or 1
864 #
865 #  Default value:
866 #
867 #      0
868 #
869 #  Effect if unset:
870 #
871 #      Privoxy ignores special HTTP headers.
872 #
873 #  Notes:
874 #
875 #      When toggled on, the client can change Privoxy's behaviour by
876 #      setting special HTTP headers. Currently the only supported
877 #      special header is "X-Filter: No", to disable filtering for the
878 #      ongoing request, even if it is enabled in one of the action
879 #      files.
880 #
881 #      This feature is disabled by default. If you are using Privoxy
882 #      in a environment with trusted clients, you may enable this
883 #      feature at your discretion. Note that malicious client side
884 #      code (e.g Java) is also capable of using this feature.
885 #
886 #      This option will be removed in future releases as it has been
887 #      obsoleted by the more general header taggers.
888 #
889 enable-remote-http-toggle  0
890 #
891 #  4.5. enable-edit-actions
892 #  =========================
893 #
894 #  Specifies:
895 #
896 #      Whether or not the web-based actions file editor may be used
897 #
898 #  Type of value:
899 #
900 #      0 or 1
901 #
902 #  Default value:
903 #
904 #      0
905 #
906 #  Effect if unset:
907 #
908 #      The web-based actions file editor is disabled.
909 #
910 #  Notes:
911 #
912 #      Access to the editor can not be controlled separately by
913 #      "ACLs" or HTTP authentication, so that everybody who can
914 #      access Privoxy (see "ACLs" and listen-address above) can
915 #      modify its configuration for all users.
916 #
917 #      This option is not recommended for environments with untrusted
918 #      users and as a lot of Privoxy users don't read documentation,
919 #      this feature is disabled by default.
920 #
921 #      Note that malicious client side code (e.g Java) is also
922 #      capable of using the actions editor and you shouldn't enable
923 #      this options unless you understand the consequences and are
924 #      sure your browser is configured correctly.
925 #
926 #      Note that you must have compiled Privoxy with support for this
927 #      feature, otherwise this option has no effect.
928 #
929 enable-edit-actions 0
930 #
931 #  4.6. enforce-blocks
932 #  ====================
933 #
934 #  Specifies:
935 #
936 #      Whether the user is allowed to ignore blocks and can "go there
937 #      anyway".
938 #
939 #  Type of value:
940 #
941 #      0 or 1
942 #
943 #  Default value:
944 #
945 #      0
946 #
947 #  Effect if unset:
948 #
949 #      Blocks are not enforced.
950 #
951 #  Notes:
952 #
953 #      Privoxy is mainly used to block and filter requests as a
954 #      service to the user, for example to block ads and other junk
955 #      that clogs the pipes. Privoxy's configuration isn't perfect
956 #      and sometimes innocent pages are blocked. In this situation it
957 #      makes sense to allow the user to enforce the request and have
958 #      Privoxy ignore the block.
959 #
960 #      In the default configuration Privoxy's "Blocked" page contains
961 #      a "go there anyway" link to adds a special string (the force
962 #      prefix) to the request URL. If that link is used, Privoxy will
963 #      detect the force prefix, remove it again and let the request
964 #      pass.
965 #
966 #      Of course Privoxy can also be used to enforce a network
967 #      policy. In that case the user obviously should not be able to
968 #      bypass any blocks, and that's what the "enforce-blocks" option
969 #      is for. If it's enabled, Privoxy hides the "go there anyway"
970 #      link. If the user adds the force prefix by hand, it will not
971 #      be accepted and the circumvention attempt is logged.
972 #
973 #  Examples:
974 #
975 #      enforce-blocks 1
976 #
977 enforce-blocks 0
978 #
979 #  4.7. ACLs: permit-access and deny-access
980 #  =========================================
981 #
982 #  Specifies:
983 #
984 #      Who can access what.
985 #
986 #  Type of value:
987 #
988 #      src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
989 #
990 #      Where src_addr and dst_addr are IPv4 addresses in dotted
991 #      decimal notation or valid DNS names, port is a port number,
992 #      and src_masklen and dst_masklen are subnet masks in CIDR
993 #      notation, i.e. integer values from 2 to 30 representing the
994 #      length (in bits) of the network address. The masks and the
995 #      whole destination part are optional.
996 #
997 #      If your system implements RFC 3493, then src_addr and dst_addr
998 #      can be IPv6 addresses delimeted by brackets, port can be a
999 #      number or a service name, and src_masklen and dst_masklen can
1000 #      be a number from 0 to 128.
1001 #
1002 #  Default value:
1003 #
1004 #      Unset
1005 #
1006 #      If no port is specified, any port will match. If no
1007 #      src_masklen or src_masklen is given, the complete IP address
1008 #      has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1009 #
1010 #  Effect if unset:
1011 #
1012 #      Don't restrict access further than implied by listen-address
1013 #
1014 #  Notes:
1015 #
1016 #      Access controls are included at the request of ISPs and
1017 #      systems administrators, and are not usually needed by
1018 #      individual users. For a typical home user, it will normally
1019 #      suffice to ensure that Privoxy only listens on the localhost
1020 #      (127.0.0.1) or internal (home) network address by means of the
1021 #      listen-address option.
1022 #
1023 #      Please see the warnings in the FAQ that Privoxy is not
1024 #      intended to be a substitute for a firewall or to encourage
1025 #      anyone to defer addressing basic security weaknesses.
1026 #
1027 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1028 #      only talks to IP addresses that match at least one
1029 #      permit-access line and don't match any subsequent deny-access
1030 #      line. In other words, the last match wins, with the default
1031 #      being deny-access.
1032 #
1033 #      If Privoxy is using a forwarder (see forward below) for a
1034 #      particular destination URL, the dst_addr that is examined is
1035 #      the address of the forwarder and NOT the address of the
1036 #      ultimate target. This is necessary because it may be
1037 #      impossible for the local Privoxy to determine the IP address
1038 #      of the ultimate target (that's often what gateways are used
1039 #      for).
1040 #
1041 #      You should prefer using IP addresses over DNS names, because
1042 #      the address lookups take time. All DNS names must resolve! You
1043 #      can not use domain patterns like "*.org" or partial domain
1044 #      names. If a DNS name resolves to multiple IP addresses, only
1045 #      the first one is used.
1046 #
1047 #      Some systems allow IPv4 clients to connect to IPv6 server
1048 #      sockets. Then the client's IPv4 address will be translated by
1049 #      the system into IPv6 address space with special prefix
1050 #      ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1051 #      can handle it and maps such ACL addresses automatically.
1052 #
1053 #      Denying access to particular sites by ACL may have undesired
1054 #      side effects if the site in question is hosted on a machine
1055 #      which also hosts other sites (most sites are).
1056 #
1057 #  Examples:
1058 #
1059 #      Explicitly define the default behavior if no ACL and
1060 #      listen-address are set: "localhost" is OK. The absence of a
1061 #      dst_addr implies that all destination addresses are OK:
1062 #
1063 #        permit-access  localhost
1064 #
1065 #      Allow any host on the same class C subnet as www.privoxy.org
1066 #      access to nothing but www.example.com (or other domains hosted
1067 #      on the same system):
1068 #
1069 #        permit-access  www.privoxy.org/24 www.example.com/32
1070 #
1071 #      Allow access from any host on the 26-bit subnet 192.168.45.64
1072 #      to anywhere, with the exception that 192.168.45.73 may not
1073 #      access the IP address behind www.dirty-stuff.example.com:
1074 #
1075 #        permit-access  192.168.45.64/26
1076 #        deny-access    192.168.45.73    www.dirty-stuff.example.com
1077 #
1078 #      Allow access from the IPv4 network 192.0.2.0/24 even if
1079 #      listening on an IPv6 wild card address (not supported on all
1080 #      platforms):
1081 #
1082 #        permit-access  192.0.2.0/24
1083 #
1084 #      This is equivalent to the following line even if listening on
1085 #      an IPv4 address (not supported on all platforms):
1086 #
1087 #        permit-access  [::ffff:192.0.2.0]/120
1088 #
1089 #
1090 #  4.8. buffer-limit
1091 #  ==================
1092 #
1093 #  Specifies:
1094 #
1095 #      Maximum size of the buffer for content filtering.
1096 #
1097 #  Type of value:
1098 #
1099 #      Size in Kbytes
1100 #
1101 #  Default value:
1102 #
1103 #      4096
1104 #
1105 #  Effect if unset:
1106 #
1107 #      Use a 4MB (4096 KB) limit.
1108 #
1109 #  Notes:
1110 #
1111 #      For content filtering, i.e. the +filter and +deanimate-gif
1112 #      actions, it is necessary that Privoxy buffers the entire
1113 #      document body. This can be potentially dangerous, since a
1114 #      server could just keep sending data indefinitely and wait for
1115 #      your RAM to exhaust -- with nasty consequences. Hence this
1116 #      option.
1117 #
1118 #      When a document buffer size reaches the buffer-limit, it is
1119 #      flushed to the client unfiltered and no further attempt to
1120 #      filter the rest of the document is made. Remember that there
1121 #      may be multiple threads running, which might require up to
1122 #      buffer-limit Kbytes each, unless you have enabled
1123 #      "single-threaded" above.
1124 #
1125 buffer-limit 4096
1126 #
1127 #  4.9. enable-proxy-authentication-forwarding
1128 #  ============================================
1129 #
1130 #  Specifies:
1131 #
1132 #      Whether or not proxy authentication through Privoxy should
1133 #      work.
1134 #
1135 #  Type of value:
1136 #
1137 #      0 or 1
1138 #
1139 #  Default value:
1140 #
1141 #      0
1142 #
1143 #  Effect if unset:
1144 #
1145 #      Proxy authentication headers are removed.
1146 #
1147 #  Notes:
1148 #
1149 #      Privoxy itself does not support proxy authentication, but can
1150 #      allow clients to authenticate against Privoxy's parent proxy.
1151 #
1152 #      By default Privoxy (3.0.21 and later) don't do that and remove
1153 #      Proxy-Authorization headers in requests and Proxy-Authenticate
1154 #      headers in responses to make it harder for malicious sites to
1155 #      trick inexperienced users into providing login information.
1156 #
1157 #      If this option is enabled the headers are forwarded.
1158 #
1159 #      Enabling this option is not recommended if there is no parent
1160 #      proxy that requires authentication or if the local network
1161 #      between Privoxy and the parent proxy isn't trustworthy. If
1162 #      proxy authentication is only required for some requests, it is
1163 #      recommended to use a client header filter to remove the
1164 #      authentication headers for requests where they aren't needed.
1165 #
1166 enable-proxy-authentication-forwarding 0
1167 #
1168 #  4.10. trusted-cgi-referer
1169 #  ==========================
1170 #
1171 #  Specifies:
1172 #
1173 #      A trusted website or webpage whose links can be followed to
1174 #      reach sensitive CGI pages
1175 #
1176 #  Type of value:
1177 #
1178 #      URL or URL prefix
1179 #
1180 #  Default value:
1181 #
1182 #      Unset
1183 #
1184 #  Effect if unset:
1185 #
1186 #      No external pages are considered trusted referers.
1187 #
1188 #  Notes:
1189 #
1190 #      Before Privoxy accepts configuration changes through CGI pages
1191 #      like client-tags or the remote toggle, it checks the Referer
1192 #      header to see if the request comes from a trusted source.
1193 #
1194 #      By default only the webinterface domains config.privoxy.org
1195 #      and p.p are considered trustworthy. Requests originating from
1196 #      other domains are rejected to prevent third-parties from
1197 #      modifiying Privoxy's state by e.g. embedding images that
1198 #      result in CGI requests.
1199 #
1200 #      In some environments it may be desirable to embed links to CGI
1201 #      pages on external pages, for example on an Intranet homepage
1202 #      the Privoxy admin controls.
1203 #
1204 #      The "trusted-cgi-referer" option can be used to add that page,
1205 #      or the whole domain, as trusted source so the resulting
1206 #      requests aren't rejected. Requests are accepted if the
1207 #      specified trusted-cgi-refer is the prefix of the Referer.
1208 #
1209 #      If the trusted source is supposed to access the CGI pages via
1210 #      JavaScript the cors-allowed-origin option can be used.
1211 #
1212 #      +-----------------------------------------------------+
1213 #      |                       Warning                       |
1214 #      |-----------------------------------------------------|
1215 #      |Declaring pages the admin doesn't control trustworthy|
1216 #      |may allow malicious third parties to modify Privoxy's|
1217 #      |internal state against the user's wishes and without |
1218 #      |the user's knowledge.                                |
1219 #      +-----------------------------------------------------+
1220 #
1221 #trusted-cgi-referer http://www.example.org/local-privoxy-control-page
1222 #
1223 #  4.11. cors-allowed-origin
1224 #  ==========================
1225 #
1226 #  Specifies:
1227 #
1228 #      A trusted website which can access Privoxy's CGI pages through
1229 #      JavaScript.
1230 #
1231 #  Type of value:
1232 #
1233 #      URL
1234 #
1235 #  Default value:
1236 #
1237 #      Unset
1238 #
1239 #  Effect if unset:
1240 #
1241 #      No external sites get access via cross-origin resource
1242 #      sharing.
1243 #
1244 #  Notes:
1245 #
1246 #      Modern browsers by default prevent cross-origin requests made
1247 #      via JavaScript to Privoxy's CGI interface even if Privoxy
1248 #      would trust the referer because it's white listed via the
1249 #      trusted-cgi-referer directive.
1250 #
1251 #      Cross-origin resource sharing (CORS) is a mechanism to allow
1252 #      cross-origin requests.
1253 #
1254 #      The "cors-allowed-origin" option can be used to specify a
1255 #      domain that is allowed to make requests to Privoxy CGI
1256 #      interface via JavaScript. It is used in combination with the
1257 #      trusted-cgi-referer directive.
1258 #
1259 #      +-----------------------------------------------------+
1260 #      |                       Warning                       |
1261 #      |-----------------------------------------------------|
1262 #      |Declaring domains the admin doesn't control          |
1263 #      |trustworthy may allow malicious third parties to     |
1264 #      |modify Privoxy's internal state against the user's   |
1265 #      |wishes and without the user's knowledge.             |
1266 #      +-----------------------------------------------------+
1267 #
1268 #cors-allowed-origin http://www.example.org/
1269 #
1270 #  5. FORWARDING
1271 #  ==============
1272 #
1273 #  This feature allows routing of HTTP requests through a chain of
1274 #  multiple proxies.
1275 #
1276 #  Forwarding can be used to chain Privoxy with a caching proxy to
1277 #  speed up browsing. Using a parent proxy may also be necessary if
1278 #  the machine that Privoxy runs on has no direct Internet access.
1279 #
1280 #  Note that parent proxies can severely decrease your privacy level.
1281 #  For example a parent proxy could add your IP address to the
1282 #  request headers and if it's a caching proxy it may add the "Etag"
1283 #  header to revalidation requests again, even though you configured
1284 #  Privoxy to remove it. It may also ignore Privoxy's header time
1285 #  randomization and use the original values which could be used by
1286 #  the server as cookie replacement to track your steps between
1287 #  visits.
1288 #
1289 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1290 #  4 and SOCKS 4A protocols.
1291 #
1292 #
1293 #  5.1. forward
1294 #  =============
1295 #
1296 #  Specifies:
1297 #
1298 #      To which parent HTTP proxy specific requests should be routed.
1299 #
1300 #  Type of value:
1301 #
1302 #      target_pattern http_parent[:port]
1303 #
1304 #      where target_pattern is a URL pattern that specifies to which
1305 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1306 #      denote "all URLs". http_parent[:port] is the DNS name or IP
1307 #      address of the parent HTTP proxy through which the requests
1308 #      should be forwarded, optionally followed by its listening port
1309 #      (default: 8000). Use a single dot (.) to denote "no
1310 #      forwarding".
1311 #
1312 #  Default value:
1313 #
1314 #      Unset
1315 #
1316 #  Effect if unset:
1317 #
1318 #      Don't use parent HTTP proxies.
1319 #
1320 #  Notes:
1321 #
1322 #      If http_parent is ".", then requests are not forwarded to
1323 #      another HTTP proxy but are made directly to the web servers.
1324 #
1325 #      http_parent can be a numerical IPv6 address (if RFC 3493 is
1326 #      implemented). To prevent clashes with the port delimiter, the
1327 #      whole IP address has to be put into brackets. On the other
1328 #      hand a target_pattern containing an IPv6 address has to be put
1329 #      into angle brackets (normal brackets are reserved for regular
1330 #      expressions already).
1331 #
1332 #      Multiple lines are OK, they are checked in sequence, and the
1333 #      last match wins.
1334 #
1335 #  Examples:
1336 #
1337 #      Everything goes to an example parent proxy, except SSL on port
1338 #      443 (which it doesn't handle):
1339 #
1340 #        forward   /      parent-proxy.example.org:8080
1341 #        forward   :443   .
1342 #
1343 #      Everything goes to our example ISP's caching proxy, except for
1344 #      requests to that ISP's sites:
1345 #
1346 #        forward   /                  caching-proxy.isp.example.net:8000
1347 #        forward   .isp.example.net   .
1348 #
1349 #      Parent proxy specified by an IPv6 address:
1350 #
1351 #        forward   /                   [2001:DB8::1]:8000
1352 #
1353 #      Suppose your parent proxy doesn't support IPv6:
1354 #
1355 #        forward  /                        parent-proxy.example.org:8000
1356 #        forward  ipv6-server.example.org  .
1357 #        forward  <[2-3][0-9a-f][0-9a-f][0-9a-f]:*>   .
1358 #
1359 #
1360 #  5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1361 #  =========================================================================
1362 #
1363 #  Specifies:
1364 #
1365 #      Through which SOCKS proxy (and optionally to which parent HTTP
1366 #      proxy) specific requests should be routed.
1367 #
1368 #  Type of value:
1369 #
1370 #      target_pattern [user:pass@]socks_proxy[:port] http_parent[:port]
1371 #
1372 #      where target_pattern is a URL pattern that specifies to which
1373 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1374 #      denote "all URLs". http_parent and socks_proxy are IP
1375 #      addresses in dotted decimal notation or valid DNS names (
1376 #      http_parent may be "." to denote "no HTTP forwarding"), and
1377 #      the optional port parameters are TCP ports, i.e. integer
1378 #      values from 1 to 65535. user and pass can be used for SOCKS5
1379 #      authentication if required.
1380 #
1381 #  Default value:
1382 #
1383 #      Unset
1384 #
1385 #  Effect if unset:
1386 #
1387 #      Don't use SOCKS proxies.
1388 #
1389 #  Notes:
1390 #
1391 #      Multiple lines are OK, they are checked in sequence, and the
1392 #      last match wins.
1393 #
1394 #      The difference between forward-socks4 and forward-socks4a is
1395 #      that in the SOCKS 4A protocol, the DNS resolution of the
1396 #      target hostname happens on the SOCKS server, while in SOCKS 4
1397 #      it happens locally.
1398 #
1399 #      With forward-socks5 the DNS resolution will happen on the
1400 #      remote server as well.
1401 #
1402 #      forward-socks5t works like vanilla forward-socks5 but lets
1403 #      Privoxy additionally use Tor-specific SOCKS extensions.
1404 #      Currently the only supported SOCKS extension is optimistic
1405 #      data which can reduce the latency for the first request made
1406 #      on a newly created connection.
1407 #
1408 #      socks_proxy and http_parent can be a numerical IPv6 address
1409 #      (if RFC 3493 is implemented). To prevent clashes with the port
1410 #      delimiter, the whole IP address has to be put into brackets.
1411 #      On the other hand a target_pattern containing an IPv6 address
1412 #      has to be put into angle brackets (normal brackets are
1413 #      reserved for regular expressions already).
1414 #
1415 #      If http_parent is ".", then requests are not forwarded to
1416 #      another HTTP proxy but are made (HTTP-wise) directly to the
1417 #      web servers, albeit through a SOCKS proxy.
1418 #
1419 #  Examples:
1420 #
1421 #      From the company example.com, direct connections are made to
1422 #      all "internal" domains, but everything outbound goes through
1423 #      their ISP's proxy by way of example.com's corporate SOCKS 4A
1424 #      gateway to the Internet.
1425 #
1426 #        forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
1427 #        forward           .example.com   .
1428 #
1429 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1430 #      HTTP parent looks like this:
1431 #
1432 #        forward-socks4   /               socks-gw.example.com:1080  .
1433 #
1434 #      To connect SOCKS5 proxy which requires username/password
1435 #      authentication:
1436 #
1437 #        forward-socks5   /               user:pass@socks-gw.example.com:1080  .
1438 #
1439 #      To chain Privoxy and Tor, both running on the same system, you
1440 #      would use something like:
1441 #
1442 #        forward-socks5t   /               127.0.0.1:9050 .
1443 #
1444 #      Note that if you got Tor through one of the bundles, you may
1445 #      have to change the port from 9050 to 9150 (or even another
1446 #      one). For details, please check the documentation on the Tor
1447 #      website.
1448 #
1449 #      The public Tor network can't be used to reach your local
1450 #      network, if you need to access local servers you therefore
1451 #      might want to make some exceptions:
1452 #
1453 #        forward         192.168.*.*/     .
1454 #        forward            10.*.*.*/     .
1455 #        forward           127.*.*.*/     .
1456 #
1457 #      Unencrypted connections to systems in these address ranges
1458 #      will be as (un)secure as the local network is, but the
1459 #      alternative is that you can't reach the local network through
1460 #      Privoxy at all. Of course this may actually be desired and
1461 #      there is no reason to make these exceptions if you aren't sure
1462 #      you need them.
1463 #
1464 #      If you also want to be able to reach servers in your local
1465 #      network by using their names, you will need additional
1466 #      exceptions that look like this:
1467 #
1468 #       forward           localhost/     .
1469 #
1470 #
1471 #  5.3. forwarded-connect-retries
1472 #  ===============================
1473 #
1474 #  Specifies:
1475 #
1476 #      How often Privoxy retries if a forwarded connection request
1477 #      fails.
1478 #
1479 #  Type of value:
1480 #
1481 #      Number of retries.
1482 #
1483 #  Default value:
1484 #
1485 #      0
1486 #
1487 #  Effect if unset:
1488 #
1489 #      Connections forwarded through other proxies are treated like
1490 #      direct connections and no retry attempts are made.
1491 #
1492 #  Notes:
1493 #
1494 #      forwarded-connect-retries is mainly interesting for socks4a
1495 #      connections, where Privoxy can't detect why the connections
1496 #      failed. The connection might have failed because of a DNS
1497 #      timeout in which case a retry makes sense, but it might also
1498 #      have failed because the server doesn't exist or isn't
1499 #      reachable. In this case the retry will just delay the
1500 #      appearance of Privoxy's error message.
1501 #
1502 #      Note that in the context of this option, "forwarded
1503 #      connections" includes all connections that Privoxy forwards
1504 #      through other proxies. This option is not limited to the HTTP
1505 #      CONNECT method.
1506 #
1507 #      Only use this option, if you are getting lots of
1508 #      forwarding-related error messages that go away when you try
1509 #      again manually. Start with a small value and check Privoxy's
1510 #      logfile from time to time, to see how many retries are usually
1511 #      needed.
1512 #
1513 #  Examples:
1514 #
1515 #      forwarded-connect-retries 1
1516 #
1517 forwarded-connect-retries  0
1518 #
1519 #  6. MISCELLANEOUS
1520 #  =================
1521 #
1522 #  6.1. accept-intercepted-requests
1523 #  =================================
1524 #
1525 #  Specifies:
1526 #
1527 #      Whether intercepted requests should be treated as valid.
1528 #
1529 #  Type of value:
1530 #
1531 #      0 or 1
1532 #
1533 #  Default value:
1534 #
1535 #      0
1536 #
1537 #  Effect if unset:
1538 #
1539 #      Only proxy requests are accepted, intercepted requests are
1540 #      treated as invalid.
1541 #
1542 #  Notes:
1543 #
1544 #      If you don't trust your clients and want to force them to use
1545 #      Privoxy, enable this option and configure your packet filter
1546 #      to redirect outgoing HTTP connections into Privoxy.
1547 #
1548 #      Note that intercepting encrypted connections (HTTPS) isn't
1549 #      supported.
1550 #
1551 #      Make sure that Privoxy's own requests aren't redirected as
1552 #      well. Additionally take care that Privoxy can't intentionally
1553 #      connect to itself, otherwise you could run into redirection
1554 #      loops if Privoxy's listening port is reachable by the outside
1555 #      or an attacker has access to the pages you visit.
1556 #
1557 #      If you are running Privoxy as intercepting proxy without being
1558 #      able to intercept all client requests you may want to adjust
1559 #      the CGI templates to make sure they don't reference content
1560 #      from config.privoxy.org.
1561 #
1562 #  Examples:
1563 #
1564 #      accept-intercepted-requests 1
1565 #
1566 accept-intercepted-requests 0
1567 #
1568 #  6.2. allow-cgi-request-crunching
1569 #  =================================
1570 #
1571 #  Specifies:
1572 #
1573 #      Whether requests to Privoxy's CGI pages can be blocked or
1574 #      redirected.
1575 #
1576 #  Type of value:
1577 #
1578 #      0 or 1
1579 #
1580 #  Default value:
1581 #
1582 #      0
1583 #
1584 #  Effect if unset:
1585 #
1586 #      Privoxy ignores block and redirect actions for its CGI pages.
1587 #
1588 #  Notes:
1589 #
1590 #      By default Privoxy ignores block or redirect actions for its
1591 #      CGI pages. Intercepting these requests can be useful in
1592 #      multi-user setups to implement fine-grained access control,
1593 #      but it can also render the complete web interface useless and
1594 #      make debugging problems painful if done without care.
1595 #
1596 #      Don't enable this option unless you're sure that you really
1597 #      need it.
1598 #
1599 #  Examples:
1600 #
1601 #      allow-cgi-request-crunching 1
1602 #
1603 allow-cgi-request-crunching 0
1604 #
1605 #  6.3. split-large-forms
1606 #  =======================
1607 #
1608 #  Specifies:
1609 #
1610 #      Whether the CGI interface should stay compatible with broken
1611 #      HTTP clients.
1612 #
1613 #  Type of value:
1614 #
1615 #      0 or 1
1616 #
1617 #  Default value:
1618 #
1619 #      0
1620 #
1621 #  Effect if unset:
1622 #
1623 #      The CGI form generate long GET URLs.
1624 #
1625 #  Notes:
1626 #
1627 #      Privoxy's CGI forms can lead to rather long URLs. This isn't a
1628 #      problem as far as the HTTP standard is concerned, but it can
1629 #      confuse clients with arbitrary URL length limitations.
1630 #
1631 #      Enabling split-large-forms causes Privoxy to divide big forms
1632 #      into smaller ones to keep the URL length down. It makes
1633 #      editing a lot less convenient and you can no longer submit all
1634 #      changes at once, but at least it works around this browser
1635 #      bug.
1636 #
1637 #      If you don't notice any editing problems, there is no reason
1638 #      to enable this option, but if one of the submit buttons
1639 #      appears to be broken, you should give it a try.
1640 #
1641 #  Examples:
1642 #
1643 #      split-large-forms 1
1644 #
1645 split-large-forms 0
1646 #
1647 #  6.4. keep-alive-timeout
1648 #  ========================
1649 #
1650 #  Specifies:
1651 #
1652 #      Number of seconds after which an open connection will no
1653 #      longer be reused.
1654 #
1655 #  Type of value:
1656 #
1657 #      Time in seconds.
1658 #
1659 #  Default value:
1660 #
1661 #      None
1662 #
1663 #  Effect if unset:
1664 #
1665 #      Connections are not kept alive.
1666 #
1667 #  Notes:
1668 #
1669 #      This option allows clients to keep the connection to Privoxy
1670 #      alive. If the server supports it, Privoxy will keep the
1671 #      connection to the server alive as well. Under certain
1672 #      circumstances this may result in speed-ups.
1673 #
1674 #      By default, Privoxy will close the connection to the server if
1675 #      the client connection gets closed, or if the specified timeout
1676 #      has been reached without a new request coming in. This
1677 #      behaviour can be changed with the connection-sharing option.
1678 #
1679 #      This option has no effect if Privoxy has been compiled without
1680 #      keep-alive support.
1681 #
1682 #      Note that a timeout of five seconds as used in the default
1683 #      configuration file significantly decreases the number of
1684 #      connections that will be reused. The value is used because
1685 #      some browsers limit the number of connections they open to a
1686 #      single host and apply the same limit to proxies. This can
1687 #      result in a single website "grabbing" all the connections the
1688 #      browser allows, which means connections to other websites
1689 #      can't be opened until the connections currently in use time
1690 #      out.
1691 #
1692 #      Several users have reported this as a Privoxy bug, so the
1693 #      default value has been reduced. Consider increasing it to 300
1694 #      seconds or even more if you think your browser can handle it.
1695 #      If your browser appears to be hanging, it probably can't.
1696 #
1697 #  Examples:
1698 #
1699 #      keep-alive-timeout 300
1700 #
1701 keep-alive-timeout 5
1702 #
1703 #  6.5. tolerate-pipelining
1704 #  =========================
1705 #
1706 #  Specifies:
1707 #
1708 #      Whether or not pipelined requests should be served.
1709 #
1710 #  Type of value:
1711 #
1712 #      0 or 1.
1713 #
1714 #  Default value:
1715 #
1716 #      None
1717 #
1718 #  Effect if unset:
1719 #
1720 #      If Privoxy receives more than one request at once, it
1721 #      terminates the client connection after serving the first one.
1722 #
1723 #  Notes:
1724 #
1725 #      Privoxy currently doesn't pipeline outgoing requests, thus
1726 #      allowing pipelining on the client connection is not guaranteed
1727 #      to improve the performance.
1728 #
1729 #      By default Privoxy tries to discourage clients from pipelining
1730 #      by discarding aggressively pipelined requests, which forces
1731 #      the client to resend them through a new connection.
1732 #
1733 #      This option lets Privoxy tolerate pipelining. Whether or not
1734 #      that improves performance mainly depends on the client
1735 #      configuration.
1736 #
1737 #      If you are seeing problems with pages not properly loading,
1738 #      disabling this option could work around the problem.
1739 #
1740 #  Examples:
1741 #
1742 #      tolerate-pipelining 1
1743 #
1744 tolerate-pipelining 1
1745 #
1746 #  6.6. default-server-timeout
1747 #  ============================
1748 #
1749 #  Specifies:
1750 #
1751 #      Assumed server-side keep-alive timeout if not specified by the
1752 #      server.
1753 #
1754 #  Type of value:
1755 #
1756 #      Time in seconds.
1757 #
1758 #  Default value:
1759 #
1760 #      None
1761 #
1762 #  Effect if unset:
1763 #
1764 #      Connections for which the server didn't specify the keep-alive
1765 #      timeout are not reused.
1766 #
1767 #  Notes:
1768 #
1769 #      Enabling this option significantly increases the number of
1770 #      connections that are reused, provided the keep-alive-timeout
1771 #      option is also enabled.
1772 #
1773 #      While it also increases the number of connections problems
1774 #      when Privoxy tries to reuse a connection that already has been
1775 #      closed on the server side, or is closed while Privoxy is
1776 #      trying to reuse it, this should only be a problem if it
1777 #      happens for the first request sent by the client. If it
1778 #      happens for requests on reused client connections, Privoxy
1779 #      will simply close the connection and the client is supposed to
1780 #      retry the request without bothering the user.
1781 #
1782 #      Enabling this option is therefore only recommended if the
1783 #      connection-sharing option is disabled.
1784 #
1785 #      It is an error to specify a value larger than the
1786 #      keep-alive-timeout value.
1787 #
1788 #      This option has no effect if Privoxy has been compiled without
1789 #      keep-alive support.
1790 #
1791 #  Examples:
1792 #
1793 #      default-server-timeout 60
1794 #
1795 #default-server-timeout 60
1796 #
1797 #  6.7. connection-sharing
1798 #  ========================
1799 #
1800 #  Specifies:
1801 #
1802 #      Whether or not outgoing connections that have been kept alive
1803 #      should be shared between different incoming connections.
1804 #
1805 #  Type of value:
1806 #
1807 #      0 or 1
1808 #
1809 #  Default value:
1810 #
1811 #      None
1812 #
1813 #  Effect if unset:
1814 #
1815 #      Connections are not shared.
1816 #
1817 #  Notes:
1818 #
1819 #      This option has no effect if Privoxy has been compiled without
1820 #      keep-alive support, or if it's disabled.
1821 #
1822 #  Notes:
1823 #
1824 #      Note that reusing connections doesn't necessary cause
1825 #      speedups. There are also a few privacy implications you should
1826 #      be aware of.
1827 #
1828 #      If this option is effective, outgoing connections are shared
1829 #      between clients (if there are more than one) and closing the
1830 #      browser that initiated the outgoing connection does no longer
1831 #      affect the connection between Privoxy and the server unless
1832 #      the client's request hasn't been completed yet.
1833 #
1834 #      If the outgoing connection is idle, it will not be closed
1835 #      until either Privoxy's or the server's timeout is reached.
1836 #      While it's open, the server knows that the system running
1837 #      Privoxy is still there.
1838 #
1839 #      If there are more than one client (maybe even belonging to
1840 #      multiple users), they will be able to reuse each others
1841 #      connections. This is potentially dangerous in case of
1842 #      authentication schemes like NTLM where only the connection is
1843 #      authenticated, instead of requiring authentication for each
1844 #      request.
1845 #
1846 #      If there is only a single client, and if said client can keep
1847 #      connections alive on its own, enabling this option has next to
1848 #      no effect. If the client doesn't support connection
1849 #      keep-alive, enabling this option may make sense as it allows
1850 #      Privoxy to keep outgoing connections alive even if the client
1851 #      itself doesn't support it.
1852 #
1853 #      You should also be aware that enabling this option increases
1854 #      the likelihood of getting the "No server or forwarder data"
1855 #      error message, especially if you are using a slow connection
1856 #      to the Internet.
1857 #
1858 #      This option should only be used by experienced users who
1859 #      understand the risks and can weight them against the benefits.
1860 #
1861 #  Examples:
1862 #
1863 #      connection-sharing 1
1864 #
1865 #connection-sharing 1
1866 #
1867 #  6.8. socket-timeout
1868 #  ====================
1869 #
1870 #  Specifies:
1871 #
1872 #      Number of seconds after which a socket times out if no data is
1873 #      received.
1874 #
1875 #  Type of value:
1876 #
1877 #      Time in seconds.
1878 #
1879 #  Default value:
1880 #
1881 #      None
1882 #
1883 #  Effect if unset:
1884 #
1885 #      A default value of 300 seconds is used.
1886 #
1887 #  Notes:
1888 #
1889 #      The default is quite high and you probably want to reduce it.
1890 #      If you aren't using an occasionally slow proxy like Tor,
1891 #      reducing it to a few seconds should be fine.
1892 #
1893 #  Examples:
1894 #
1895 #      socket-timeout 300
1896 #
1897 socket-timeout 300
1898 #
1899 #  6.9. max-client-connections
1900 #  ============================
1901 #
1902 #  Specifies:
1903 #
1904 #      Maximum number of client connections that will be served.
1905 #
1906 #  Type of value:
1907 #
1908 #      Positive number.
1909 #
1910 #  Default value:
1911 #
1912 #      128
1913 #
1914 #  Effect if unset:
1915 #
1916 #      Connections are served until a resource limit is reached.
1917 #
1918 #  Notes:
1919 #
1920 #      Privoxy creates one thread (or process) for every incoming
1921 #      client connection that isn't rejected based on the access
1922 #      control settings.
1923 #
1924 #      If the system is powerful enough, Privoxy can theoretically
1925 #      deal with several hundred (or thousand) connections at the
1926 #      same time, but some operating systems enforce resource limits
1927 #      by shutting down offending processes and their default limits
1928 #      may be below the ones Privoxy would require under heavy load.
1929 #
1930 #      Configuring Privoxy to enforce a connection limit below the
1931 #      thread or process limit used by the operating system makes
1932 #      sure this doesn't happen. Simply increasing the operating
1933 #      system's limit would work too, but if Privoxy isn't the only
1934 #      application running on the system, you may actually want to
1935 #      limit the resources used by Privoxy.
1936 #
1937 #      If Privoxy is only used by a single trusted user, limiting the
1938 #      number of client connections is probably unnecessary. If there
1939 #      are multiple possibly untrusted users you probably still want
1940 #      to additionally use a packet filter to limit the maximal
1941 #      number of incoming connections per client. Otherwise a
1942 #      malicious user could intentionally create a high number of
1943 #      connections to prevent other users from using Privoxy.
1944 #
1945 #      Obviously using this option only makes sense if you choose a
1946 #      limit below the one enforced by the operating system.
1947 #
1948 #      One most POSIX-compliant systems Privoxy can't properly deal
1949 #      with more than FD_SETSIZE file descriptors at the same time
1950 #      and has to reject connections if the limit is reached. This
1951 #      will likely change in a future version, but currently this
1952 #      limit can't be increased without recompiling Privoxy with a
1953 #      different FD_SETSIZE limit.
1954 #
1955 #  Examples:
1956 #
1957 #      max-client-connections 256
1958 #
1959 #max-client-connections 256
1960 #
1961 #  6.10. listen-backlog
1962 #  =====================
1963 #
1964 #  Specifies:
1965 #
1966 #      Connection queue length requested from the operating system.
1967 #
1968 #  Type of value:
1969 #
1970 #      Number.
1971 #
1972 #  Default value:
1973 #
1974 #      128
1975 #
1976 #  Effect if unset:
1977 #
1978 #      A connection queue length of 128 is requested from the
1979 #      operating system.
1980 #
1981 #  Notes:
1982 #
1983 #      Under high load incoming connection may queue up before
1984 #      Privoxy gets around to serve them. The queue length is
1985 #      limitted by the operating system. Once the queue is full,
1986 #      additional connections are dropped before Privoxy can accept
1987 #      and serve them.
1988 #
1989 #      Increasing the queue length allows Privoxy to accept more
1990 #      incomming connections that arrive roughly at the same time.
1991 #
1992 #      Note that Privoxy can only request a certain queue length,
1993 #      whether or not the requested length is actually used depends
1994 #      on the operating system which may use a different length
1995 #      instead.
1996 #
1997 #      On many operating systems a limit of -1 can be specified to
1998 #      instruct the operating system to use the maximum queue length
1999 #      allowed. Check the listen man page to see if your platform
2000 #      allows this.
2001 #
2002 #      On some platforms you can use "netstat -Lan -p tcp" to see the
2003 #      effective queue length.
2004 #
2005 #      Effectively using a value above 128 usually requires changing
2006 #      the system configuration as well. On FreeBSD-based system the
2007 #      limit is controlled by the kern.ipc.soacceptqueue sysctl.
2008 #
2009 #  Examples:
2010 #
2011 #      listen-backlog 4096
2012 #
2013 #listen-backlog -1
2014 #
2015 #  6.11. enable-accept-filter
2016 #  ===========================
2017 #
2018 #  Specifies:
2019 #
2020 #      Whether or not Privoxy should use an accept filter
2021 #
2022 #  Type of value:
2023 #
2024 #      0 or 1
2025 #
2026 #  Default value:
2027 #
2028 #      0
2029 #
2030 #  Effect if unset:
2031 #
2032 #      No accept filter is enabled.
2033 #
2034 #  Notes:
2035 #
2036 #      Accept filters reduce the number of context switches by not
2037 #      passing sockets for new connections to Privoxy until a
2038 #      complete HTTP request is available.
2039 #
2040 #      As a result, Privoxy can process the whole request right away
2041 #      without having to wait for additional data first.
2042 #
2043 #      For this option to work, Privoxy has to be compiled with
2044 #      FEATURE_ACCEPT_FILTER and the operating system has to support
2045 #      it (which may require loading a kernel module).
2046 #
2047 #      Currently accept filters are only supported on FreeBSD-based
2048 #      systems. Check the accf_http(9) man page to learn how to
2049 #      enable the support in the operating system.
2050 #
2051 #  Examples:
2052 #
2053 #      enable-accept-filter 1
2054 #
2055 #enable-accept-filter 1
2056 #
2057 #  6.12. handle-as-empty-doc-returns-ok
2058 #  =====================================
2059 #
2060 #  Specifies:
2061 #
2062 #      The status code Privoxy returns for pages blocked with
2063 #      +handle-as-empty-document.
2064 #
2065 #  Type of value:
2066 #
2067 #      0 or 1
2068 #
2069 #  Default value:
2070 #
2071 #      0
2072 #
2073 #  Effect if unset:
2074 #
2075 #      Privoxy returns a status 403(forbidden) for all blocked pages.
2076 #
2077 #  Effect if set:
2078 #
2079 #      Privoxy returns a status 200(OK) for pages blocked with
2080 #      +handle-as-empty-document and a status 403(Forbidden) for all
2081 #      other blocked pages.
2082 #
2083 #  Notes:
2084 #
2085 #      This directive was added as a work-around for Firefox bug
2086 #      492459: "Websites are no longer rendered if SSL requests for
2087 #      JavaScripts are blocked by a proxy."
2088 #      (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
2089 #      has been fixed for quite some time, but this directive is also
2090 #      useful to make it harder for websites to detect whether or not
2091 #      resources are being blocked.
2092 #
2093 #handle-as-empty-doc-returns-ok 1
2094 #
2095 #  6.13. enable-compression
2096 #  =========================
2097 #
2098 #  Specifies:
2099 #
2100 #      Whether or not buffered content is compressed before delivery.
2101 #
2102 #  Type of value:
2103 #
2104 #      0 or 1
2105 #
2106 #  Default value:
2107 #
2108 #      0
2109 #
2110 #  Effect if unset:
2111 #
2112 #      Privoxy does not compress buffered content.
2113 #
2114 #  Effect if set:
2115 #
2116 #      Privoxy compresses buffered content before delivering it to
2117 #      the client, provided the client supports it.
2118 #
2119 #  Notes:
2120 #
2121 #      This directive is only supported if Privoxy has been compiled
2122 #      with FEATURE_COMPRESSION, which should not to be confused with
2123 #      FEATURE_ZLIB.
2124 #
2125 #      Compressing buffered content is mainly useful if Privoxy and
2126 #      the client are running on different systems. If they are
2127 #      running on the same system, enabling compression is likely to
2128 #      slow things down. If you didn't measure otherwise, you should
2129 #      assume that it does and keep this option disabled.
2130 #
2131 #      Privoxy will not compress buffered content below a certain
2132 #      length.
2133 #
2134 #enable-compression 1
2135 #
2136 #  6.14. compression-level
2137 #  ========================
2138 #
2139 #  Specifies:
2140 #
2141 #      The compression level that is passed to the zlib library when
2142 #      compressing buffered content.
2143 #
2144 #  Type of value:
2145 #
2146 #      Positive number ranging from 0 to 9.
2147 #
2148 #  Default value:
2149 #
2150 #      1
2151 #
2152 #  Notes:
2153 #
2154 #      Compressing the data more takes usually longer than
2155 #      compressing it less or not compressing it at all. Which level
2156 #      is best depends on the connection between Privoxy and the
2157 #      client. If you can't be bothered to benchmark it for yourself,
2158 #      you should stick with the default and keep compression
2159 #      disabled.
2160 #
2161 #      If compression is disabled, the compression level is
2162 #      irrelevant.
2163 #
2164 #  Examples:
2165 #
2166 #          # Best speed (compared to the other levels)
2167 #          compression-level 1
2168 #
2169 #          # Best compression
2170 #          compression-level 9
2171 #
2172 #          # No compression. Only useful for testing as the added header
2173 #          # slightly increases the amount of data that has to be sent.
2174 #          # If your benchmark shows that using this compression level
2175 #          # is superior to using no compression at all, the benchmark
2176 #          # is likely to be flawed.
2177 #          compression-level 0
2178 #
2179 #
2180 #compression-level 1
2181 #
2182 #  6.15. client-header-order
2183 #  ==========================
2184 #
2185 #  Specifies:
2186 #
2187 #      The order in which client headers are sorted before forwarding
2188 #      them.
2189 #
2190 #  Type of value:
2191 #
2192 #      Client header names delimited by spaces or tabs
2193 #
2194 #  Default value:
2195 #
2196 #      None
2197 #
2198 #  Notes:
2199 #
2200 #      By default Privoxy leaves the client headers in the order they
2201 #      were sent by the client. Headers are modified in-place, new
2202 #      headers are added at the end of the already existing headers.
2203 #
2204 #      The header order can be used to fingerprint client requests
2205 #      independently of other headers like the User-Agent.
2206 #
2207 #      This directive allows to sort the headers differently to
2208 #      better mimic a different User-Agent. Client headers will be
2209 #      emitted in the order given, headers whose name isn't
2210 #      explicitly specified are added at the end.
2211 #
2212 #      Note that sorting headers in an uncommon way will make
2213 #      fingerprinting actually easier. Encrypted headers are not
2214 #      affected by this directive.
2215 #
2216 #client-header-order Host \
2217 #   User-Agent \
2218 #   Accept \
2219 #   Accept-Language \
2220 #   Accept-Encoding \
2221 #   Proxy-Connection \
2222 #   Referer \
2223 #   Cookie \
2224 #   DNT \
2225 #   If-Modified-Since \
2226 #   Cache-Control \
2227 #   Content-Length \
2228 #   Content-Type
2229 #
2230 #
2231 #  6.16. client-specific-tag
2232 #  ==========================
2233 #
2234 #  Specifies:
2235 #
2236 #      The name of a tag that will always be set for clients that
2237 #      requested it through the webinterface.
2238 #
2239 #  Type of value:
2240 #
2241 #      Tag name followed by a description that will be shown in the
2242 #      webinterface
2243 #
2244 #  Default value:
2245 #
2246 #      None
2247 #
2248 #  Notes:
2249 #
2250 #      +-----------------------------------------------------+
2251 #      |                       Warning                       |
2252 #      |-----------------------------------------------------|
2253 #      |This is an experimental feature. The syntax is likely|
2254 #      |to change in future versions.                        |
2255 #      +-----------------------------------------------------+
2256 #
2257 #      Client-specific tags allow Privoxy admins to create different
2258 #      profiles and let the users chose which one they want without
2259 #      impacting other users.
2260 #
2261 #      One use case is allowing users to circumvent certain blocks
2262 #      without having to allow them to circumvent all blocks. This is
2263 #      not possible with the enable-remote-toggle feature because it
2264 #      would bluntly disable all blocks for all users and also affect
2265 #      other actions like filters. It also is set globally which
2266 #      renders it useless in most multi-user setups.
2267 #
2268 #      After a client-specific tag has been defined with the
2269 #      client-specific-tag directive, action sections can be
2270 #      activated based on the tag by using a CLIENT-TAG pattern. The
2271 #      CLIENT-TAG pattern is evaluated at the same priority as URL
2272 #      patterns, as a result the last matching pattern wins. Tags
2273 #      that are created based on client or server headers are
2274 #      evaluated later on and can overrule CLIENT-TAG and URL
2275 #      patterns!
2276 #
2277 #      The tag is set for all requests that come from clients that
2278 #      requested it to be set. Note that "clients" are differentiated
2279 #      by IP address, if the IP address changes the tag has to be
2280 #      requested again.
2281 #
2282 #      Clients can request tags to be set by using the CGI interface
2283 #      http://config.privoxy.org/client-tags. The specific tag
2284 #      description is only used on the web page and should be phrased
2285 #      in away that the user understand the effect of the tag.
2286 #
2287 #  Examples:
2288 #
2289 #          # Define a couple of tags, the described effect requires action sections
2290 #          # that are enabled based on CLIENT-TAG patterns.
2291 #          client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
2292 #          disable-content-filters Disable content-filters but do not affect other actions
2293 #
2294 #
2295 #
2296 #  6.17. client-tag-lifetime
2297 #  ==========================
2298 #
2299 #  Specifies:
2300 #
2301 #      How long a temporarily enabled tag remains enabled.
2302 #
2303 #  Type of value:
2304 #
2305 #      Time in seconds.
2306 #
2307 #  Default value:
2308 #
2309 #      60
2310 #
2311 #  Notes:
2312 #
2313 #      +-----------------------------------------------------+
2314 #      |                       Warning                       |
2315 #      |-----------------------------------------------------|
2316 #      |This is an experimental feature. The syntax is likely|
2317 #      |to change in future versions.                        |
2318 #      +-----------------------------------------------------+
2319 #
2320 #      In case of some tags users may not want to enable them
2321 #      permanently, but only for a short amount of time, for example
2322 #      to circumvent a block that is the result of an overly-broad
2323 #      URL pattern.
2324 #
2325 #      The CGI interface http://config.privoxy.org/client-tags
2326 #      therefore provides a "enable this tag temporarily" option. If
2327 #      it is used, the tag will be set until the client-tag-lifetime
2328 #      is over.
2329 #
2330 #  Examples:
2331 #
2332 #            # Increase the time to life for temporarily enabled tags to 3 minutes
2333 #            client-tag-lifetime 180
2334 #
2335 #
2336 #
2337 #  6.18. trust-x-forwarded-for
2338 #  ============================
2339 #
2340 #  Specifies:
2341 #
2342 #      Whether or not Privoxy should use IP addresses specified with
2343 #      the X-Forwarded-For header
2344 #
2345 #  Type of value:
2346 #
2347 #      0 or one
2348 #
2349 #  Default value:
2350 #
2351 #      0
2352 #
2353 #  Notes:
2354 #
2355 #      +-----------------------------------------------------+
2356 #      |                       Warning                       |
2357 #      |-----------------------------------------------------|
2358 #      |This is an experimental feature. The syntax is likely|
2359 #      |to change in future versions.                        |
2360 #      +-----------------------------------------------------+
2361 #
2362 #      If clients reach Privoxy through another proxy, for example a
2363 #      load balancer, Privoxy can't tell the client's IP address from
2364 #      the connection. If multiple clients use the same proxy, they
2365 #      will share the same client tag settings which is usually not
2366 #      desired.
2367 #
2368 #      This option lets Privoxy use the X-Forwarded-For header value
2369 #      as client IP address. If the proxy sets the header, multiple
2370 #      clients using the same proxy do not share the same client tag
2371 #      settings.
2372 #
2373 #      This option should only be enabled if Privoxy can only be
2374 #      reached through a proxy and if the proxy can be trusted to set
2375 #      the header correctly. It is recommended that ACL are used to
2376 #      make sure only trusted systems can reach Privoxy.
2377 #
2378 #      If access to Privoxy isn't limited to trusted systems, this
2379 #      option would allow malicious clients to change the client tags
2380 #      for other clients or increase Privoxy's memory requirements by
2381 #      registering lots of client tag settings for clients that don't
2382 #      exist.
2383 #
2384 #  Examples:
2385 #
2386 #            # Allow systems that can reach Privoxy to provide the client
2387 #            # IP address with a X-Forwarded-For header.
2388 #            trust-x-forwarded-for 1
2389 #
2390 #
2391 #
2392 #  6.19. receive-buffer-size
2393 #  ==========================
2394 #
2395 #  Specifies:
2396 #
2397 #      The size of the buffer Privoxy uses to receive data from the
2398 #      server.
2399 #
2400 #  Type of value:
2401 #
2402 #      Size in bytes
2403 #
2404 #  Default value:
2405 #
2406 #      5000
2407 #
2408 #  Notes:
2409 #
2410 #      Increasing the receive-buffer-size increases Privoxy's memory
2411 #      usage but can lower the number of context switches and thereby
2412 #      reduce the cpu usage and potentially increase the throughput.
2413 #
2414 #      This is mostly relevant for fast network connections and large
2415 #      downloads that don't require filtering.
2416 #
2417 #      Reducing the buffer size reduces the amount of memory Privoxy
2418 #      needs to handle the request but increases the number of
2419 #      systemcalls and may reduce the throughput.
2420 #
2421 #      A dtrace command like: "sudo dtrace -n 'syscall::read:return /
2422 #      execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0,
2423 #      5, 20); @m = max(arg0)}'" can be used to properly tune the
2424 #      receive-buffer-size. On systems without dtrace, strace or
2425 #      truss may be used as less convenient alternatives.
2426 #
2427 #      If the buffer is too large it will increase Privoxy's memory
2428 #      footprint without any benefit. As the memory is (currently)
2429 #      cleared before using it, a buffer that is too large can
2430 #      actually reduce the throughput.
2431 #
2432 #  Examples:
2433 #
2434 #            # Increase the receive buffer size
2435 #            receive-buffer-size 32768
2436 #
2437 #
2438 #
2439 #  7. WINDOWS GUI OPTIONS
2440 #  =======================
2441 #
2442 #  Privoxy has a number of options specific to the Windows GUI
2443 #  interface:
2444 #
2445 #
2446 #
2447 #  If "activity-animation" is set to 1, the Privoxy icon will animate
2448 #  when "Privoxy" is active. To turn off, set to 0.
2449 #
2450 #activity-animation   1
2451 #
2452 #
2453 #
2454 #  If "log-messages" is set to 1, Privoxy copies log messages to the
2455 #  console window. The log detail depends on the debug directive.
2456 #
2457 #log-messages   1
2458 #
2459 #
2460 #
2461 #  If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2462 #  the amount of memory used for the log messages displayed in the
2463 #  console window, will be limited to "log-max-lines" (see below).
2464 #
2465 #  Warning: Setting this to 0 will result in the buffer to grow
2466 #  infinitely and eat up all your memory!
2467 #
2468 #log-buffer-size 1
2469 #
2470 #
2471 #
2472 #  log-max-lines is the maximum number of lines held in the log
2473 #  buffer. See above.
2474 #
2475 #log-max-lines 200
2476 #
2477 #
2478 #
2479 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
2480 #  portions of the log messages with a bold-faced font:
2481 #
2482 #log-highlight-messages 1
2483 #
2484 #
2485 #
2486 #  The font used in the console window:
2487 #
2488 #log-font-name Comic Sans MS
2489 #
2490 #
2491 #
2492 #  Font size used in the console window:
2493 #
2494 #log-font-size 8
2495 #
2496 #
2497 #
2498 #  "show-on-task-bar" controls whether or not Privoxy will appear as
2499 #  a button on the Task bar when minimized:
2500 #
2501 #show-on-task-bar 0
2502 #
2503 #
2504 #
2505 #  If "close-button-minimizes" is set to 1, the Windows close button
2506 #  will minimize Privoxy instead of closing the program (close with
2507 #  the exit option on the File menu).
2508 #
2509 #close-button-minimizes 1
2510 #
2511 #
2512 #
2513 #  The "hide-console" option is specific to the MS-Win console
2514 #  version of Privoxy. If this option is used, Privoxy will
2515 #  disconnect from and hide the command console.
2516 #
2517 #hide-console
2518 #
2519 #
2520 #