Use the IP_FREEBIND socket option, if defined
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy 3.0.29
2 #
3 # Copyright (C) 2001-2019 Privoxy Developers https://www.privoxy.org/
4 #
5 #####################################################################
6 #                                                                   #
7 #                      Table of Contents                            #
8 #                                                                   #
9 #        I. INTRODUCTION                                            #
10 #       II. FORMAT OF THE CONFIGURATION FILE                        #
11 #                                                                   #
12 #        1. LOCAL SET-UP DOCUMENTATION                              #
13 #        2. CONFIGURATION AND LOG FILE LOCATIONS                    #
14 #        3. DEBUGGING                                               #
15 #        4. ACCESS CONTROL AND SECURITY                             #
16 #        5. FORWARDING                                              #
17 #        6. MISCELLANEOUS                                           #
18 #        7. 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.
735 #
736 #      IPv6 addresses containing colons have to be quoted by
737 #      brackets. They can only be used if Privoxy has been compiled
738 #      with IPv6 support. If you aren't sure if your version supports
739 #      it, have a look at http://config.privoxy.org/show-status.
740 #
741 #      Some operating systems will prefer IPv6 to IPv4 addresses even
742 #      if the system has no IPv6 connectivity which is usually not
743 #      expected by the user. Some even rely on DNS to resolve
744 #      localhost which mean the "localhost" address used may not
745 #      actually be local.
746 #
747 #      It is therefore recommended to explicitly configure the
748 #      intended IP address instead of relying on the operating
749 #      system, unless there's a strong reason not to.
750 #
751 #      If you leave out the address, Privoxy will bind to all IPv4
752 #      interfaces (addresses) on your machine and may become
753 #      reachable from the Internet and/or the local network. Be aware
754 #      that some GNU/Linux distributions modify that behaviour
755 #      without updating the documentation. Check for non-standard
756 #      patches if your Privoxy version behaves differently.
757 #
758 #      If you configure Privoxy to be reachable from the network,
759 #      consider using access control lists (ACL's, see below), and/or
760 #      a firewall.
761 #
762 #      If you open Privoxy to untrusted users, you will also want to
763 #      make sure that the following actions are disabled:
764 #      enable-edit-actions and enable-remote-toggle
765 #
766 #  Example:
767 #
768 #      Suppose you are running Privoxy on a machine which has the
769 #      address 192.168.0.1 on your local private network
770 #      (192.168.0.0) and has another outside connection with a
771 #      different address. You want it to serve requests from inside
772 #      only:
773 #
774 #        listen-address  192.168.0.1:8118
775 #
776 #      Suppose you are running Privoxy on an IPv6-capable machine and
777 #      you want it to listen on the IPv6 address of the loopback
778 #      device:
779 #
780 #        listen-address [::1]:8118
781 #
782 listen-address  127.0.0.1:8118
783 #
784 #  4.2. toggle
785 #  ============
786 #
787 #  Specifies:
788 #
789 #      Initial state of "toggle" status
790 #
791 #  Type of value:
792 #
793 #      1 or 0
794 #
795 #  Default value:
796 #
797 #      1
798 #
799 #  Effect if unset:
800 #
801 #      Act as if toggled on
802 #
803 #  Notes:
804 #
805 #      If set to 0, Privoxy will start in "toggled off" mode, i.e.
806 #      mostly behave like a normal, content-neutral proxy with both
807 #      ad blocking and content filtering disabled. See
808 #      enable-remote-toggle below.
809 #
810 toggle  1
811 #
812 #  4.3. enable-remote-toggle
813 #  ==========================
814 #
815 #  Specifies:
816 #
817 #      Whether or not the web-based toggle feature may be used
818 #
819 #  Type of value:
820 #
821 #      0 or 1
822 #
823 #  Default value:
824 #
825 #      0
826 #
827 #  Effect if unset:
828 #
829 #      The web-based toggle feature is disabled.
830 #
831 #  Notes:
832 #
833 #      When toggled off, Privoxy mostly acts like a normal,
834 #      content-neutral proxy, i.e. doesn't block ads or filter
835 #      content.
836 #
837 #      Access to the toggle feature can not be controlled separately
838 #      by "ACLs" or HTTP authentication, so that everybody who can
839 #      access Privoxy (see "ACLs" and listen-address above) can
840 #      toggle it for all users. So this option is not recommended for
841 #      multi-user environments with untrusted users.
842 #
843 #      Note that malicious client side code (e.g Java) is also
844 #      capable of using this option.
845 #
846 #      As a lot of Privoxy users don't read documentation, this
847 #      feature is disabled by default.
848 #
849 #      Note that you must have compiled Privoxy with support for this
850 #      feature, otherwise this option has no effect.
851 #
852 enable-remote-toggle  0
853 #
854 #  4.4. enable-remote-http-toggle
855 #  ===============================
856 #
857 #  Specifies:
858 #
859 #      Whether or not Privoxy recognizes special HTTP headers to
860 #      change its behaviour.
861 #
862 #  Type of value:
863 #
864 #      0 or 1
865 #
866 #  Default value:
867 #
868 #      0
869 #
870 #  Effect if unset:
871 #
872 #      Privoxy ignores special HTTP headers.
873 #
874 #  Notes:
875 #
876 #      When toggled on, the client can change Privoxy's behaviour by
877 #      setting special HTTP headers. Currently the only supported
878 #      special header is "X-Filter: No", to disable filtering for the
879 #      ongoing request, even if it is enabled in one of the action
880 #      files.
881 #
882 #      This feature is disabled by default. If you are using Privoxy
883 #      in a environment with trusted clients, you may enable this
884 #      feature at your discretion. Note that malicious client side
885 #      code (e.g Java) is also capable of using this feature.
886 #
887 #      This option will be removed in future releases as it has been
888 #      obsoleted by the more general header taggers.
889 #
890 enable-remote-http-toggle  0
891 #
892 #  4.5. enable-edit-actions
893 #  =========================
894 #
895 #  Specifies:
896 #
897 #      Whether or not the web-based actions file editor may be used
898 #
899 #  Type of value:
900 #
901 #      0 or 1
902 #
903 #  Default value:
904 #
905 #      0
906 #
907 #  Effect if unset:
908 #
909 #      The web-based actions file editor is disabled.
910 #
911 #  Notes:
912 #
913 #      Access to the editor can not be controlled separately by
914 #      "ACLs" or HTTP authentication, so that everybody who can
915 #      access Privoxy (see "ACLs" and listen-address above) can
916 #      modify its configuration for all users.
917 #
918 #      This option is not recommended for environments with untrusted
919 #      users and as a lot of Privoxy users don't read documentation,
920 #      this feature is disabled by default.
921 #
922 #      Note that malicious client side code (e.g Java) is also
923 #      capable of using the actions editor and you shouldn't enable
924 #      this options unless you understand the consequences and are
925 #      sure your browser is configured correctly.
926 #
927 #      Note that you must have compiled Privoxy with support for this
928 #      feature, otherwise this option has no effect.
929 #
930 enable-edit-actions 0
931 #
932 #  4.6. enforce-blocks
933 #  ====================
934 #
935 #  Specifies:
936 #
937 #      Whether the user is allowed to ignore blocks and can "go there
938 #      anyway".
939 #
940 #  Type of value:
941 #
942 #      0 or 1
943 #
944 #  Default value:
945 #
946 #      0
947 #
948 #  Effect if unset:
949 #
950 #      Blocks are not enforced.
951 #
952 #  Notes:
953 #
954 #      Privoxy is mainly used to block and filter requests as a
955 #      service to the user, for example to block ads and other junk
956 #      that clogs the pipes. Privoxy's configuration isn't perfect
957 #      and sometimes innocent pages are blocked. In this situation it
958 #      makes sense to allow the user to enforce the request and have
959 #      Privoxy ignore the block.
960 #
961 #      In the default configuration Privoxy's "Blocked" page contains
962 #      a "go there anyway" link to adds a special string (the force
963 #      prefix) to the request URL. If that link is used, Privoxy will
964 #      detect the force prefix, remove it again and let the request
965 #      pass.
966 #
967 #      Of course Privoxy can also be used to enforce a network
968 #      policy. In that case the user obviously should not be able to
969 #      bypass any blocks, and that's what the "enforce-blocks" option
970 #      is for. If it's enabled, Privoxy hides the "go there anyway"
971 #      link. If the user adds the force prefix by hand, it will not
972 #      be accepted and the circumvention attempt is logged.
973 #
974 #  Examples:
975 #
976 #      enforce-blocks 1
977 #
978 enforce-blocks 0
979 #
980 #  4.7. ACLs: permit-access and deny-access
981 #  =========================================
982 #
983 #  Specifies:
984 #
985 #      Who can access what.
986 #
987 #  Type of value:
988 #
989 #      src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
990 #
991 #      Where src_addr and dst_addr are IPv4 addresses in dotted
992 #      decimal notation or valid DNS names, port is a port number,
993 #      and src_masklen and dst_masklen are subnet masks in CIDR
994 #      notation, i.e. integer values from 2 to 30 representing the
995 #      length (in bits) of the network address. The masks and the
996 #      whole destination part are optional.
997 #
998 #      If your system implements RFC 3493, then src_addr and dst_addr
999 #      can be IPv6 addresses delimeted by brackets, port can be a
1000 #      number or a service name, and src_masklen and dst_masklen can
1001 #      be a number from 0 to 128.
1002 #
1003 #  Default value:
1004 #
1005 #      Unset
1006 #
1007 #      If no port is specified, any port will match. If no
1008 #      src_masklen or src_masklen is given, the complete IP address
1009 #      has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1010 #
1011 #  Effect if unset:
1012 #
1013 #      Don't restrict access further than implied by listen-address
1014 #
1015 #  Notes:
1016 #
1017 #      Access controls are included at the request of ISPs and
1018 #      systems administrators, and are not usually needed by
1019 #      individual users. For a typical home user, it will normally
1020 #      suffice to ensure that Privoxy only listens on the localhost
1021 #      (127.0.0.1) or internal (home) network address by means of the
1022 #      listen-address option.
1023 #
1024 #      Please see the warnings in the FAQ that Privoxy is not
1025 #      intended to be a substitute for a firewall or to encourage
1026 #      anyone to defer addressing basic security weaknesses.
1027 #
1028 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1029 #      only talks to IP addresses that match at least one
1030 #      permit-access line and don't match any subsequent deny-access
1031 #      line. In other words, the last match wins, with the default
1032 #      being deny-access.
1033 #
1034 #      If Privoxy is using a forwarder (see forward below) for a
1035 #      particular destination URL, the dst_addr that is examined is
1036 #      the address of the forwarder and NOT the address of the
1037 #      ultimate target. This is necessary because it may be
1038 #      impossible for the local Privoxy to determine the IP address
1039 #      of the ultimate target (that's often what gateways are used
1040 #      for).
1041 #
1042 #      You should prefer using IP addresses over DNS names, because
1043 #      the address lookups take time. All DNS names must resolve! You
1044 #      can not use domain patterns like "*.org" or partial domain
1045 #      names. If a DNS name resolves to multiple IP addresses, only
1046 #      the first one is used.
1047 #
1048 #      Some systems allow IPv4 clients to connect to IPv6 server
1049 #      sockets. Then the client's IPv4 address will be translated by
1050 #      the system into IPv6 address space with special prefix
1051 #      ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1052 #      can handle it and maps such ACL addresses automatically.
1053 #
1054 #      Denying access to particular sites by ACL may have undesired
1055 #      side effects if the site in question is hosted on a machine
1056 #      which also hosts other sites (most sites are).
1057 #
1058 #  Examples:
1059 #
1060 #      Explicitly define the default behavior if no ACL and
1061 #      listen-address are set: "localhost" is OK. The absence of a
1062 #      dst_addr implies that all destination addresses are OK:
1063 #
1064 #        permit-access  localhost
1065 #
1066 #      Allow any host on the same class C subnet as www.privoxy.org
1067 #      access to nothing but www.example.com (or other domains hosted
1068 #      on the same system):
1069 #
1070 #        permit-access  www.privoxy.org/24 www.example.com/32
1071 #
1072 #      Allow access from any host on the 26-bit subnet 192.168.45.64
1073 #      to anywhere, with the exception that 192.168.45.73 may not
1074 #      access the IP address behind www.dirty-stuff.example.com:
1075 #
1076 #        permit-access  192.168.45.64/26
1077 #        deny-access    192.168.45.73    www.dirty-stuff.example.com
1078 #
1079 #      Allow access from the IPv4 network 192.0.2.0/24 even if
1080 #      listening on an IPv6 wild card address (not supported on all
1081 #      platforms):
1082 #
1083 #        permit-access  192.0.2.0/24
1084 #
1085 #      This is equivalent to the following line even if listening on
1086 #      an IPv4 address (not supported on all platforms):
1087 #
1088 #        permit-access  [::ffff:192.0.2.0]/120
1089 #
1090 #
1091 #  4.8. buffer-limit
1092 #  ==================
1093 #
1094 #  Specifies:
1095 #
1096 #      Maximum size of the buffer for content filtering.
1097 #
1098 #  Type of value:
1099 #
1100 #      Size in Kbytes
1101 #
1102 #  Default value:
1103 #
1104 #      4096
1105 #
1106 #  Effect if unset:
1107 #
1108 #      Use a 4MB (4096 KB) limit.
1109 #
1110 #  Notes:
1111 #
1112 #      For content filtering, i.e. the +filter and +deanimate-gif
1113 #      actions, it is necessary that Privoxy buffers the entire
1114 #      document body. This can be potentially dangerous, since a
1115 #      server could just keep sending data indefinitely and wait for
1116 #      your RAM to exhaust -- with nasty consequences. Hence this
1117 #      option.
1118 #
1119 #      When a document buffer size reaches the buffer-limit, it is
1120 #      flushed to the client unfiltered and no further attempt to
1121 #      filter the rest of the document is made. Remember that there
1122 #      may be multiple threads running, which might require up to
1123 #      buffer-limit Kbytes each, unless you have enabled
1124 #      "single-threaded" above.
1125 #
1126 buffer-limit 4096
1127 #
1128 #  4.9. enable-proxy-authentication-forwarding
1129 #  ============================================
1130 #
1131 #  Specifies:
1132 #
1133 #      Whether or not proxy authentication through Privoxy should
1134 #      work.
1135 #
1136 #  Type of value:
1137 #
1138 #      0 or 1
1139 #
1140 #  Default value:
1141 #
1142 #      0
1143 #
1144 #  Effect if unset:
1145 #
1146 #      Proxy authentication headers are removed.
1147 #
1148 #  Notes:
1149 #
1150 #      Privoxy itself does not support proxy authentication, but can
1151 #      allow clients to authenticate against Privoxy's parent proxy.
1152 #
1153 #      By default Privoxy (3.0.21 and later) don't do that and remove
1154 #      Proxy-Authorization headers in requests and Proxy-Authenticate
1155 #      headers in responses to make it harder for malicious sites to
1156 #      trick inexperienced users into providing login information.
1157 #
1158 #      If this option is enabled the headers are forwarded.
1159 #
1160 #      Enabling this option is not recommended if there is no parent
1161 #      proxy that requires authentication or if the local network
1162 #      between Privoxy and the parent proxy isn't trustworthy. If
1163 #      proxy authentication is only required for some requests, it is
1164 #      recommended to use a client header filter to remove the
1165 #      authentication headers for requests where they aren't needed.
1166 #
1167 enable-proxy-authentication-forwarding 0
1168 #
1169 #  4.10. trusted-cgi-referer
1170 #  ==========================
1171 #
1172 #  Specifies:
1173 #
1174 #      A trusted website or webpage whose links can be followed to
1175 #      reach sensitive CGI pages
1176 #
1177 #  Type of value:
1178 #
1179 #      URL or URL prefix
1180 #
1181 #  Default value:
1182 #
1183 #      Unset
1184 #
1185 #  Effect if unset:
1186 #
1187 #      No external pages are considered trusted referers.
1188 #
1189 #  Notes:
1190 #
1191 #      Before Privoxy accepts configuration changes through CGI pages
1192 #      like client-tags or the remote toggle, it checks the Referer
1193 #      header to see if the request comes from a trusted source.
1194 #
1195 #      By default only the webinterface domains config.privoxy.org
1196 #      and p.p are considered trustworthy. Requests originating from
1197 #      other domains are rejected to prevent third-parties from
1198 #      modifiying Privoxy's state by e.g. embedding images that
1199 #      result in CGI requests.
1200 #
1201 #      In some environments it may be desirable to embed links to CGI
1202 #      pages on external pages, for example on an Intranet homepage
1203 #      the Privoxy admin controls.
1204 #
1205 #      The "trusted-cgi-referer" option can be used to add that page,
1206 #      or the whole domain, as trusted source so the resulting
1207 #      requests aren't rejected. Requests are accepted if the
1208 #      specified trusted-cgi-refer is the prefix of the Referer.
1209 #
1210 #      If the trusted source is supposed to access the CGI pages via
1211 #      JavaScript the cors-allowed-origin option can be used.
1212 #
1213 #      +-----------------------------------------------------+
1214 #      |                       Warning                       |
1215 #      |-----------------------------------------------------|
1216 #      |Declaring pages the admin doesn't control trustworthy|
1217 #      |may allow malicious third parties to modify Privoxy's|
1218 #      |internal state against the user's wishes and without |
1219 #      |the user's knowledge.                                |
1220 #      +-----------------------------------------------------+
1221 #
1222 #trusted-cgi-referer http://www.example.org/local-privoxy-control-page
1223 #
1224 #  4.11. cors-allowed-origin
1225 #  ==========================
1226 #
1227 #  Specifies:
1228 #
1229 #      A trusted website which can access Privoxy's CGI pages through
1230 #      JavaScript.
1231 #
1232 #  Type of value:
1233 #
1234 #      URL
1235 #
1236 #  Default value:
1237 #
1238 #      Unset
1239 #
1240 #  Effect if unset:
1241 #
1242 #      No external sites get access via cross-origin resource
1243 #      sharing.
1244 #
1245 #  Notes:
1246 #
1247 #      Modern browsers by default prevent cross-origin requests made
1248 #      via JavaScript to Privoxy's CGI interface even if Privoxy
1249 #      would trust the referer because it's white listed via the
1250 #      trusted-cgi-referer directive.
1251 #
1252 #      Cross-origin resource sharing (CORS) is a mechanism to allow
1253 #      cross-origin requests.
1254 #
1255 #      The "cors-allowed-origin" option can be used to specify a
1256 #      domain that is allowed to make requests to Privoxy CGI
1257 #      interface via JavaScript. It is used in combination with the
1258 #      trusted-cgi-referer directive.
1259 #
1260 #      +-----------------------------------------------------+
1261 #      |                       Warning                       |
1262 #      |-----------------------------------------------------|
1263 #      |Declaring domains the admin doesn't control          |
1264 #      |trustworthy may allow malicious third parties to     |
1265 #      |modify Privoxy's internal state against the user's   |
1266 #      |wishes and without the user's knowledge.             |
1267 #      +-----------------------------------------------------+
1268 #
1269 #cors-allowed-origin http://www.example.org/
1270 #
1271 #  5. FORWARDING
1272 #  ==============
1273 #
1274 #  This feature allows routing of HTTP requests through a chain of
1275 #  multiple proxies.
1276 #
1277 #  Forwarding can be used to chain Privoxy with a caching proxy to
1278 #  speed up browsing. Using a parent proxy may also be necessary if
1279 #  the machine that Privoxy runs on has no direct Internet access.
1280 #
1281 #  Note that parent proxies can severely decrease your privacy level.
1282 #  For example a parent proxy could add your IP address to the
1283 #  request headers and if it's a caching proxy it may add the "Etag"
1284 #  header to revalidation requests again, even though you configured
1285 #  Privoxy to remove it. It may also ignore Privoxy's header time
1286 #  randomization and use the original values which could be used by
1287 #  the server as cookie replacement to track your steps between
1288 #  visits.
1289 #
1290 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1291 #  4 and SOCKS 4A protocols.
1292 #
1293 #
1294 #  5.1. forward
1295 #  =============
1296 #
1297 #  Specifies:
1298 #
1299 #      To which parent HTTP proxy specific requests should be routed.
1300 #
1301 #  Type of value:
1302 #
1303 #      target_pattern http_parent[:port]
1304 #
1305 #      where target_pattern is a URL pattern that specifies to which
1306 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1307 #      denote "all URLs". http_parent[:port] is the DNS name or IP
1308 #      address of the parent HTTP proxy through which the requests
1309 #      should be forwarded, optionally followed by its listening port
1310 #      (default: 8000). Use a single dot (.) to denote "no
1311 #      forwarding".
1312 #
1313 #  Default value:
1314 #
1315 #      Unset
1316 #
1317 #  Effect if unset:
1318 #
1319 #      Don't use parent HTTP proxies.
1320 #
1321 #  Notes:
1322 #
1323 #      If http_parent is ".", then requests are not forwarded to
1324 #      another HTTP proxy but are made directly to the web servers.
1325 #
1326 #      http_parent can be a numerical IPv6 address (if RFC 3493 is
1327 #      implemented). To prevent clashes with the port delimiter, the
1328 #      whole IP address has to be put into brackets. On the other
1329 #      hand a target_pattern containing an IPv6 address has to be put
1330 #      into angle brackets (normal brackets are reserved for regular
1331 #      expressions already).
1332 #
1333 #      Multiple lines are OK, they are checked in sequence, and the
1334 #      last match wins.
1335 #
1336 #  Examples:
1337 #
1338 #      Everything goes to an example parent proxy, except SSL on port
1339 #      443 (which it doesn't handle):
1340 #
1341 #        forward   /      parent-proxy.example.org:8080
1342 #        forward   :443   .
1343 #
1344 #      Everything goes to our example ISP's caching proxy, except for
1345 #      requests to that ISP's sites:
1346 #
1347 #        forward   /                  caching-proxy.isp.example.net:8000
1348 #        forward   .isp.example.net   .
1349 #
1350 #      Parent proxy specified by an IPv6 address:
1351 #
1352 #        forward   /                   [2001:DB8::1]:8000
1353 #
1354 #      Suppose your parent proxy doesn't support IPv6:
1355 #
1356 #        forward  /                        parent-proxy.example.org:8000
1357 #        forward  ipv6-server.example.org  .
1358 #        forward  <[2-3][0-9a-f][0-9a-f][0-9a-f]:*>   .
1359 #
1360 #
1361 #  5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1362 #  =========================================================================
1363 #
1364 #  Specifies:
1365 #
1366 #      Through which SOCKS proxy (and optionally to which parent HTTP
1367 #      proxy) specific requests should be routed.
1368 #
1369 #  Type of value:
1370 #
1371 #      target_pattern [user:pass@]socks_proxy[:port] http_parent[:port]
1372 #
1373 #      where target_pattern is a URL pattern that specifies to which
1374 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1375 #      denote "all URLs". http_parent and socks_proxy are IP
1376 #      addresses in dotted decimal notation or valid DNS names (
1377 #      http_parent may be "." to denote "no HTTP forwarding"), and
1378 #      the optional port parameters are TCP ports, i.e. integer
1379 #      values from 1 to 65535. user and pass can be used for SOCKS5
1380 #      authentication if required.
1381 #
1382 #  Default value:
1383 #
1384 #      Unset
1385 #
1386 #  Effect if unset:
1387 #
1388 #      Don't use SOCKS proxies.
1389 #
1390 #  Notes:
1391 #
1392 #      Multiple lines are OK, they are checked in sequence, and the
1393 #      last match wins.
1394 #
1395 #      The difference between forward-socks4 and forward-socks4a is
1396 #      that in the SOCKS 4A protocol, the DNS resolution of the
1397 #      target hostname happens on the SOCKS server, while in SOCKS 4
1398 #      it happens locally.
1399 #
1400 #      With forward-socks5 the DNS resolution will happen on the
1401 #      remote server as well.
1402 #
1403 #      forward-socks5t works like vanilla forward-socks5 but lets
1404 #      Privoxy additionally use Tor-specific SOCKS extensions.
1405 #      Currently the only supported SOCKS extension is optimistic
1406 #      data which can reduce the latency for the first request made
1407 #      on a newly created connection.
1408 #
1409 #      socks_proxy and http_parent can be a numerical IPv6 address
1410 #      (if RFC 3493 is implemented). To prevent clashes with the port
1411 #      delimiter, the whole IP address has to be put into brackets.
1412 #      On the other hand a target_pattern containing an IPv6 address
1413 #      has to be put into angle brackets (normal brackets are
1414 #      reserved for regular expressions already).
1415 #
1416 #      If http_parent is ".", then requests are not forwarded to
1417 #      another HTTP proxy but are made (HTTP-wise) directly to the
1418 #      web servers, albeit through a SOCKS proxy.
1419 #
1420 #  Examples:
1421 #
1422 #      From the company example.com, direct connections are made to
1423 #      all "internal" domains, but everything outbound goes through
1424 #      their ISP's proxy by way of example.com's corporate SOCKS 4A
1425 #      gateway to the Internet.
1426 #
1427 #        forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
1428 #        forward           .example.com   .
1429 #
1430 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1431 #      HTTP parent looks like this:
1432 #
1433 #        forward-socks4   /               socks-gw.example.com:1080  .
1434 #
1435 #      To connect SOCKS5 proxy which requires username/password
1436 #      authentication:
1437 #
1438 #        forward-socks5   /               user:pass@socks-gw.example.com:1080  .
1439 #
1440 #      To chain Privoxy and Tor, both running on the same system, you
1441 #      would use something like:
1442 #
1443 #        forward-socks5t   /               127.0.0.1:9050 .
1444 #
1445 #      Note that if you got Tor through one of the bundles, you may
1446 #      have to change the port from 9050 to 9150 (or even another
1447 #      one). For details, please check the documentation on the Tor
1448 #      website.
1449 #
1450 #      The public Tor network can't be used to reach your local
1451 #      network, if you need to access local servers you therefore
1452 #      might want to make some exceptions:
1453 #
1454 #        forward         192.168.*.*/     .
1455 #        forward            10.*.*.*/     .
1456 #        forward           127.*.*.*/     .
1457 #
1458 #      Unencrypted connections to systems in these address ranges
1459 #      will be as (un)secure as the local network is, but the
1460 #      alternative is that you can't reach the local network through
1461 #      Privoxy at all. Of course this may actually be desired and
1462 #      there is no reason to make these exceptions if you aren't sure
1463 #      you need them.
1464 #
1465 #      If you also want to be able to reach servers in your local
1466 #      network by using their names, you will need additional
1467 #      exceptions that look like this:
1468 #
1469 #       forward           localhost/     .
1470 #
1471 #
1472 #  5.3. forwarded-connect-retries
1473 #  ===============================
1474 #
1475 #  Specifies:
1476 #
1477 #      How often Privoxy retries if a forwarded connection request
1478 #      fails.
1479 #
1480 #  Type of value:
1481 #
1482 #      Number of retries.
1483 #
1484 #  Default value:
1485 #
1486 #      0
1487 #
1488 #  Effect if unset:
1489 #
1490 #      Connections forwarded through other proxies are treated like
1491 #      direct connections and no retry attempts are made.
1492 #
1493 #  Notes:
1494 #
1495 #      forwarded-connect-retries is mainly interesting for socks4a
1496 #      connections, where Privoxy can't detect why the connections
1497 #      failed. The connection might have failed because of a DNS
1498 #      timeout in which case a retry makes sense, but it might also
1499 #      have failed because the server doesn't exist or isn't
1500 #      reachable. In this case the retry will just delay the
1501 #      appearance of Privoxy's error message.
1502 #
1503 #      Note that in the context of this option, "forwarded
1504 #      connections" includes all connections that Privoxy forwards
1505 #      through other proxies. This option is not limited to the HTTP
1506 #      CONNECT method.
1507 #
1508 #      Only use this option, if you are getting lots of
1509 #      forwarding-related error messages that go away when you try
1510 #      again manually. Start with a small value and check Privoxy's
1511 #      logfile from time to time, to see how many retries are usually
1512 #      needed.
1513 #
1514 #  Examples:
1515 #
1516 #      forwarded-connect-retries 1
1517 #
1518 forwarded-connect-retries  0
1519 #
1520 #  6. MISCELLANEOUS
1521 #  =================
1522 #
1523 #  6.1. accept-intercepted-requests
1524 #  =================================
1525 #
1526 #  Specifies:
1527 #
1528 #      Whether intercepted requests should be treated as valid.
1529 #
1530 #  Type of value:
1531 #
1532 #      0 or 1
1533 #
1534 #  Default value:
1535 #
1536 #      0
1537 #
1538 #  Effect if unset:
1539 #
1540 #      Only proxy requests are accepted, intercepted requests are
1541 #      treated as invalid.
1542 #
1543 #  Notes:
1544 #
1545 #      If you don't trust your clients and want to force them to use
1546 #      Privoxy, enable this option and configure your packet filter
1547 #      to redirect outgoing HTTP connections into Privoxy.
1548 #
1549 #      Note that intercepting encrypted connections (HTTPS) isn't
1550 #      supported.
1551 #
1552 #      Make sure that Privoxy's own requests aren't redirected as
1553 #      well. Additionally take care that Privoxy can't intentionally
1554 #      connect to itself, otherwise you could run into redirection
1555 #      loops if Privoxy's listening port is reachable by the outside
1556 #      or an attacker has access to the pages you visit.
1557 #
1558 #      If you are running Privoxy as intercepting proxy without being
1559 #      able to intercept all client requests you may want to adjust
1560 #      the CGI templates to make sure they don't reference content
1561 #      from config.privoxy.org.
1562 #
1563 #  Examples:
1564 #
1565 #      accept-intercepted-requests 1
1566 #
1567 accept-intercepted-requests 0
1568 #
1569 #  6.2. allow-cgi-request-crunching
1570 #  =================================
1571 #
1572 #  Specifies:
1573 #
1574 #      Whether requests to Privoxy's CGI pages can be blocked or
1575 #      redirected.
1576 #
1577 #  Type of value:
1578 #
1579 #      0 or 1
1580 #
1581 #  Default value:
1582 #
1583 #      0
1584 #
1585 #  Effect if unset:
1586 #
1587 #      Privoxy ignores block and redirect actions for its CGI pages.
1588 #
1589 #  Notes:
1590 #
1591 #      By default Privoxy ignores block or redirect actions for its
1592 #      CGI pages. Intercepting these requests can be useful in
1593 #      multi-user setups to implement fine-grained access control,
1594 #      but it can also render the complete web interface useless and
1595 #      make debugging problems painful if done without care.
1596 #
1597 #      Don't enable this option unless you're sure that you really
1598 #      need it.
1599 #
1600 #  Examples:
1601 #
1602 #      allow-cgi-request-crunching 1
1603 #
1604 allow-cgi-request-crunching 0
1605 #
1606 #  6.3. split-large-forms
1607 #  =======================
1608 #
1609 #  Specifies:
1610 #
1611 #      Whether the CGI interface should stay compatible with broken
1612 #      HTTP clients.
1613 #
1614 #  Type of value:
1615 #
1616 #      0 or 1
1617 #
1618 #  Default value:
1619 #
1620 #      0
1621 #
1622 #  Effect if unset:
1623 #
1624 #      The CGI form generate long GET URLs.
1625 #
1626 #  Notes:
1627 #
1628 #      Privoxy's CGI forms can lead to rather long URLs. This isn't a
1629 #      problem as far as the HTTP standard is concerned, but it can
1630 #      confuse clients with arbitrary URL length limitations.
1631 #
1632 #      Enabling split-large-forms causes Privoxy to divide big forms
1633 #      into smaller ones to keep the URL length down. It makes
1634 #      editing a lot less convenient and you can no longer submit all
1635 #      changes at once, but at least it works around this browser
1636 #      bug.
1637 #
1638 #      If you don't notice any editing problems, there is no reason
1639 #      to enable this option, but if one of the submit buttons
1640 #      appears to be broken, you should give it a try.
1641 #
1642 #  Examples:
1643 #
1644 #      split-large-forms 1
1645 #
1646 split-large-forms 0
1647 #
1648 #  6.4. keep-alive-timeout
1649 #  ========================
1650 #
1651 #  Specifies:
1652 #
1653 #      Number of seconds after which an open connection will no
1654 #      longer be reused.
1655 #
1656 #  Type of value:
1657 #
1658 #      Time in seconds.
1659 #
1660 #  Default value:
1661 #
1662 #      None
1663 #
1664 #  Effect if unset:
1665 #
1666 #      Connections are not kept alive.
1667 #
1668 #  Notes:
1669 #
1670 #      This option allows clients to keep the connection to Privoxy
1671 #      alive. If the server supports it, Privoxy will keep the
1672 #      connection to the server alive as well. Under certain
1673 #      circumstances this may result in speed-ups.
1674 #
1675 #      By default, Privoxy will close the connection to the server if
1676 #      the client connection gets closed, or if the specified timeout
1677 #      has been reached without a new request coming in. This
1678 #      behaviour can be changed with the connection-sharing option.
1679 #
1680 #      This option has no effect if Privoxy has been compiled without
1681 #      keep-alive support.
1682 #
1683 #      Note that a timeout of five seconds as used in the default
1684 #      configuration file significantly decreases the number of
1685 #      connections that will be reused. The value is used because
1686 #      some browsers limit the number of connections they open to a
1687 #      single host and apply the same limit to proxies. This can
1688 #      result in a single website "grabbing" all the connections the
1689 #      browser allows, which means connections to other websites
1690 #      can't be opened until the connections currently in use time
1691 #      out.
1692 #
1693 #      Several users have reported this as a Privoxy bug, so the
1694 #      default value has been reduced. Consider increasing it to 300
1695 #      seconds or even more if you think your browser can handle it.
1696 #      If your browser appears to be hanging, it probably can't.
1697 #
1698 #  Examples:
1699 #
1700 #      keep-alive-timeout 300
1701 #
1702 keep-alive-timeout 5
1703 #
1704 #  6.5. tolerate-pipelining
1705 #  =========================
1706 #
1707 #  Specifies:
1708 #
1709 #      Whether or not pipelined requests should be served.
1710 #
1711 #  Type of value:
1712 #
1713 #      0 or 1.
1714 #
1715 #  Default value:
1716 #
1717 #      None
1718 #
1719 #  Effect if unset:
1720 #
1721 #      If Privoxy receives more than one request at once, it
1722 #      terminates the client connection after serving the first one.
1723 #
1724 #  Notes:
1725 #
1726 #      Privoxy currently doesn't pipeline outgoing requests, thus
1727 #      allowing pipelining on the client connection is not guaranteed
1728 #      to improve the performance.
1729 #
1730 #      By default Privoxy tries to discourage clients from pipelining
1731 #      by discarding aggressively pipelined requests, which forces
1732 #      the client to resend them through a new connection.
1733 #
1734 #      This option lets Privoxy tolerate pipelining. Whether or not
1735 #      that improves performance mainly depends on the client
1736 #      configuration.
1737 #
1738 #      If you are seeing problems with pages not properly loading,
1739 #      disabling this option could work around the problem.
1740 #
1741 #  Examples:
1742 #
1743 #      tolerate-pipelining 1
1744 #
1745 tolerate-pipelining 1
1746 #
1747 #  6.6. default-server-timeout
1748 #  ============================
1749 #
1750 #  Specifies:
1751 #
1752 #      Assumed server-side keep-alive timeout if not specified by the
1753 #      server.
1754 #
1755 #  Type of value:
1756 #
1757 #      Time in seconds.
1758 #
1759 #  Default value:
1760 #
1761 #      None
1762 #
1763 #  Effect if unset:
1764 #
1765 #      Connections for which the server didn't specify the keep-alive
1766 #      timeout are not reused.
1767 #
1768 #  Notes:
1769 #
1770 #      Enabling this option significantly increases the number of
1771 #      connections that are reused, provided the keep-alive-timeout
1772 #      option is also enabled.
1773 #
1774 #      While it also increases the number of connections problems
1775 #      when Privoxy tries to reuse a connection that already has been
1776 #      closed on the server side, or is closed while Privoxy is
1777 #      trying to reuse it, this should only be a problem if it
1778 #      happens for the first request sent by the client. If it
1779 #      happens for requests on reused client connections, Privoxy
1780 #      will simply close the connection and the client is supposed to
1781 #      retry the request without bothering the user.
1782 #
1783 #      Enabling this option is therefore only recommended if the
1784 #      connection-sharing option is disabled.
1785 #
1786 #      It is an error to specify a value larger than the
1787 #      keep-alive-timeout value.
1788 #
1789 #      This option has no effect if Privoxy has been compiled without
1790 #      keep-alive support.
1791 #
1792 #  Examples:
1793 #
1794 #      default-server-timeout 60
1795 #
1796 #default-server-timeout 60
1797 #
1798 #  6.7. connection-sharing
1799 #  ========================
1800 #
1801 #  Specifies:
1802 #
1803 #      Whether or not outgoing connections that have been kept alive
1804 #      should be shared between different incoming connections.
1805 #
1806 #  Type of value:
1807 #
1808 #      0 or 1
1809 #
1810 #  Default value:
1811 #
1812 #      None
1813 #
1814 #  Effect if unset:
1815 #
1816 #      Connections are not shared.
1817 #
1818 #  Notes:
1819 #
1820 #      This option has no effect if Privoxy has been compiled without
1821 #      keep-alive support, or if it's disabled.
1822 #
1823 #  Notes:
1824 #
1825 #      Note that reusing connections doesn't necessary cause
1826 #      speedups. There are also a few privacy implications you should
1827 #      be aware of.
1828 #
1829 #      If this option is effective, outgoing connections are shared
1830 #      between clients (if there are more than one) and closing the
1831 #      browser that initiated the outgoing connection does no longer
1832 #      affect the connection between Privoxy and the server unless
1833 #      the client's request hasn't been completed yet.
1834 #
1835 #      If the outgoing connection is idle, it will not be closed
1836 #      until either Privoxy's or the server's timeout is reached.
1837 #      While it's open, the server knows that the system running
1838 #      Privoxy is still there.
1839 #
1840 #      If there are more than one client (maybe even belonging to
1841 #      multiple users), they will be able to reuse each others
1842 #      connections. This is potentially dangerous in case of
1843 #      authentication schemes like NTLM where only the connection is
1844 #      authenticated, instead of requiring authentication for each
1845 #      request.
1846 #
1847 #      If there is only a single client, and if said client can keep
1848 #      connections alive on its own, enabling this option has next to
1849 #      no effect. If the client doesn't support connection
1850 #      keep-alive, enabling this option may make sense as it allows
1851 #      Privoxy to keep outgoing connections alive even if the client
1852 #      itself doesn't support it.
1853 #
1854 #      You should also be aware that enabling this option increases
1855 #      the likelihood of getting the "No server or forwarder data"
1856 #      error message, especially if you are using a slow connection
1857 #      to the Internet.
1858 #
1859 #      This option should only be used by experienced users who
1860 #      understand the risks and can weight them against the benefits.
1861 #
1862 #  Examples:
1863 #
1864 #      connection-sharing 1
1865 #
1866 #connection-sharing 1
1867 #
1868 #  6.8. socket-timeout
1869 #  ====================
1870 #
1871 #  Specifies:
1872 #
1873 #      Number of seconds after which a socket times out if no data is
1874 #      received.
1875 #
1876 #  Type of value:
1877 #
1878 #      Time in seconds.
1879 #
1880 #  Default value:
1881 #
1882 #      None
1883 #
1884 #  Effect if unset:
1885 #
1886 #      A default value of 300 seconds is used.
1887 #
1888 #  Notes:
1889 #
1890 #      The default is quite high and you probably want to reduce it.
1891 #      If you aren't using an occasionally slow proxy like Tor,
1892 #      reducing it to a few seconds should be fine.
1893 #
1894 #  Examples:
1895 #
1896 #      socket-timeout 300
1897 #
1898 socket-timeout 300
1899 #
1900 #  6.9. max-client-connections
1901 #  ============================
1902 #
1903 #  Specifies:
1904 #
1905 #      Maximum number of client connections that will be served.
1906 #
1907 #  Type of value:
1908 #
1909 #      Positive number.
1910 #
1911 #  Default value:
1912 #
1913 #      128
1914 #
1915 #  Effect if unset:
1916 #
1917 #      Connections are served until a resource limit is reached.
1918 #
1919 #  Notes:
1920 #
1921 #      Privoxy creates one thread (or process) for every incoming
1922 #      client connection that isn't rejected based on the access
1923 #      control settings.
1924 #
1925 #      If the system is powerful enough, Privoxy can theoretically
1926 #      deal with several hundred (or thousand) connections at the
1927 #      same time, but some operating systems enforce resource limits
1928 #      by shutting down offending processes and their default limits
1929 #      may be below the ones Privoxy would require under heavy load.
1930 #
1931 #      Configuring Privoxy to enforce a connection limit below the
1932 #      thread or process limit used by the operating system makes
1933 #      sure this doesn't happen. Simply increasing the operating
1934 #      system's limit would work too, but if Privoxy isn't the only
1935 #      application running on the system, you may actually want to
1936 #      limit the resources used by Privoxy.
1937 #
1938 #      If Privoxy is only used by a single trusted user, limiting the
1939 #      number of client connections is probably unnecessary. If there
1940 #      are multiple possibly untrusted users you probably still want
1941 #      to additionally use a packet filter to limit the maximal
1942 #      number of incoming connections per client. Otherwise a
1943 #      malicious user could intentionally create a high number of
1944 #      connections to prevent other users from using Privoxy.
1945 #
1946 #      Obviously using this option only makes sense if you choose a
1947 #      limit below the one enforced by the operating system.
1948 #
1949 #      One most POSIX-compliant systems Privoxy can't properly deal
1950 #      with more than FD_SETSIZE file descriptors at the same time
1951 #      and has to reject connections if the limit is reached. This
1952 #      will likely change in a future version, but currently this
1953 #      limit can't be increased without recompiling Privoxy with a
1954 #      different FD_SETSIZE limit.
1955 #
1956 #  Examples:
1957 #
1958 #      max-client-connections 256
1959 #
1960 #max-client-connections 256
1961 #
1962 #  6.10. listen-backlog
1963 #  =====================
1964 #
1965 #  Specifies:
1966 #
1967 #      Connection queue length requested from the operating system.
1968 #
1969 #  Type of value:
1970 #
1971 #      Number.
1972 #
1973 #  Default value:
1974 #
1975 #      128
1976 #
1977 #  Effect if unset:
1978 #
1979 #      A connection queue length of 128 is requested from the
1980 #      operating system.
1981 #
1982 #  Notes:
1983 #
1984 #      Under high load incoming connection may queue up before
1985 #      Privoxy gets around to serve them. The queue length is
1986 #      limitted by the operating system. Once the queue is full,
1987 #      additional connections are dropped before Privoxy can accept
1988 #      and serve them.
1989 #
1990 #      Increasing the queue length allows Privoxy to accept more
1991 #      incomming connections that arrive roughly at the same time.
1992 #
1993 #      Note that Privoxy can only request a certain queue length,
1994 #      whether or not the requested length is actually used depends
1995 #      on the operating system which may use a different length
1996 #      instead.
1997 #
1998 #      On many operating systems a limit of -1 can be specified to
1999 #      instruct the operating system to use the maximum queue length
2000 #      allowed. Check the listen man page to see if your platform
2001 #      allows this.
2002 #
2003 #      On some platforms you can use "netstat -Lan -p tcp" to see the
2004 #      effective queue length.
2005 #
2006 #      Effectively using a value above 128 usually requires changing
2007 #      the system configuration as well. On FreeBSD-based system the
2008 #      limit is controlled by the kern.ipc.soacceptqueue sysctl.
2009 #
2010 #  Examples:
2011 #
2012 #      listen-backlog 4096
2013 #
2014 #listen-backlog -1
2015 #
2016 #  6.11. enable-accept-filter
2017 #  ===========================
2018 #
2019 #  Specifies:
2020 #
2021 #      Whether or not Privoxy should use an accept filter
2022 #
2023 #  Type of value:
2024 #
2025 #      0 or 1
2026 #
2027 #  Default value:
2028 #
2029 #      0
2030 #
2031 #  Effect if unset:
2032 #
2033 #      No accept filter is enabled.
2034 #
2035 #  Notes:
2036 #
2037 #      Accept filters reduce the number of context switches by not
2038 #      passing sockets for new connections to Privoxy until a
2039 #      complete HTTP request is available.
2040 #
2041 #      As a result, Privoxy can process the whole request right away
2042 #      without having to wait for additional data first.
2043 #
2044 #      For this option to work, Privoxy has to be compiled with
2045 #      FEATURE_ACCEPT_FILTER and the operating system has to support
2046 #      it (which may require loading a kernel module).
2047 #
2048 #      Currently accept filters are only supported on FreeBSD-based
2049 #      systems. Check the accf_http(9) man page to learn how to
2050 #      enable the support in the operating system.
2051 #
2052 #  Examples:
2053 #
2054 #      enable-accept-filter 1
2055 #
2056 #enable-accept-filter 1
2057 #
2058 #  6.12. handle-as-empty-doc-returns-ok
2059 #  =====================================
2060 #
2061 #  Specifies:
2062 #
2063 #      The status code Privoxy returns for pages blocked with
2064 #      +handle-as-empty-document.
2065 #
2066 #  Type of value:
2067 #
2068 #      0 or 1
2069 #
2070 #  Default value:
2071 #
2072 #      0
2073 #
2074 #  Effect if unset:
2075 #
2076 #      Privoxy returns a status 403(forbidden) for all blocked pages.
2077 #
2078 #  Effect if set:
2079 #
2080 #      Privoxy returns a status 200(OK) for pages blocked with
2081 #      +handle-as-empty-document and a status 403(Forbidden) for all
2082 #      other blocked pages.
2083 #
2084 #  Notes:
2085 #
2086 #      This directive was added as a work-around for Firefox bug
2087 #      492459: "Websites are no longer rendered if SSL requests for
2088 #      JavaScripts are blocked by a proxy."
2089 #      (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
2090 #      has been fixed for quite some time, but this directive is also
2091 #      useful to make it harder for websites to detect whether or not
2092 #      resources are being blocked.
2093 #
2094 #handle-as-empty-doc-returns-ok 1
2095 #
2096 #  6.13. enable-compression
2097 #  =========================
2098 #
2099 #  Specifies:
2100 #
2101 #      Whether or not buffered content is compressed before delivery.
2102 #
2103 #  Type of value:
2104 #
2105 #      0 or 1
2106 #
2107 #  Default value:
2108 #
2109 #      0
2110 #
2111 #  Effect if unset:
2112 #
2113 #      Privoxy does not compress buffered content.
2114 #
2115 #  Effect if set:
2116 #
2117 #      Privoxy compresses buffered content before delivering it to
2118 #      the client, provided the client supports it.
2119 #
2120 #  Notes:
2121 #
2122 #      This directive is only supported if Privoxy has been compiled
2123 #      with FEATURE_COMPRESSION, which should not to be confused with
2124 #      FEATURE_ZLIB.
2125 #
2126 #      Compressing buffered content is mainly useful if Privoxy and
2127 #      the client are running on different systems. If they are
2128 #      running on the same system, enabling compression is likely to
2129 #      slow things down. If you didn't measure otherwise, you should
2130 #      assume that it does and keep this option disabled.
2131 #
2132 #      Privoxy will not compress buffered content below a certain
2133 #      length.
2134 #
2135 #enable-compression 1
2136 #
2137 #  6.14. compression-level
2138 #  ========================
2139 #
2140 #  Specifies:
2141 #
2142 #      The compression level that is passed to the zlib library when
2143 #      compressing buffered content.
2144 #
2145 #  Type of value:
2146 #
2147 #      Positive number ranging from 0 to 9.
2148 #
2149 #  Default value:
2150 #
2151 #      1
2152 #
2153 #  Notes:
2154 #
2155 #      Compressing the data more takes usually longer than
2156 #      compressing it less or not compressing it at all. Which level
2157 #      is best depends on the connection between Privoxy and the
2158 #      client. If you can't be bothered to benchmark it for yourself,
2159 #      you should stick with the default and keep compression
2160 #      disabled.
2161 #
2162 #      If compression is disabled, the compression level is
2163 #      irrelevant.
2164 #
2165 #  Examples:
2166 #
2167 #          # Best speed (compared to the other levels)
2168 #          compression-level 1
2169 #
2170 #          # Best compression
2171 #          compression-level 9
2172 #
2173 #          # No compression. Only useful for testing as the added header
2174 #          # slightly increases the amount of data that has to be sent.
2175 #          # If your benchmark shows that using this compression level
2176 #          # is superior to using no compression at all, the benchmark
2177 #          # is likely to be flawed.
2178 #          compression-level 0
2179 #
2180 #
2181 #compression-level 1
2182 #
2183 #  6.15. client-header-order
2184 #  ==========================
2185 #
2186 #  Specifies:
2187 #
2188 #      The order in which client headers are sorted before forwarding
2189 #      them.
2190 #
2191 #  Type of value:
2192 #
2193 #      Client header names delimited by spaces or tabs
2194 #
2195 #  Default value:
2196 #
2197 #      None
2198 #
2199 #  Notes:
2200 #
2201 #      By default Privoxy leaves the client headers in the order they
2202 #      were sent by the client. Headers are modified in-place, new
2203 #      headers are added at the end of the already existing headers.
2204 #
2205 #      The header order can be used to fingerprint client requests
2206 #      independently of other headers like the User-Agent.
2207 #
2208 #      This directive allows to sort the headers differently to
2209 #      better mimic a different User-Agent. Client headers will be
2210 #      emitted in the order given, headers whose name isn't
2211 #      explicitly specified are added at the end.
2212 #
2213 #      Note that sorting headers in an uncommon way will make
2214 #      fingerprinting actually easier. Encrypted headers are not
2215 #      affected by this directive.
2216 #
2217 #client-header-order Host \
2218 #   User-Agent \
2219 #   Accept \
2220 #   Accept-Language \
2221 #   Accept-Encoding \
2222 #   Proxy-Connection \
2223 #   Referer \
2224 #   Cookie \
2225 #   DNT \
2226 #   If-Modified-Since \
2227 #   Cache-Control \
2228 #   Content-Length \
2229 #   Content-Type
2230 #
2231 #
2232 #  6.16. client-specific-tag
2233 #  ==========================
2234 #
2235 #  Specifies:
2236 #
2237 #      The name of a tag that will always be set for clients that
2238 #      requested it through the webinterface.
2239 #
2240 #  Type of value:
2241 #
2242 #      Tag name followed by a description that will be shown in the
2243 #      webinterface
2244 #
2245 #  Default value:
2246 #
2247 #      None
2248 #
2249 #  Notes:
2250 #
2251 #      +-----------------------------------------------------+
2252 #      |                       Warning                       |
2253 #      |-----------------------------------------------------|
2254 #      |This is an experimental feature. The syntax is likely|
2255 #      |to change in future versions.                        |
2256 #      +-----------------------------------------------------+
2257 #
2258 #      Client-specific tags allow Privoxy admins to create different
2259 #      profiles and let the users chose which one they want without
2260 #      impacting other users.
2261 #
2262 #      One use case is allowing users to circumvent certain blocks
2263 #      without having to allow them to circumvent all blocks. This is
2264 #      not possible with the enable-remote-toggle feature because it
2265 #      would bluntly disable all blocks for all users and also affect
2266 #      other actions like filters. It also is set globally which
2267 #      renders it useless in most multi-user setups.
2268 #
2269 #      After a client-specific tag has been defined with the
2270 #      client-specific-tag directive, action sections can be
2271 #      activated based on the tag by using a CLIENT-TAG pattern. The
2272 #      CLIENT-TAG pattern is evaluated at the same priority as URL
2273 #      patterns, as a result the last matching pattern wins. Tags
2274 #      that are created based on client or server headers are
2275 #      evaluated later on and can overrule CLIENT-TAG and URL
2276 #      patterns!
2277 #
2278 #      The tag is set for all requests that come from clients that
2279 #      requested it to be set. Note that "clients" are differentiated
2280 #      by IP address, if the IP address changes the tag has to be
2281 #      requested again.
2282 #
2283 #      Clients can request tags to be set by using the CGI interface
2284 #      http://config.privoxy.org/client-tags. The specific tag
2285 #      description is only used on the web page and should be phrased
2286 #      in away that the user understand the effect of the tag.
2287 #
2288 #  Examples:
2289 #
2290 #          # Define a couple of tags, the described effect requires action sections
2291 #          # that are enabled based on CLIENT-TAG patterns.
2292 #          client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
2293 #          disable-content-filters Disable content-filters but do not affect other actions
2294 #
2295 #
2296 #
2297 #  6.17. client-tag-lifetime
2298 #  ==========================
2299 #
2300 #  Specifies:
2301 #
2302 #      How long a temporarily enabled tag remains enabled.
2303 #
2304 #  Type of value:
2305 #
2306 #      Time in seconds.
2307 #
2308 #  Default value:
2309 #
2310 #      60
2311 #
2312 #  Notes:
2313 #
2314 #      +-----------------------------------------------------+
2315 #      |                       Warning                       |
2316 #      |-----------------------------------------------------|
2317 #      |This is an experimental feature. The syntax is likely|
2318 #      |to change in future versions.                        |
2319 #      +-----------------------------------------------------+
2320 #
2321 #      In case of some tags users may not want to enable them
2322 #      permanently, but only for a short amount of time, for example
2323 #      to circumvent a block that is the result of an overly-broad
2324 #      URL pattern.
2325 #
2326 #      The CGI interface http://config.privoxy.org/client-tags
2327 #      therefore provides a "enable this tag temporarily" option. If
2328 #      it is used, the tag will be set until the client-tag-lifetime
2329 #      is over.
2330 #
2331 #  Examples:
2332 #
2333 #            # Increase the time to life for temporarily enabled tags to 3 minutes
2334 #            client-tag-lifetime 180
2335 #
2336 #
2337 #
2338 #  6.18. trust-x-forwarded-for
2339 #  ============================
2340 #
2341 #  Specifies:
2342 #
2343 #      Whether or not Privoxy should use IP addresses specified with
2344 #      the X-Forwarded-For header
2345 #
2346 #  Type of value:
2347 #
2348 #      0 or one
2349 #
2350 #  Default value:
2351 #
2352 #      0
2353 #
2354 #  Notes:
2355 #
2356 #      +-----------------------------------------------------+
2357 #      |                       Warning                       |
2358 #      |-----------------------------------------------------|
2359 #      |This is an experimental feature. The syntax is likely|
2360 #      |to change in future versions.                        |
2361 #      +-----------------------------------------------------+
2362 #
2363 #      If clients reach Privoxy through another proxy, for example a
2364 #      load balancer, Privoxy can't tell the client's IP address from
2365 #      the connection. If multiple clients use the same proxy, they
2366 #      will share the same client tag settings which is usually not
2367 #      desired.
2368 #
2369 #      This option lets Privoxy use the X-Forwarded-For header value
2370 #      as client IP address. If the proxy sets the header, multiple
2371 #      clients using the same proxy do not share the same client tag
2372 #      settings.
2373 #
2374 #      This option should only be enabled if Privoxy can only be
2375 #      reached through a proxy and if the proxy can be trusted to set
2376 #      the header correctly. It is recommended that ACL are used to
2377 #      make sure only trusted systems can reach Privoxy.
2378 #
2379 #      If access to Privoxy isn't limited to trusted systems, this
2380 #      option would allow malicious clients to change the client tags
2381 #      for other clients or increase Privoxy's memory requirements by
2382 #      registering lots of client tag settings for clients that don't
2383 #      exist.
2384 #
2385 #  Examples:
2386 #
2387 #            # Allow systems that can reach Privoxy to provide the client
2388 #            # IP address with a X-Forwarded-For header.
2389 #            trust-x-forwarded-for 1
2390 #
2391 #
2392 #
2393 #  6.19. receive-buffer-size
2394 #  ==========================
2395 #
2396 #  Specifies:
2397 #
2398 #      The size of the buffer Privoxy uses to receive data from the
2399 #      server.
2400 #
2401 #  Type of value:
2402 #
2403 #      Size in bytes
2404 #
2405 #  Default value:
2406 #
2407 #      5000
2408 #
2409 #  Notes:
2410 #
2411 #      Increasing the receive-buffer-size increases Privoxy's memory
2412 #      usage but can lower the number of context switches and thereby
2413 #      reduce the cpu usage and potentially increase the throughput.
2414 #
2415 #      This is mostly relevant for fast network connections and large
2416 #      downloads that don't require filtering.
2417 #
2418 #      Reducing the buffer size reduces the amount of memory Privoxy
2419 #      needs to handle the request but increases the number of
2420 #      systemcalls and may reduce the throughput.
2421 #
2422 #      A dtrace command like: "sudo dtrace -n 'syscall::read:return /
2423 #      execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0,
2424 #      5, 20); @m = max(arg0)}'" can be used to properly tune the
2425 #      receive-buffer-size. On systems without dtrace, strace or
2426 #      truss may be used as less convenient alternatives.
2427 #
2428 #      If the buffer is too large it will increase Privoxy's memory
2429 #      footprint without any benefit. As the memory is (currently)
2430 #      cleared before using it, a buffer that is too large can
2431 #      actually reduce the throughput.
2432 #
2433 #  Examples:
2434 #
2435 #            # Increase the receive buffer size
2436 #            receive-buffer-size 32768
2437 #
2438 #
2439 #  7. TLS/SSL
2440 #  ===========
2441 #
2442 #  7.1. ca-directory
2443 #  ==================
2444 #
2445 #  Specifies:
2446 #
2447 #      Directory with the CA key, the CA certificate and the trusted
2448 #      CAs file.
2449 #
2450 #  Type of value:
2451 #
2452 #      Text
2453 #
2454 #  Default value:
2455 #
2456 #      Empty string
2457 #
2458 #  Effect if unset:
2459 #
2460 #      Default value is used.
2461 #
2462 #  Notes:
2463 #
2464 #      This directive specifies the directory where the CA key, the
2465 #      CA certificate and the trusted CAs file are located.
2466 #
2467 #  Examples:
2468 #
2469 #      ca-directory /usr/local/etc/privoxy/CA
2470 #
2471 #ca-directory /usr/local/etc/privoxy/CA
2472 #
2473 #  7.2. ca-cert-file
2474 #  ==================
2475 #
2476 #  Specifies:
2477 #
2478 #      The CA certificate file in ".crt" format.
2479 #
2480 #  Type of value:
2481 #
2482 #      Text
2483 #
2484 #  Default value:
2485 #
2486 #      cacert.crt
2487 #
2488 #  Effect if unset:
2489 #
2490 #      Default value is used.
2491 #
2492 #  Notes:
2493 #
2494 #      This directive specifies the name of the CA certificate file
2495 #      in ".crt" format.
2496 #
2497 #      It can be generated with: openssl req -new -x509 -extensions
2498 #      v3_ca -keyout cakey.pem -out cacert.crt -days 3650
2499 #
2500 #  Examples:
2501 #
2502 #      ca-cert-file root.crt
2503 #
2504 #ca-cert-file cacert.crt
2505 #
2506 #  7.3. ca-key-file
2507 #  =================
2508 #
2509 #  Specifies:
2510 #
2511 #      The CA key file in ".pem" format.
2512 #
2513 #  Type of value:
2514 #
2515 #      Text
2516 #
2517 #  Default value:
2518 #
2519 #      cacert.pem
2520 #
2521 #  Effect if unset:
2522 #
2523 #      Default value is used.
2524 #
2525 #  Notes:
2526 #
2527 #      This directive specifies the name of the CA key file in ".pem"
2528 #      format. See the ca-cert-file for a command to generate it.
2529 #
2530 #  Examples:
2531 #
2532 #      ca-key-file cakey.pem
2533 #
2534 #ca-key-file root.pem
2535 #
2536 #  7.4. ca-password
2537 #  =================
2538 #
2539 #  Specifies:
2540 #
2541 #      The password for the CA keyfile.
2542 #
2543 #  Type of value:
2544 #
2545 #      Text
2546 #
2547 #  Default value:
2548 #
2549 #      Empty string
2550 #
2551 #  Effect if unset:
2552 #
2553 #      Default value is used.
2554 #
2555 #  Notes:
2556 #
2557 #      This directive specifies the password for the CA keyfile that
2558 #      is used when Privoxy generates certificates for intercepted
2559 #      requests.
2560 #
2561 #      Note that the password is shown on the CGI page so don't reuse
2562 #      an important one.
2563 #
2564 #  Examples:
2565 #
2566 #      ca-password blafasel
2567 #
2568 #ca-password swordfish
2569 #
2570 #  7.5. certificate-directory
2571 #  ===========================
2572 #
2573 #  Specifies:
2574 #
2575 #      Directory to safe generated keys and certificates.
2576 #
2577 #  Type of value:
2578 #
2579 #      Text
2580 #
2581 #  Default value:
2582 #
2583 #      ./certs
2584 #
2585 #  Effect if unset:
2586 #
2587 #      Default value is used.
2588 #
2589 #  Notes:
2590 #
2591 #      This directive specifies the directory where generated TLS/SSL
2592 #      keys and certificates are saved.
2593 #
2594 #  Examples:
2595 #
2596 #      certificate-directory /usr/local/var/privoxy/certs
2597 #
2598 #certificate-directory /usr/local/var/privoxy/certs
2599 #
2600 #  7.6. trusted-cas-file
2601 #  ======================
2602 #
2603 #  Specifies:
2604 #
2605 #      The trusted CAs file in ".pem" format.
2606 #
2607 #  Type of value:
2608 #
2609 #      File name relative to ca-directory
2610 #
2611 #  Default value:
2612 #
2613 #      trustedCAs.pem
2614 #
2615 #  Effect if unset:
2616 #
2617 #      Default value is used.
2618 #
2619 #  Notes:
2620 #
2621 #      This directive specifies the trusted CAs file that is used
2622 #      when validating certificates for intercepted TLS/SSL request.
2623 #
2624 #      An example file can be downloaded from https://curl.haxx.se/ca
2625 #      /cacert.pem.
2626 #
2627 #  Examples:
2628 #
2629 #      trusted-cas-file trusted_cas_file.pem
2630 #
2631 #trusted-cas-file trustedCAs.pem
2632 #
2633 #  8. WINDOWS GUI OPTIONS
2634 #  =======================
2635 #
2636 #  Privoxy has a number of options specific to the Windows GUI
2637 #  interface:
2638 #
2639 #
2640 #  If "activity-animation" is set to 1, the Privoxy icon will animate
2641 #  when "Privoxy" is active. To turn off, set to 0.
2642 #
2643 #activity-animation   1
2644 #
2645 #  If "log-messages" is set to 1, Privoxy copies log messages to the
2646 #  console window. The log detail depends on the debug directive.
2647 #
2648 #log-messages   1
2649 #
2650 #  If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2651 #  the amount of memory used for the log messages displayed in the
2652 #  console window, will be limited to "log-max-lines" (see below).
2653 #
2654 #  Warning: Setting this to 0 will result in the buffer to grow
2655 #  infinitely and eat up all your memory!
2656 #
2657 #log-buffer-size 1
2658 #
2659 #
2660 #
2661 #  log-max-lines is the maximum number of lines held in the log
2662 #  buffer. See above.
2663 #
2664 #log-max-lines 200
2665 #
2666 #
2667 #
2668 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
2669 #  portions of the log messages with a bold-faced font:
2670 #
2671 #log-highlight-messages 1
2672 #
2673 #
2674 #
2675 #  The font used in the console window:
2676 #
2677 #log-font-name Comic Sans MS
2678 #
2679 #
2680 #
2681 #  Font size used in the console window:
2682 #
2683 #log-font-size 8
2684 #
2685 #
2686 #
2687 #  "show-on-task-bar" controls whether or not Privoxy will appear as
2688 #  a button on the Task bar when minimized:
2689 #
2690 #show-on-task-bar 0
2691 #
2692 #
2693 #
2694 #  If "close-button-minimizes" is set to 1, the Windows close button
2695 #  will minimize Privoxy instead of closing the program (close with
2696 #  the exit option on the File menu).
2697 #
2698 #close-button-minimizes 1
2699 #
2700 #
2701 #
2702 #  The "hide-console" option is specific to the MS-Win console
2703 #  version of Privoxy. If this option is used, Privoxy will
2704 #  disconnect from and hide the command console.
2705 #
2706 #hide-console
2707 #
2708 #
2709 #