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