Rebuilt with recent changes.
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy v3.0.13
2 #
3 #  $Id: config,v 1.79 2009/05/10 10:21:13 fabiankeil Exp $
4 #
5 #  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
6 #
7 ####################################################################
8 #                                                                  #
9 #                      Table of Contents                           #
10 #                                                                  #
11 #        I. INTRODUCTION                                           #
12 #       II. FORMAT OF THE CONFIGURATION FILE                       #
13 #                                                                  #
14 #        1. LOCAL SET-UP DOCUMENTATION                             #
15 #        2. CONFIGURATION AND LOG FILE LOCATIONS                   #
16 #        3. DEBUGGING                                              #
17 #        4. ACCESS CONTROL AND SECURITY                            #
18 #        5. FORWARDING                                             #
19 #        6. WINDOWS GUI OPTIONS                                    #
20 #                                                                  #
21 ####################################################################
22 #
23 #
24 #  I. INTRODUCTION
25 #   ===============
26 #
27 #  This file holds Privoxy's main configuration. Privoxy detects
28 #  configuration changes automatically, so you don't have to restart
29 #  it unless you want to load a different configuration file.
30 #
31 #  The configuration will be reloaded with the first request after
32 #  the change was done, this request itself will still use the old
33 #  configuration, though. In other words: it takes two requests before
34 #  you see the result of your changes.  Requests that are dropped due
35 #  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 directory
40 #  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 '#'
55 #  is ignored, except if the '#' is preceded by a '\'.
56 #
57 #  Thus, by placing a # at the start of an existing configuration
58 #  line, you can make it a comment and it will be treated as if it
59 #  weren't there. This is called "commenting out" an option and can
60 #  be useful. Removing the # again is called "uncommenting".
61 #
62 #  Note that commenting out an option and leaving it at its default
63 #  are two completely different things! Most options behave very
64 #  differently when unset.  See the "Effect if unset" explanation in
65 #  each option's description for details.
66 #
67 #  Long lines can be continued on the next line by using a `\' as the
68 #  last character.
69 #
70 #
71 #
72 #  1. LOCAL SET-UP DOCUMENTATION
73 #  ==============================
74 #
75 #  If you intend to operate Privoxy for more users than just yourself,
76 #  it might be a good idea to let them know how to reach you, what
77 #  you block and why you do that, your policies, etc.
78 #
79 #
80 #
81 #  1.1. user-manual
82 #  =================
83 #
84 #  Specifies:
85 #
86 #      Location of the Privoxy User Manual.
87 #
88 #  Type of value:
89 #
90 #      A fully qualified URI
91 #
92 #  Default value:
93 #
94 #      Unset
95 #
96 #  Effect if unset:
97 #
98 #      http://www.privoxy.org/version/user-manual/ will be used,
99 #      where version is the Privoxy version.
100 #
101 #  Notes:
102 #
103 #      The User Manual URI is the single best source of information on
104 #      Privoxy, and is used for help links from some of the internal
105 #      CGI pages. The manual itself is normally packaged with the
106 #      binary distributions, so you probably want to set this to a
107 #      locally installed copy.
108 #
109 #      Examples:
110 #
111 #      The best all purpose solution is simply to put the full local
112 #      PATH to where the User Manual is located:
113 #
114 #        user-manual  /usr/share/doc/privoxy/user-manual
115 #
116 #
117 #      The User Manual is then available to anyone with
118 #      access to Privoxy, by following the built-in URL:
119 #      http://config.privoxy.org/user-manual/ (or the shortcut:
120 #      http://p.p/user-manual/).
121 #
122 #      If the documentation is not on the local system, it can be
123 #      accessed from a remote server, as:
124 #
125 #        user-manual  http://example.com/privoxy/user-manual/
126 #
127 #
128 #      WARNING!!!
129 #
130 #          If set, this option should be the first option in the config
131 #          file, because it is used while the config file is being read.
132 #
133 #user-manual http://www.privoxy.org/user-manual/
134 #
135 #
136 #  1.2. trust-info-url
137 #  ====================
138 #
139 #  Specifies:
140 #
141 #      A URL to be displayed in the error page that users will see if
142 #      access to an untrusted page is denied.
143 #
144 #  Type of value:
145 #
146 #      URL
147 #
148 #  Default value:
149 #
150 #      Unset
151 #
152 #  Effect if unset:
153 #
154 #      No links are displayed on the "untrusted" error page.
155 #
156 #  Notes:
157 #
158 #      The value of this option only matters if the experimental trust
159 #      mechanism has been activated. (See trustfile below.)
160 #
161 #      If you use the trust mechanism, it is a good idea to write
162 #      up some on-line documentation about your trust policy and to
163 #      specify the URL(s) here. Use multiple times for multiple URLs.
164 #
165 #      The URL(s) should be added to the trustfile as well, so users
166 #      don't end up locked out from the information on why they were
167 #      locked out in the first place!
168 #
169 #trust-info-url  http://www.example.com/why_we_block.html
170 #trust-info-url  http://www.example.com/what_we_allow.html
171 #
172 #
173 #  1.3. admin-address
174 #  ===================
175 #
176 #  Specifies:
177 #
178 #      An email address to reach the Privoxy administrator.
179 #
180 #  Type of value:
181 #
182 #      Email address
183 #
184 #  Default value:
185 #
186 #      Unset
187 #
188 #  Effect if unset:
189 #
190 #      No email address is displayed on error pages and the CGI user
191 #      interface.
192 #
193 #  Notes:
194 #
195 #      If both admin-address and proxy-info-url are unset, the whole
196 #      "Local Privoxy Support" box on all generated pages will not
197 #      be shown.
198 #
199 #admin-address privoxy-admin@example.com
200 #
201 #
202 #  1.4. proxy-info-url
203 #  ====================
204 #
205 #  Specifies:
206 #
207 #      A URL to documentation about the local Privoxy setup,
208 #      configuration or policies.
209 #
210 #  Type of value:
211 #
212 #      URL
213 #
214 #  Default value:
215 #
216 #      Unset
217 #
218 #  Effect if unset:
219 #
220 #      No link to local documentation is displayed on error pages and
221 #      the CGI user interface.
222 #
223 #  Notes:
224 #
225 #      If both admin-address and proxy-info-url are unset, the whole
226 #      "Local Privoxy Support" box on all generated pages will not
227 #      be shown.
228 #
229 #      This URL shouldn't be blocked ;-)
230 #
231 #proxy-info-url http://www.example.com/proxy-service.html
232 #
233 #
234 #  2. CONFIGURATION AND LOG FILE LOCATIONS
235 #  ========================================
236 #
237 #  Privoxy can (and normally does) use a number of other files for
238 #  additional configuration, help and logging. This section of the
239 #  configuration file tells Privoxy where to find those other files.
240 #
241 #  The user running Privoxy, must have read permission for all
242 #  configuration files, and write permission to any files that would
243 #  be modified, such as log files and actions files.
244 #
245 #
246 #
247 #  2.1. confdir
248 #  =============
249 #
250 #  Specifies:
251 #
252 #      The directory where the other configuration files are located.
253 #
254 #  Type of value:
255 #
256 #      Path name
257 #
258 #  Default value:
259 #
260 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
261 #
262 #  Effect if unset:
263 #
264 #      Mandatory
265 #
266 #  Notes:
267 #
268 #      No trailing "/", please.
269 #
270 confdir .
271 #
272 #
273 #  2.2. templdir
274 #  ==============
275 #
276 #  Specifies:
277 #
278 #      An alternative directory where the templates are loaded from.
279 #
280 #  Type of value:
281 #
282 #      Path name
283 #
284 #  Default value:
285 #
286 #      unset
287 #
288 #  Effect if unset:
289 #
290 #      The templates are assumed to be located in confdir/template.
291 #
292 #  Notes:
293 #
294 #      Privoxy's original templates are usually overwritten with each
295 #      update. Use this option to relocate customized templates that
296 #      should be kept. As template variables might change between
297 #      updates, you shouldn't expect templates to work with Privoxy
298 #      releases other than the one they were part of, though.
299 #
300 #templdir .
301 #
302 #
303 #  2.3. logdir
304 #  ============
305 #
306 #  Specifies:
307 #
308 #      The directory where all logging takes place (i.e. where the
309 #      logfile is located).
310 #
311 #  Type of value:
312 #
313 #      Path name
314 #
315 #  Default value:
316 #
317 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
318 #
319 #  Effect if unset:
320 #
321 #      Mandatory
322 #
323 #  Notes:
324 #
325 #      No trailing "/", please.
326 #
327 logdir .
328 #
329 #
330 #  2.4. actionsfile
331 #  =================
332 #
333 #  Specifies:
334 #
335 #      The actions file(s) to use
336 #
337 #  Type of value:
338 #
339 #      Complete file name, relative to confdir
340 #
341 #  Default values:
342 #
343 #        match-all.action # Actions that are applied to all sites and maybe overruled later on.
344 #
345 #        default.action   # Main actions file
346 #
347 #        user.action      # User customizations
348 #
349 #  Effect if unset:
350 #
351 #      No actions are taken at all. More or less neutral proxying.
352 #
353 #  Notes:
354 #
355 #      Multiple actionsfile lines are permitted, and are in fact
356 #      recommended!
357 #
358 #      The default values are default.action, which is the "main"
359 #      actions file maintained by the developers, and user.action,
360 #      where you can make your personal additions.
361 #
362 #      Actions files contain all the per site and per URL configuration
363 #      for ad blocking, cookie management, privacy considerations,
364 #      etc. There is no point in using Privoxy without at least one
365 #      actions file.
366 #
367 #      Note that since Privoxy 3.0.7, the complete filename, including
368 #      the ".action" extension has to be specified. The syntax change
369 #      was necessary to be consistent with the other file options and
370 #      to allow previously forbidden characters.
371 #
372 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
373 actionsfile default.action   # Main actions file
374 actionsfile user.action      # User customizations
375 #
376 #
377 #  2.5. filterfile
378 #  ================
379 #
380 #  Specifies:
381 #
382 #      The filter file(s) to use
383 #
384 #  Type of value:
385 #
386 #      File name, relative to confdir
387 #
388 #  Default value:
389 #
390 #      default.filter (Unix) or default.filter.txt (Windows)
391 #
392 #  Effect if unset:
393 #
394 #      No textual content filtering takes place, i.e. all +filter{name}
395 #      actions in the actions files are turned neutral.
396 #
397 #  Notes:
398 #
399 #      Multiple filterfile lines are permitted.
400 #
401 #      The filter files contain content modification rules that use
402 #      regular expressions. These rules permit powerful changes on the
403 #      content of Web pages, and optionally the headers as well, e.g.,
404 #      you could try to disable your favorite JavaScript annoyances,
405 #      re-write the actual displayed text, or just have some fun
406 #      playing buzzword bingo with web pages.
407 #
408 #      The +filter{name} actions rely on the relevant filter (name)
409 #      to be defined in a filter file!
410 #
411 #      A pre-defined filter file called default.filter that contains a
412 #      number of useful filters for common problems is included in the
413 #      distribution. See the section on the filter action for a list.
414 #
415 #      It is recommended to place any locally adapted filters into a
416 #      separate file, such as user.filter.
417 #
418 filterfile default.filter
419 #filterfile user.filter      # User customizations
420 #
421 #
422 #  2.6. logfile
423 #  =============
424 #
425 #  Specifies:
426 #
427 #      The log file to use
428 #
429 #  Type of value:
430 #
431 #      File name, relative to logdir
432 #
433 #  Default value:
434 #
435 #      Unset (commented out). When activated: logfile (Unix) or
436 #      privoxy.log (Windows).
437 #
438 #  Effect if unset:
439 #
440 #      No logfile is written.
441 #
442 #  Notes:
443 #
444 #      The logfile is where all logging and error messages are
445 #      written. The level of detail and number of messages are set with
446 #      the debug option (see below).  The logfile can be useful for
447 #      tracking down a problem with Privoxy (e.g., it's not blocking
448 #      an ad you think it should block) and it can help you to monitor
449 #      what your browser is doing.
450 #
451 #      Depending on the debug options below, the logfile may be a
452 #      privacy risk if third parties can get access to it. As most
453 #      users will never look at it, Privoxy 3.0.7 and later only log
454 #      fatal errors by default.
455 #
456 #      For most troubleshooting purposes, you will have to change that,
457 #      please refer to the debugging section for details.
458 #
459 #      Your logfile will grow indefinitely, and you will probably
460 #      want to periodically remove it. On Unix systems, you can do
461 #      this with a cron job (see "man cron"). For Red Hat based Linux
462 #      distributions, a logrotate script has been included.
463 #
464 #      Any log files must be writable by whatever user Privoxy is
465 #      being run as (on Unix, default user id is "privoxy").
466 #
467 logfile logfile
468 #
469 #
470 #  2.7. trustfile
471 #  ===============
472 #
473 #  Specifies:
474 #
475 #      The name of the trust file to use
476 #
477 #  Type of value:
478 #
479 #      File name, relative to confdir
480 #
481 #  Default value:
482 #
483 #      Unset (commented out). When activated: trust (Unix) or trust.txt
484 #      (Windows)
485 #
486 #  Effect if unset:
487 #
488 #      The entire trust mechanism is disabled.
489 #
490 #  Notes:
491 #
492 #      The trust mechanism is an experimental feature for building
493 #      white-lists and should be used with care. It is NOT recommended
494 #      for the casual user.
495 #
496 #      If you specify a trust file, Privoxy will only allow access to
497 #      sites that are specified in the trustfile. Sites can be listed
498 #      in one of two ways:
499 #
500 #      Prepending a ~ character limits access to this site only (and
501 #      any sub-paths within this site), e.g. ~www.example.com allows
502 #      access to ~www.example.com/ features/news.html, etc.
503 #
504 #      Or, you can designate sites as trusted referrers, by prepending
505 #      the name with a + character. The effect is that access to
506 #      untrusted sites will be granted -- but only if a link from
507 #      this trusted referrer was used to get there. The link target
508 #      will then be added to the "trustfile" so that future, direct
509 #      accesses will be granted. Sites added via this mechanism do
510 #      not become trusted referrers themselves (i.e. they are added
511 #      with a ~ designation). There is a limit of 512 such entries,
512 #      after which new entries will not be made.
513 #
514 #      If you use the + operator in the trust file, it may grow
515 #      considerably over time.
516 #
517 #      It is recommended that Privoxy be compiled with the
518 #      --disable-force, --disable-toggle and --disable-editor options,
519 #      if this feature is to be used.
520 #
521 #      Possible applications include limiting Internet access for
522 #      children.
523 #
524 #trustfile trust
525 #
526 #
527 #  3. DEBUGGING
528 #  =============
529 #
530 #  These options are mainly useful when tracing a problem. Note that
531 #  you might also want to invoke Privoxy with the --no-daemon command
532 #  line option when debugging.
533 #
534 #
535 #
536 #  3.1. debug
537 #  ===========
538 #
539 #  Specifies:
540 #
541 #      Key values that determine what information gets logged.
542 #
543 #  Type of value:
544 #
545 #      Integer values
546 #
547 #  Default value:
548 #
549 #      0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)
550 #
551 #  Effect if unset:
552 #
553 #      Default value is used (see above).
554 #
555 #  Notes:
556 #
557 #      The available debug levels are:
558 #
559 #        debug         1 # Log the destination for each request Privoxy let through. See also debug 1024.
560 #        debug         2 # show each connection status
561 #        debug         4 # show I/O status
562 #        debug         8 # show header parsing
563 #        debug        16 # log all data written to the network into the logfile
564 #        debug        32 # debug force feature
565 #        debug        64 # debug regular expression filters
566 #        debug       128 # debug redirects
567 #        debug       256 # debug GIF de-animation
568 #        debug       512 # Common Log Format
569 #        debug      1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
570 #        debug      2048 # CGI user interface
571 #        debug      4096 # Startup banner and warnings.
572 #        debug      8192 # Non-fatal errors
573 #
574 #
575 #      To select multiple debug levels, you can either add them or
576 #      use multiple debug lines.
577 #
578 #      A debug level of 1 is informative because it will show you each
579 #      request as it happens. 1, 1024, 4096 and 8192 are recommended
580 #      so that you will notice when things go wrong. The other levels
581 #      are probably only of interest if you are hunting down a specific
582 #      problem. They can produce a hell of an output (especially 16).
583 #
584 #      Privoxy used to ship with the debug levels recommended above
585 #      enabled by default, but due to privacy concerns 3.0.7 and later
586 #      are configured to only log fatal errors.
587 #
588 #      If you are used to the more verbose settings, simply enable
589 #      the debug lines below again.
590 #
591 #      If you want to use pure CLF (Common Log Format), you should set
592 #      "debug 512" ONLY and not enable anything else.
593 #
594 #      Privoxy has a hard-coded limit for the length of log messages. If
595 #      it's reached, messages are logged truncated and marked with
596 #      "... [too long, truncated]".
597 #
598 #      Please don't file any support requests without trying to
599 #      reproduce the problem with increased debug level first. Once
600 #      you read the log messages, you may even be able to solve the
601 #      problem on your own.
602 #
603 #debug      1 # Log the destination for each request Privoxy let through.
604 #debug   1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
605 #debug   4096 # Startup banner and warnings
606 #debug   8192 # Non-fatal errors
607 #
608 #
609 #  3.2. single-threaded
610 #  =====================
611 #
612 #  Specifies:
613 #
614 #      Whether to run only one server thread.
615 #
616 #  Type of value:
617 #
618 #      None
619 #
620 #  Default value:
621 #
622 #      Unset
623 #
624 #  Effect if unset:
625 #
626 #      Multi-threaded (or, where unavailable: forked) operation,
627 #      i.e. the ability to serve multiple requests simultaneously.
628 #
629 #  Notes:
630 #
631 #      This option is only there for debugging purposes. It will
632 #      drastically reduce performance.
633 #
634 #single-threaded
635 #
636 #
637 #  3.3. hostname
638 #  ==============
639 #
640 #  Specifies:
641 #
642 #      The hostname shown on the CGI pages.
643 #
644 #  Type of value:
645 #
646 #      Text
647 #
648 #  Default value:
649 #
650 #      Unset
651 #
652 #  Effect if unset:
653 #
654 #      The hostname provided by the operating system is used.
655 #
656 #  Notes:
657 #
658 #      On some misconfigured systems resolving the hostname fails or
659 #      takes too much time and slows Privoxy down. Setting a fixed
660 #      hostname works around the problem.
661 #
662 #      In other circumstances it might be desirable to show a hostname
663 #      other than the one returned by the operating system. For example
664 #      if the system has several different hostnames and you don't
665 #      want to use the first one.
666 #
667 #      Note that Privoxy does not validate the specified hostname value.
668 #
669 #hostname hostname.example.org
670 #
671 #
672 #  4. ACCESS CONTROL AND SECURITY
673 #  ===============================
674 #
675 #  This section of the config file controls the security-relevant
676 #  aspects of Privoxy's configuration.
677 #
678 #
679 #
680 #  4.1. listen-address
681 #  ====================
682 #
683 #  Specifies:
684 #
685 #      The IP address and TCP port on which Privoxy will listen for
686 #      client requests.
687 #
688 #  Type of value:
689 #
690 #      [IP-Address]:Port
691 #
692 #  Default value:
693 #
694 #      127.0.0.1:8118
695 #
696 #  Effect if unset:
697 #
698 #      Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable
699 #      and recommended for home users who run Privoxy on the same
700 #      machine as their browser.
701 #
702 #  Notes:
703 #
704 #      You will need to configure your browser(s) to this proxy address
705 #      and port.
706 #
707 #      If you already have another service running on port 8118, or
708 #      if you want to serve requests from other machines (e.g. on your
709 #      local network) as well, you will need to override the default.
710 #
711 #      IPv6 addresses containing colons have to be quoted by brackets.
712 #
713 #      If you leave out the IP address, Privoxy will bind to all IPv4
714 #      interfaces (addresses) on your machine and may become reachable
715 #      from the Internet. In that case, consider using access control
716 #      lists (ACL's, see below), and/or a firewall. If the hostname
717 #      is localhost, Privoxy will explicitly try to bind to an IPv4
718 #      address. For other hostnames it depends on the operating system
719 #      which IP version will be used.
720 #
721 #      If you open Privoxy to untrusted users, you will also
722 #      want to make sure that the following actions are disabled:
723 #      enable-edit-actions and enable-remote-toggle
724 #
725 #  Example:
726 #
727 #      Suppose you are running Privoxy on a machine which has the
728 #      address 192.168.0.1 on your local private network (192.168.0.0)
729 #      and has another outside connection with a different address. You
730 #      want it to serve requests from inside only:
731 #
732 #        listen-address  192.168.0.1:8118
733 #
734 #
735 #      Suppose you are running Privoxy on an IPv6-capable machine and
736 #      you want it to listen on the IPv6 address of the loopback device:
737 #
738 #        listen-address [::1]:8118
739 #
740 #
741 listen-address  127.0.0.1:8118
742 #
743 #
744 #  4.2. toggle
745 #  ============
746 #
747 #  Specifies:
748 #
749 #      Initial state of "toggle" status
750 #
751 #  Type of value:
752 #
753 #      1 or 0
754 #
755 #  Default value:
756 #
757 #      1
758 #
759 #  Effect if unset:
760 #
761 #      Act as if toggled on
762 #
763 #  Notes:
764 #
765 #      If set to 0, Privoxy will start in "toggled off" mode,
766 #      i.e. mostly behave like a normal, content-neutral proxy
767 #      with both ad blocking and content filtering disabled. See
768 #      enable-remote-toggle below.
769 #
770 #      The windows version will only display the toggle icon in the
771 #      system tray if this option is present.
772 #
773 toggle  1
774 #
775 #
776 #  4.3. enable-remote-toggle
777 #  ==========================
778 #
779 #  Specifies:
780 #
781 #      Whether or not the web-based toggle feature may be used
782 #
783 #  Type of value:
784 #
785 #      0 or 1
786 #
787 #  Default value:
788 #
789 #      0
790 #
791 #  Effect if unset:
792 #
793 #      The web-based toggle feature is disabled.
794 #
795 #  Notes:
796 #
797 #      When toggled off, Privoxy mostly acts like a normal,
798 #      content-neutral proxy, i.e. doesn't block ads or filter content.
799 #
800 #      Access to the toggle feature can not be controlled separately by
801 #      "ACLs" or HTTP authentication, so that everybody who can access
802 #      Privoxy (see "ACLs" and listen-address above) can toggle it
803 #      for all users. So this option is not recommended for multi-user
804 #      environments with untrusted users.
805 #
806 #      Note that malicious client side code (e.g Java) is also capable
807 #      of using this option.
808 #
809 #      As a lot of Privoxy users don't read documentation, this feature
810 #      is disabled by default.
811 #
812 #      Note that you must have compiled Privoxy with support for this
813 #      feature, otherwise this option has no effect.
814 #
815 enable-remote-toggle  0
816 #
817 #
818 #  4.4. enable-remote-http-toggle
819 #  ===============================
820 #
821 #  Specifies:
822 #
823 #      Whether or not Privoxy recognizes special HTTP headers to change
824 #      its behaviour.
825 #
826 #  Type of value:
827 #
828 #      0 or 1
829 #
830 #  Default value:
831 #
832 #      0
833 #
834 #  Effect if unset:
835 #
836 #      Privoxy ignores special HTTP headers.
837 #
838 #  Notes:
839 #
840 #      When toggled on, the client can change Privoxy's behaviour by
841 #      setting special HTTP headers. Currently the only supported
842 #      special header is "X-Filter: No", to disable filtering for
843 #      the ongoing request, even if it is enabled in one of the
844 #      action files.
845 #
846 #      This feature is disabled by default. If you are using Privoxy in
847 #      a environment with trusted clients, you may enable this feature
848 #      at your discretion. Note that malicious client side code (e.g
849 #      Java) is also capable of using this feature.
850 #
851 #      This option will be removed in future releases as it has been
852 #      obsoleted by the more general header taggers.
853 #
854 enable-remote-http-toggle  0
855 #
856 #
857 #  4.5. enable-edit-actions
858 #  =========================
859 #
860 #  Specifies:
861 #
862 #      Whether or not the web-based actions file editor may be used
863 #
864 #  Type of value:
865 #
866 #      0 or 1
867 #
868 #  Default value:
869 #
870 #      0
871 #
872 #  Effect if unset:
873 #
874 #      The web-based actions file editor is disabled.
875 #
876 #  Notes:
877 #
878 #      Access to the editor can not be controlled separately by
879 #      "ACLs" or HTTP authentication, so that everybody who can access
880 #      Privoxy (see "ACLs" and listen-address above) can modify its
881 #      configuration for all users.
882 #
883 #      This option is not recommended for environments with untrusted
884 #      users and as a lot of Privoxy users don't read documentation,
885 #      this feature is disabled by default.
886 #
887 #      Note that malicious client side code (e.g Java) is also capable
888 #      of using the actions editor and you shouldn't enable this
889 #      options unless you understand the consequences and are sure
890 #      your browser is configured correctly.
891 #
892 #      Note that you must have compiled Privoxy with support for this
893 #      feature, otherwise this option has no effect.
894 #
895 enable-edit-actions 0
896 #
897 #
898 #  4.6. enforce-blocks
899 #  ====================
900 #
901 #  Specifies:
902 #
903 #      Whether the user is allowed to ignore blocks and can "go there
904 #      anyway".
905 #
906 #  Type of value:
907 #
908 #      0 or 1
909 #
910 #  Default value:
911 #
912 #      0
913 #
914 #  Effect if unset:
915 #
916 #      Blocks are not enforced.
917 #
918 #  Notes:
919 #
920 #      Privoxy is mainly used to block and filter requests as a service
921 #      to the user, for example to block ads and other junk that clogs
922 #      the pipes.  Privoxy's configuration isn't perfect and sometimes
923 #      innocent pages are blocked. In this situation it makes sense to
924 #      allow the user to enforce the request and have Privoxy ignore
925 #      the block.
926 #
927 #      In the default configuration Privoxy's "Blocked" page contains
928 #      a "go there anyway" link to adds a special string (the force
929 #      prefix) to the request URL. If that link is used, Privoxy
930 #      will detect the force prefix, remove it again and let the
931 #      request pass.
932 #
933 #      Of course Privoxy can also be used to enforce a network
934 #      policy. In that case the user obviously should not be able to
935 #      bypass any blocks, and that's what the "enforce-blocks" option
936 #      is for. If it's enabled, Privoxy hides the "go there anyway"
937 #      link. If the user adds the force prefix by hand, it will not
938 #      be accepted and the circumvention attempt is logged.
939 #
940 #  Examples:
941 #
942 #      enforce-blocks 1
943 #
944 enforce-blocks 0
945 #
946 #
947 #  4.7. ACLs: permit-access and deny-access
948 #  =========================================
949 #
950 #  Specifies:
951 #
952 #      Who can access what.
953 #
954 #  Type of value:
955 #
956 #      src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
957 #
958 #      Where src_addr and dst_addr are IPv4 addresses in dotted
959 #      decimal notation or valid DNS names, port is a port number, and
960 #      src_masklen and dst_masklen are subnet masks in CIDR notation,
961 #      i.e. integer values from 2 to 30 representing the length
962 #      (in bits) of the network address. The masks and the whole
963 #      destination part are optional.
964 #
965 #      If your system implements RFC 3493, then src_addr and dst_addr
966 #      can be IPv6 addresses delimeted by brackets, port can be a
967 #      number or a service name, and src_masklen and dst_masklen can
968 #      be a number from 0 to 128.
969 #
970 #  Default value:
971 #
972 #      Unset
973 #
974 #      If no port is specified, any port will match. If no src_masklen
975 #      or src_masklen is given, the complete IP address has to match
976 #      (i.e. 32 bits for IPv4 and 128 bits for IPv6).
977 #
978 #  Effect if unset:
979 #
980 #      Don't restrict access further than implied by listen-address
981 #
982 #  Notes:
983 #
984 #      Access controls are included at the request of ISPs and systems
985 #      administrators, and are not usually needed by individual
986 #      users. For a typical home user, it will normally suffice to
987 #      ensure that Privoxy only listens on the localhost (127.0.0.1)
988 #      or internal (home) network address by means of the listen-address
989 #      option.
990 #
991 #      Please see the warnings in the FAQ that Privoxy is not intended
992 #      to be a substitute for a firewall or to encourage anyone to
993 #      defer addressing basic security weaknesses.
994 #
995 #      Multiple ACL lines are OK. If any ACLs are specified, Privoxy
996 #      only talks to IP addresses that match at least one permit-access
997 #      line and don't match any subsequent deny-access line. In other
998 #      words, the last match wins, with the default being deny-access.
999 #
1000 #      If Privoxy is using a forwarder (see forward below) for a
1001 #      particular destination URL, the dst_addr that is examined is
1002 #      the address of the forwarder and NOT the address of the ultimate
1003 #      target. This is necessary because it may be impossible for the
1004 #      local Privoxy to determine the IP address of the ultimate target
1005 #      (that's often what gateways are used for).
1006 #
1007 #      You should prefer using IP addresses over DNS names, because
1008 #      the address lookups take time. All DNS names must resolve! You
1009 #      can not use domain patterns like "*.org" or partial domain
1010 #      names. If a DNS name resolves to multiple IP addresses, only
1011 #      the first one is used.
1012 #
1013 #      Some systems allows IPv4 client to connect to IPv6 server
1014 #      socket. Then the client's IPv4 address will be translated by
1015 #      system into IPv6 address space with special prefix ::ffff:0:0/96
1016 #      (so called IPv4 mapped IPv6 address).  Privoxy can handle it
1017 #      and maps such ACL addresses automatically.
1018 #
1019 #      Denying access to particular sites by ACL may have undesired
1020 #      side effects if the site in question is hosted on a machine
1021 #      which also hosts other sites (most sites are).
1022 #
1023 #  Examples:
1024 #
1025 #      Explicitly define the default behavior if no ACL and
1026 #      listen-address are set: "localhost" is OK. The absence of a
1027 #      dst_addr implies that all destination addresses are OK:
1028 #
1029 #        permit-access  localhost
1030 #
1031 #
1032 #      Allow any host on the same class C subnet as www.privoxy.org
1033 #      access to nothing but www.example.com (or other domains hosted
1034 #      on the same system):
1035 #
1036 #        permit-access  www.privoxy.org/24 www.example.com/32
1037 #
1038 #
1039 #      Allow access from any host on the 26-bit subnet 192.168.45.64 to
1040 #      anywhere, with the exception that 192.168.45.73 may not access
1041 #      the IP address behind www.dirty-stuff.example.com:
1042 #
1043 #        permit-access  192.168.45.64/26 
1044 #        deny-access   192.168.45.73  www.dirty-stuff.example.com
1045 #
1046 #      Allow access from the IPv4 network 192.0.2.0/24 even if listening
1047 #      on an IPv6 wild card address (not supported on all platforms):
1048 #
1049 #        permit-access  192.0.2.0/24
1050 #
1051 #
1052 #      This is equivalent to the following line even if listening on
1053 #      an IPv4 address (not supported on all platforms):
1054 #
1055 #        permit-access  [::ffff:192.0.2.0]/120
1056 #
1057 #
1058 #  4.8. buffer-limit
1059 #  ==================
1060 #
1061 #  Specifies:
1062 #
1063 #      Maximum size of the buffer for content filtering.
1064 #
1065 #  Type of value:
1066 #
1067 #      Size in Kbytes
1068 #
1069 #  Default value:
1070 #
1071 #      4096
1072 #
1073 #  Effect if unset:
1074 #
1075 #      Use a 4MB (4096 KB) limit.
1076 #
1077 #  Notes:
1078 #
1079 #      For content filtering, i.e. the +filter and +deanimate-gif
1080 #      actions, it is necessary that Privoxy buffers the entire document
1081 #      body. This can be potentially dangerous, since a server could
1082 #      just keep sending data indefinitely and wait for your RAM to
1083 #      exhaust -- with nasty consequences.  Hence this option.
1084 #
1085 #      When a document buffer size reaches the buffer-limit, it is
1086 #      flushed to the client unfiltered and no further attempt to filter
1087 #      the rest of the document is made. Remember that there may be
1088 #      multiple threads running, which might require up to buffer-limit
1089 #      Kbytes each, unless you have enabled "single-threaded" above.
1090 #
1091 buffer-limit 4096
1092 #
1093 #
1094 #  5. FORWARDING
1095 #  ==============
1096 #
1097 #  This feature allows routing of HTTP requests through a chain of
1098 #  multiple proxies.
1099 #
1100 #  Forwarding can be used to chain Privoxy with a caching proxy to
1101 #  speed up browsing. Using a parent proxy may also be necessary if
1102 #  the machine that Privoxy runs on has no direct Internet access.
1103 #
1104 #  Note that parent proxies can severely decrease your privacy
1105 #  level. For example a parent proxy could add your IP address to the
1106 #  request headers and if it's a caching proxy it may add the "Etag"
1107 #  header to revalidation requests again, even though you configured
1108 #  Privoxy to remove it. It may also ignore Privoxy's header time
1109 #  randomization and use the original values which could be used by
1110 #  the server as cookie replacement to track your steps between visits.
1111 #
1112 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1113 #  4 and SOCKS 4A protocols.
1114 #
1115 #
1116 #
1117 #  5.1. forward
1118 #  =============
1119 #
1120 #  Specifies:
1121 #
1122 #      To which parent HTTP proxy specific requests should be routed.
1123 #
1124 #  Type of value:
1125 #
1126 #      target_pattern http_parent[:port]
1127 #
1128 #      where target_pattern is a URL pattern that specifies to which
1129 #      requests (i.e. URLs) this forward rule shall apply. Use /
1130 #      to denote "all URLs".  http_parent[:port] is the DNS name or
1131 #      IP address of the parent HTTP proxy through which the requests
1132 #      should be forwarded, optionally followed by its listening port
1133 #      (default: 8000). Use a single dot (.) to denote "no forwarding".
1134 #
1135 #  Default value:
1136 #
1137 #      Unset
1138 #
1139 #  Effect if unset:
1140 #
1141 #      Don't use parent HTTP proxies.
1142 #
1143 #  Notes:
1144 #
1145 #      If http_parent is ".", then requests are not forwarded to
1146 #      another HTTP proxy but are made directly to the web servers.
1147 #
1148 #      http_parent can be a numerical IPv6 address (if RFC 3493 is
1149 #      implemented).  To prevent clashes with the port delimiter,
1150 #      the whole IP address has to be put into brackets. On the other
1151 #      hand a target_pattern containing an IPv6 address has to be put
1152 #      into angle brackets (normal brackets are reserved for regular
1153 #      expressions already).
1154 #
1155 #      Multiple lines are OK, they are checked in sequence, and the
1156 #      last match wins.
1157 #
1158 #  Examples:
1159 #
1160 #      Everything goes to an example parent proxy, except SSL on port
1161 #      443 (which it doesn't handle):
1162 #
1163 #        forward   /      parent-proxy.example.org:8080 
1164 #        forward   :443   .
1165 #
1166 #
1167 #      Everything goes to our example ISP's caching proxy, except for
1168 #      requests to that ISP's sites:
1169 #
1170 #        forward   /                  caching-proxy.isp.example.net:8000
1171 #        forward   .isp.example.net   .
1172 #
1173 #
1174 #      Parent proxy specified by an IPv6 address:
1175 #
1176 #        foward   /                   [2001:DB8::1]:8000
1177 #
1178 #
1179 #      Suppose your parent proxy doesn't support IPv6:
1180 #
1181 #        forward  /                        parent-proxy.example.org:8000
1182 #        forward  ipv6-server.example.org  .
1183 #        forward  <[2-3][0-9a-f][0-9a-f][0-9a-f]:*>   .
1184 #
1185 #
1186 #  5.2. forward-socks4, forward-socks4a and forward-socks5
1187 #  ========================================================
1188 #
1189 #  Specifies:
1190 #
1191 #      Through which SOCKS proxy (and optionally to which parent HTTP
1192 #      proxy) specific requests should be routed.
1193 #
1194 #  Type of value:
1195 #
1196 #      target_pattern socks_proxy[:port] http_parent[:port]
1197 #
1198 #      where target_pattern is a URL pattern that specifies to which
1199 #      requests (i.e. URLs) this forward rule shall apply. Use / to
1200 #      denote "all URLs".  http_parent and socks_proxy are IP addresses
1201 #      in dotted decimal notation or valid DNS names (http_parent may
1202 #      be "." to denote "no HTTP forwarding"), and the optional port
1203 #      parameters are TCP ports, i.e. integer values from 1 to 65535
1204 #
1205 #  Default value:
1206 #
1207 #      Unset
1208 #
1209 #  Effect if unset:
1210 #
1211 #      Don't use SOCKS proxies.
1212 #
1213 #  Notes:
1214 #
1215 #      Multiple lines are OK, they are checked in sequence, and the
1216 #      last match wins.
1217 #
1218 #      The difference between forward-socks4 and forward-socks4a
1219 #      is that in the SOCKS 4A protocol, the DNS resolution of the
1220 #      target hostname happens on the SOCKS server, while in SOCKS 4
1221 #      it happens locally.
1222 #
1223 #      With forward-socks5 the DNS resolution will happen on the remote
1224 #      server as well.
1225 #
1226 #      socks_proxy and http_parent can be a numerical IPv6 address
1227 #      (if RFC 3493 is implemented). To prevent clashes with the port
1228 #      delimiter, the whole IP address has to be put into brackets. On
1229 #      the other hand a target_pattern containing an IPv6 address has
1230 #      to be put into angle brackets (normal brackets are reserved
1231 #      for regular expressions already).
1232 #
1233 #      If http_parent is ".", then requests are not forwarded to another
1234 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
1235 #      albeit through a SOCKS proxy.
1236 #
1237 #  Examples:
1238 #
1239 #      From the company example.com, direct connections are made to all
1240 #      "internal" domains, but everything outbound goes through their
1241 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
1242 #      to the Internet.
1243 #
1244 #        forward-socks4a   /       socks-gw.example.com:1080    www-cache.isp.example.net:8080 
1245 #        forward           .example.com        .
1246 #
1247 #
1248 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1249 #      HTTP parent looks like this:
1250 #
1251 #        forward-socks4   /               socks-gw.example.com:1080  .
1252 #
1253 #
1254 #      To chain Privoxy and Tor, both running on the same system,
1255 #      you would use something like:
1256 #
1257 #        forward-socks5   /               127.0.0.1:9050 .
1258 #
1259 #
1260 #      The public Tor network can't be used to reach your local network,
1261 #      if you need to access local servers you therefore might want
1262 #      to make some exceptions:
1263 #
1264 #        forward         192.168.*.*/     .  
1265 #        forward         10.*.*.*/        .  
1266 #        forward         127.*.*.*/       .
1267 #
1268 #
1269 #      Unencrypted connections to systems in these address ranges will
1270 #      be as (un) secure as the local network is, but the alternative
1271 #      is that you can't reach the local network through Privoxy at
1272 #      all. Of course this may actually be desired and there is no
1273 #      reason to make these exceptions if you aren't sure you need them.
1274 #
1275 #      If you also want to be able to reach servers in your local
1276 #      network by using their names, you will need additional exceptions
1277 #      that look like this:
1278 #
1279 #       forward           localhost/     .
1280 #
1281 #
1282 #
1283 #
1284 #  5.3. forwarded-connect-retries
1285 #  ===============================
1286 #
1287 #  Specifies:
1288 #
1289 #      How often Privoxy retries if a forwarded connection request
1290 #      fails.
1291 #
1292 #  Type of value:
1293 #
1294 #      Number of retries.
1295 #
1296 #  Default value:
1297 #
1298 #      0
1299 #
1300 #  Effect if unset:
1301 #
1302 #      Connections forwarded through other proxies are treated like
1303 #      direct connections and no retry attempts are made.
1304 #
1305 #  Notes:
1306 #
1307 #      forwarded-connect-retries is mainly interesting for socks4a
1308 #      connections, where Privoxy can't detect why the connections
1309 #      failed. The connection might have failed because of a DNS timeout
1310 #      in which case a retry makes sense, but it might also have failed
1311 #      because the server doesn't exist or isn't reachable. In this
1312 #      case the retry will just delay the appearance of Privoxy's
1313 #      error message.
1314 #
1315 #      Note that in the context of this option, "forwarded connections"
1316 #      includes all connections that Privoxy forwards through other
1317 #      proxies. This option is not limited to the HTTP CONNECT method.
1318 #
1319 #      Only use this option, if you are getting lots of
1320 #      forwarding-related error messages that go away when you try again
1321 #      manually. Start with a small value and check Privoxy's logfile
1322 #      from time to time, to see how many retries are usually needed.
1323 #
1324 #  Examples:
1325 #
1326 #      forwarded-connect-retries 1
1327 #
1328 forwarded-connect-retries  0
1329 #
1330 #
1331 #  6. MISCELLANEOUS
1332 #  =================
1333 #
1334 #  6.1. accept-intercepted-requests
1335 #  =================================
1336 #
1337 #  Specifies:
1338 #
1339 #      Whether intercepted requests should be treated as valid.
1340 #
1341 #  Type of value:
1342 #
1343 #      0 or 1
1344 #
1345 #  Default value:
1346 #
1347 #      0
1348 #
1349 #  Effect if unset:
1350 #
1351 #      Only proxy requests are accepted, intercepted requests are
1352 #      treated as invalid.
1353 #
1354 #  Notes:
1355 #
1356 #      If you don't trust your clients and want to force them to use
1357 #      Privoxy, enable this option and configure your packet filter
1358 #      to redirect outgoing HTTP connections into Privoxy.
1359 #
1360 #      Make sure that Privoxy's own requests aren't redirected as well.
1361 #      Additionally take care that Privoxy can't intentionally connect
1362 #      to itself, otherwise you could run into redirection loops if
1363 #      Privoxy's listening port is reachable by the outside or an
1364 #      attacker has access to the pages you visit.
1365 #
1366 #  Examples:
1367 #
1368 #      accept-intercepted-requests 1
1369 #
1370 accept-intercepted-requests 0
1371 #
1372 #
1373 #  6.2. allow-cgi-request-crunching
1374 #  =================================
1375 #
1376 #  Specifies:
1377 #
1378 #      Whether requests to Privoxy's CGI pages can be blocked or
1379 #      redirected.
1380 #
1381 #  Type of value:
1382 #
1383 #      0 or 1
1384 #
1385 #  Default value:
1386 #
1387 #      0
1388 #
1389 #  Effect if unset:
1390 #
1391 #      Privoxy ignores block and redirect actions for its CGI pages.
1392 #
1393 #  Notes:
1394 #
1395 #      By default Privoxy ignores block or redirect actions for
1396 #      its CGI pages.  Intercepting these requests can be useful in
1397 #      multi-user setups to implement fine-grained access control,
1398 #      but it can also render the complete web interface useless and
1399 #      make debugging problems painful if done without care.
1400 #
1401 #      Don't enable this option unless you're sure that you really
1402 #      need it.
1403 #
1404 #  Examples:
1405 #
1406 #      allow-cgi-request-crunching 1
1407 #
1408 allow-cgi-request-crunching 0
1409 #
1410 #
1411 #  6.3. split-large-forms
1412 #  =======================
1413 #
1414 #  Specifies:
1415 #
1416 #      Whether the CGI interface should stay compatible with broken
1417 #      HTTP clients.
1418 #
1419 #  Type of value:
1420 #
1421 #      0 or 1
1422 #
1423 #  Default value:
1424 #
1425 #      0
1426 #
1427 #  Effect if unset:
1428 #
1429 #      The CGI form generate long GET URLs.
1430 #
1431 #  Notes:
1432 #
1433 #      Privoxy's CGI forms can lead to rather long URLs. This isn't
1434 #      a problem as far as the HTTP standard is concerned, but it can
1435 #      confuse clients with arbitrary URL length limitations.
1436 #
1437 #      Enabling split-large-forms causes Privoxy to divide big forms
1438 #      into smaller ones to keep the URL length down. It makes editing
1439 #      a lot less convenient and you can no longer submit all changes
1440 #      at once, but at least it works around this browser bug.
1441 #
1442 #      If you don't notice any editing problems, there is no reason
1443 #      to enable this option, but if one of the submit buttons appears
1444 #      to be broken, you should give it a try.
1445 #
1446 #  Examples:
1447 #
1448 #      split-large-forms 1
1449 #
1450 split-large-forms 0
1451 #
1452 #
1453 #  6.4. keep-alive-timeout
1454 #  ========================
1455 #
1456 #  Specifies:
1457 #
1458 #      Number of seconds after which an open connection will no longer
1459 #      be reused.
1460 #
1461 #  Type of value:
1462 #
1463 #      Time in seconds.
1464 #
1465 #  Default value:
1466 #
1467 #      None
1468 #
1469 #  Effect if unset:
1470 #
1471 #      Connections are not kept alive.
1472 #
1473 #  Notes:
1474 #
1475 #      This option allows clients to keep the connection to Privoxy
1476 #      alive. If the server supports it, Privoxy will keep the
1477 #      connection to the server alive as well. Under certain
1478 #      circumstances this may result in speed-ups.
1479 #
1480 #      By default, Privoxy will close the connection to the server if
1481 #      the client connection gets closed, or if the specified timeout
1482 #      has been reached without a new request coming in. This behaviour
1483 #      can be changed with the connection-sharing option.
1484 #
1485 #      This option has no effect if Privoxy has been compiled without
1486 #      keep-alive support.
1487 #
1488 #  Examples:
1489 #
1490 #      keep-alive-timeout 300
1491 #
1492 keep-alive-timeout 300
1493 #
1494 #
1495 #  6.5. connection-sharing
1496 #  ========================
1497 #
1498 #  Specifies:
1499 #
1500 #      Whether or not outgoing connections that have been kept alive
1501 #      should be shared between different incoming connections.
1502 #
1503 #  Type of value:
1504 #
1505 #      0 or 1
1506 #
1507 #  Default value:
1508 #
1509 #      None
1510 #
1511 #  Effect if unset:
1512 #
1513 #      Connections are not shared.
1514 #
1515 #  Notes:
1516 #
1517 #      This option has no effect if Privoxy has been compiled without
1518 #      keep-alive support, or if it's disabled.
1519 #
1520 #  Notes:
1521 #
1522 #      Note that reusing connections doesn't necessary cause
1523 #      speedups. There are also a few privacy implications you should
1524 #      be aware of.
1525 #
1526 #      If this option is effective, outgoing connections are shared
1527 #      between clients (if there are more than one) and closing the
1528 #      browser that initiated the outgoing connection does no longer
1529 #      affect the connection between Privoxy and the server unless
1530 #      the client's request hasn't been completed yet.
1531 #
1532 #      If the outgoing connection is idle, it will not be closed until
1533 #      either Privoxy's or the server's timeout is reached. While
1534 #      it's open, the server knows that the system running Privoxy is
1535 #      still there.
1536 #
1537 #      If there are more than one client (maybe even belonging to
1538 #      multiple users), they will be able to reuse each others
1539 #      connections. This is potentially dangerous in case of
1540 #      authentication schemes like NTLM where only the connection
1541 #      is authenticated, instead of requiring authentication for
1542 #      each request.
1543 #
1544 #      If there is only a single client, and if said client can keep
1545 #      connections alive on its own, enabling this option has next to
1546 #      no effect. If the client doesn't support connection keep-alive,
1547 #      enabling this option may make sense as it allows Privoxy to keep
1548 #      outgoing connections alive even if the client itself doesn't
1549 #      support it.
1550 #
1551 #      You should also be aware that enabling this option increases
1552 #      the likelihood of getting the "No server or forwarder data"
1553 #      error message, especially if you are using a slow connection
1554 #      to the Internet.
1555 #
1556 #      This option should only be used by experienced users who
1557 #      understand the risks and can weight them against the benefits.
1558 #
1559 #  Examples:
1560 #
1561 #      connection-sharing 1
1562 #
1563 #connection-sharing 1
1564 #
1565 #
1566 #  6.6. socket-timeout
1567 #  ====================
1568 #
1569 #  Specifies:
1570 #
1571 #      Number of seconds after which a socket times out if no data
1572 #      is received.
1573 #
1574 #  Type of value:
1575 #
1576 #      Time in seconds.
1577 #
1578 #  Default value:
1579 #
1580 #      None
1581 #
1582 #  Effect if unset:
1583 #
1584 #      A default value of 300 seconds is used.
1585 #
1586 #  Notes:
1587 #
1588 #      For SOCKS requests the timeout currently doesn't start until
1589 #      the SOCKS server accepted the request. This will be fixed in
1590 #      the next release.
1591 #
1592 #  Examples:
1593 #
1594 #      socket-timeout 300
1595 #
1596 socket-timeout 300
1597 #
1598 #
1599 #  6.7. max-client-connections
1600 #  ============================
1601 #
1602 #  Specifies:
1603 #
1604 #      Maximum number of client connections that will be served.
1605 #
1606 #  Type of value:
1607 #
1608 #      Positive number.
1609 #
1610 #  Default value:
1611 #
1612 #      None
1613 #
1614 #  Effect if unset:
1615 #
1616 #      Connections are served until a resource limit is reached.
1617 #
1618 #  Notes:
1619 #
1620 #      Privoxy creates one thread (or process) for every incoming
1621 #      client connection that isn't rejected based on the access
1622 #      control settings.
1623 #
1624 #      If the system is powerful enough, Privoxy can theoretically deal
1625 #      with several hundred (or thousand) connections at the same time,
1626 #      but some operating systems enforce resource limits by shutting
1627 #      down offending processes and their default limits may be below
1628 #      the ones Privoxy would require under heavy load.
1629 #
1630 #      Configuring Privoxy to enforce a connection limit below the
1631 #      thread or process limit used by the operating system makes
1632 #      sure this doesn't happen.  Simply increasing the operating
1633 #      system's limit would work too, but if Privoxy isn't the only
1634 #      application running on the system, you may actually want to
1635 #      limit the resources used by Privoxy.
1636 #
1637 #      If Privoxy is only used by a single trusted user, limiting the
1638 #      number of client connections is probably unnecessary. If there
1639 #      are multiple possibly untrusted users you probably still want
1640 #      to additionally use a packet filter to limit the maximal number
1641 #      of incoming connections per client. Otherwise a malicious user
1642 #      could intentionally create a high number of connections to
1643 #      prevent other users from using Privoxy.
1644 #
1645 #      Obviously using this option only makes sense if you choose a
1646 #      limit below the one enforced by the operating system.
1647 #
1648 #  Examples:
1649 #
1650 #      max-client-connections 256
1651 #
1652 #max-client-connections 256
1653 #
1654 #
1655 #  7. WINDOWS GUI OPTIONS
1656 #  =======================
1657 #
1658 #  Privoxy has a number of options specific to the Windows GUI
1659 #  interface:
1660 #
1661 #
1662 #  If "activity-animation" is set to 1, the Privoxy icon will animate
1663 #  when "Privoxy" is active. To turn off, set to 0.
1664 #
1665 #activity-animation   1
1666 #
1667 #  If "log-messages" is set to 1, Privoxy will log messages to the
1668 #  console window:
1669 #
1670 #log-messages   1
1671 #
1672 #  If "log-buffer-size" is set to 1, the size of the log buffer,
1673 #  i.e. the amount of memory used for the log messages displayed in
1674 #  the console window, will be limited to "log-max-lines" (see below).
1675 #
1676 #  Warning: Setting this to 0 will result in the buffer to grow
1677 #  infinitely and eat up all your memory!
1678 #
1679 #log-buffer-size 1
1680 #
1681 #  log-max-lines is the maximum number of lines held in the log
1682 #  buffer. See above.
1683 #
1684 #log-max-lines 200
1685 #
1686 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
1687 #  portions of the log messages with a bold-faced font:
1688 #
1689 #log-highlight-messages 1
1690 #
1691 #  The font used in the console window:
1692 #
1693 #log-font-name Comic Sans MS
1694 #
1695 #  Font size used in the console window:
1696 #
1697 #log-font-size 8
1698 #
1699 #  "show-on-task-bar" controls whether or not Privoxy will appear as
1700 #  a button on the Task bar when minimized:
1701 #
1702 #show-on-task-bar 0
1703 #
1704 #  If "close-button-minimizes" is set to 1, the Windows close button
1705 #  will minimize Privoxy instead of closing the program (close with
1706 #  the exit option on the File menu).
1707 #
1708 #close-button-minimizes 1
1709 #
1710 #  The "hide-console" option is specific to the MS-Win console version
1711 #  of Privoxy.  If this option is used, Privoxy will disconnect from
1712 #  and hide the command console.
1713 #
1714 #hide-console
1715 #
1716 #