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