Regenerate docs for upcoming 3.0.1 release.
[privoxy.git] / config
1 #        Sample Configuration File for Privoxy v3.0.1
2 #  
3 #  Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
4 #  
5 #  $Id: config,v 1.39.2.9 2003/02/20 13:34:08 hal9 Exp $
6 #  
7 ####################################################################
8 #                                                                  #
9 #                      Table of Contents                           #
10 #                                                                  #
11 #        I. INTRODUCTION                                           #
12 #       II. FORMAT OF THE CONFIGURATION FILE                       #
13 #                                                                  #
14 #        1. CONFIGURATION AND LOG FILE LOCATIONS                   #
15 #        2. LOCAL SET-UP DOCUMENTATION                             #
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 the Privoxy configuration. If you modify this file,
28 #  you will need to send a couple of requests to the proxy before any
29 #  changes take effect.
30 #  
31 #  When starting Privoxy on Unix systems, give the name of this file as
32 #  an argument. On Windows systems, Privoxy will look for this file
33 #  with the name 'config.txt' in the same directory where Privoxy
34 #  is installed.
35 #  
36 #  
37 #  II. FORMAT OF THE CONFIGURATION FILE
38 #  ====================================
39 #  
40 #  Configuration lines consist of an initial keyword followed by a
41 #  list of values, all separated by whitespace (any number of spaces
42 #  or tabs). For example,
43 #  
44 #  actionsfile default.action
45 #  
46 #  Indicates that the actionsfile is named 'default.action'.
47 #  
48 #  The '#' indicates a comment. Any part of a line following a '#'
49 #  is ignored, except if the '#' is preceded by a '\'.
50 #  
51 #  Thus, by placing a # at the start of an existing configuration line,
52 #  you can make it a comment and it will be treated as if it weren't
53 #  there. This is called "commenting out" an option and can be useful.
54 #  
55 #  Note that commenting out and option and leaving it at its default
56 #  are two completely different things! Most options behave very
57 #  differently when unset.  See the the "Effect if unset" explanation
58 #  in each option's description for details.
59 #  
60 #  Long lines can be continued on the next line by using a `\' as the
61 #  last character.
62 #  
63
64 #  
65 #  1. CONFIGURATION AND LOG FILE LOCATIONS
66 #  =======================================
67 #  
68 #  Privoxy can (and normally does) use a number of other files for
69 #  additional configuration, help and logging. This section of the
70 #  configuration file tells Privoxy where to find those other files.
71 #  
72 #  The user running Privoxy, must have read permission for all
73 #  configuration files, and write permission to any files that would
74 #  be modified, such as log files and actions files.
75 #  
76
77 #  
78 #  1.1. confdir
79 #  ============
80 #  
81 #  Specifies:
82 #  
83 #      The directory where the other configuration files are located
84 #  
85 #  Type of value:
86 #  
87 #      Path name
88 #  
89 #  Default value:
90 #  
91 #      /etc/privoxy (Unix) or Privoxy installation dir (Windows)
92 #  
93 #  Effect if unset:
94 #  
95 #      Mandatory
96 #  
97 #  Notes:
98 #  
99 #      No trailing "/", please
100 #  
101 #      When development goes modular and multi-user, the blocker,
102 #      filter, and per-user config will be stored in subdirectories of
103 #      "confdir". For now, the configuration directory structure is
104 #      flat, except for confdir/templates, where the HTML templates
105 #      for CGI output reside (e.g. Privoxy's 404 error page).
106 #  
107 confdir .
108
109 #  
110 #  1.2. logdir
111 #  ===========
112 #  
113 #  Specifies:
114 #  
115 #      The directory where all logging takes place (i.e. where logfile
116 #      and jarfile are located)
117 #  
118 #  Type of value:
119 #  
120 #      Path name
121 #  
122 #  Default value:
123 #  
124 #      /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
125 #  
126 #  Effect if unset:
127 #  
128 #      Mandatory
129 #  
130 #  Notes:
131 #  
132 #      No trailing "/", please
133 #  
134 logdir .
135
136 #  
137 #  1.3. actionsfile
138 #  ================
139 #  
140 #  Specifies:
141 #  
142 #      The actions file(s) to use
143 #  
144 #  Type of value:
145 #  
146 #      File name, relative to confdir, without the .action suffix
147 #  
148 #  Default values:
149 #  
150 #        standard     # Internal purposes, no editing recommended
151 #  
152 #        default      # Main actions file
153 #  
154 #        user         # User customizations
155 #  
156 #  Effect if unset:
157 #  
158 #      No actions are taken at all. Simple neutral proxying.
159 #  
160 #  Notes:
161 #  
162 #      Multiple actionsfile lines are permitted, and are in fact
163 #      recommended!
164 #  
165 #      The default values include standard.action, which is used
166 #      for internal purposes and should be loaded, default.action,
167 #      which is the "main" actions file maintained by the developers,
168 #      and user.action, where you can make your personal additions.
169 #  
170 #      Actions files are where all the per site and per URL
171 #      configuration is done for ad blocking, cookie management,
172 #      privacy considerations, etc. There is no point in using Privoxy
173 #      without at least one actions file.
174 #  
175 actionsfile standard  # Internal purpose, recommended
176 actionsfile default   # Main actions file
177 actionsfile user      # User customizations
178
179 #  
180 #  1.4. filterfile
181 #  ===============
182 #  
183 #  Specifies:
184 #  
185 #      The filter file to use
186 #  
187 #  Type of value:
188 #  
189 #      File name, relative to confdir
190 #  
191 #  Default value:
192 #  
193 #      default.filter (Unix) or default.filter.txt (Windows)
194 #  
195 #  Effect if unset:
196 #  
197 #      No textual content filtering takes place, i.e. all +filter{name}
198 #      actions in the actions files are turned neutral.
199 #  
200 #  Notes:
201 #  
202 #      The filter file contains content modification rules that use
203 #      regular expressions. These rules permit powerful changes on the
204 #      content of Web pages, e.g., you could disable your favorite
205 #      JavaScript annoyances, re-write the actual displayed text,
206 #      or just have some fun replacing "Microsoft" with "MicroSuck"
207 #      wherever it appears on a Web page.
208 #  
209 #      The +filter{name} actions rely on the relevant filter (name)
210 #      to be defined in the filter file!
211 #  
212 #      A pre-defined filter file called default.filter that contains
213 #      a bunch of handy filters for common problems is included in the
214 #      distribution. See the section on the filter action for a list.
215 #  
216 filterfile default.filter
217
218 #  
219 #  1.5. logfile
220 #  ============
221 #  
222 #  Specifies:
223 #  
224 #      The log file to use
225 #  
226 #  Type of value:
227 #  
228 #      File name, relative to logdir
229 #  
230 #  Default value:
231 #  
232 #      logfile (Unix) or privoxy.log (Windows)
233 #  
234 #  Effect if unset:
235 #  
236 #      No log file is used, all log messages go to the console (STDERR).
237 #  
238 #  Notes:
239 #  
240 #      The logfile is where all logging and error messages are
241 #      written. The level of detail and number of messages are set with
242 #      the debug option (see below).  The logfile can be useful for
243 #      tracking down a problem with Privoxy (e.g., it's not blocking
244 #      an ad you think it should block) but in most cases you probably
245 #      will never look at it.
246 #  
247 #      Your logfile will grow indefinitely, and you will probably
248 #      want to periodically remove it. On Unix systems, you can do
249 #      this with a cron job (see "man cron"). For Red Hat, a logrotate
250 #      script has been included.
251 #  
252 #      On SuSE Linux systems, you can place a line like
253 #      "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
254 #      with the effect that cron.daily will automatically archive,
255 #      gzip, and empty the log, when it exceeds 1M size.
256 #  
257 #      Any log files must be writable by whatever user Privoxy is
258 #      being run as (default on UNIX, user id is "privoxy").
259 #  
260 logfile logfile
261
262 #  
263 #  1.6. jarfile
264 #  ============
265 #  
266 #  Specifies:
267 #  
268 #      The file to store intercepted cookies in
269 #  
270 #  Type of value:
271 #  
272 #      File name, relative to logdir
273 #  
274 #  Default value:
275 #  
276 #      jarfile (Unix) or privoxy.jar (Windows)
277 #  
278 #  Effect if unset:
279 #  
280 #      Intercepted cookies are not stored at all.
281 #  
282 #  Notes:
283 #  
284 #      The jarfile may grow to ridiculous sizes over time.
285 #  
286 jarfile jarfile
287
288 #  
289 #  1.7. trustfile
290 #  ==============
291 #  
292 #  Specifies:
293 #  
294 #      The trust file to use
295 #  
296 #  Type of value:
297 #  
298 #      File name, relative to confdir
299 #  
300 #  Default value:
301 #  
302 #      Unset (commented out). When activated: trust (Unix) or trust.txt
303 #      (Windows)
304 #  
305 #  Effect if unset:
306 #  
307 #      The entire trust mechanism is turned off.
308 #  
309 #  Notes:
310 #  
311 #      The trust mechanism is an experimental feature for building
312 #      white-lists and should be used with care. It is NOT recommended
313 #      for the casual user.
314 #  
315 #      If you specify a trust file, Privoxy will only allow access to
316 #      sites that are specified in the trustfile. Sites can be listed
317 #      in one of two ways:
318 #  
319 #      Prepending a ~ character limits access to this site only (and
320 #      any sub-paths within this site), e.g. ~www.example.com.
321 #  
322 #      Or, you can designate sites as trusted referrers, by prepending
323 #      the name with a + character. The effect is that access to
324 #      untrusted sites will be granted -- but only if a link from this
325 #      trusted referrer was used. The link target will then be added
326 #      to the "trustfile" so that future, direct accesses will be
327 #      granted. Sites added via this mechanism do not become trusted
328 #      referrers themselves (i.e. they are added with a ~ designation).
329 #  
330 #      If you use the + operator in the trust file, it may grow
331 #      considerably over time.
332 #  
333 #      It is recommended that Privoxy be compiled with the
334 #      --disable-force, --disable-toggle and --disable-editor options,
335 #      if this feature is to be used.
336 #  
337 #      Possible applications include limiting Internet access for
338 #      children.
339 #  
340 #trustfile trust
341
342 #  
343 #  2. LOCAL SET-UP DOCUMENTATION
344 #  =============================
345 #  
346 #  If you intend to operate Privoxy for more users than just yourself,
347 #  it might be a good idea to let them know how to reach you, what
348 #  you block and why you do that, your policies, etc.
349 #  
350
351 #  
352 #  2.1. user-manual
353 #  ================
354 #  
355 #  Specifies:
356 #  
357 #      Location of the Privoxy User Manual.
358 #  
359 #  Type of value:
360 #  
361 #      A fully qualified URI
362 #  
363 #  Default value:
364 #  
365 #      Unset
366 #  
367 #  Effect if unset:
368 #  
369 #      http://www.privoxy.org/version/user-manual/ will be used,
370 #      where version is the Privoxy version.
371 #  
372 #  Notes:
373 #  
374 #      The User Manual URI is used for help links from some of the
375 #      internal CGI pages. The manual itself is normally packaged
376 #      with the binary distributions, so you probably want to set this
377 #      to a locally installed copy. For multi-user setups, you could
378 #      provide a copy on a local webserver for all your users and use
379 #      the corresponding URL here.
380 #  
381 #      Examples:
382 #  
383 #      Unix, in local filesystem:
384 #  
385 #       user-manual file:///usr/share/doc/privoxy-3.0.1/user-manual/index.html
386 #  
387 #      Windows, in local filesystem, must use forward slash notation,
388 #      and %20 to denote spaces in path names:
389 #  
390 #       user-manual file:///c:/some%20dir/privoxy/user-manual/index.html
391 #  
392 #      Windows, UNC notation (forward slashes required again):
393 #  
394 #       user-manual file://///some-server/some-path/privoxy/user-manual/index.html
395 #  
396 #      Any platform, on local webserver (called "local-webserver"):
397 #  
398 #       user-manual  http://local-webserver/privoxy-user-manual/
399 #  
400 #      WARNING!!!
401 #  
402 #          If set, this option should be the first option in the config
403 #          file, because it is used while the config file is being read.
404 #  
405 #user-manual http://www.privoxy.org/user-manual/
406
407 #  
408 #  2.2. trust-info-url
409 #  ===================
410 #  
411 #  Specifies:
412 #  
413 #      A URL to be displayed in the error page that users will see if
414 #      access to an untrusted page is denied.
415 #  
416 #  Type of value:
417 #  
418 #      URL
419 #  
420 #  Default value:
421 #  
422 #      Two example URL are provided
423 #  
424 #  Effect if unset:
425 #  
426 #      No links are displayed on the "untrusted" error page.
427 #  
428 #  Notes:
429 #  
430 #      The value of this option only matters if the experimental trust
431 #      mechanism has been activated. (See trustfile above.)
432 #  
433 #      If you use the trust mechanism, it is a good idea to write
434 #      up some on-line documentation about your trust policy and to
435 #      specify the URL(s) here. Use multiple times for multiple URLs.
436 #  
437 #      The URL(s) should be added to the trustfile as well, so users
438 #      don't end up locked out from the information on why they were
439 #      locked out in the first place!
440 #  
441 trust-info-url  http://www.example.com/why_we_block.html
442 trust-info-url  http://www.example.com/what_we_allow.html
443
444 #  
445 #  2.3. admin-address
446 #  ==================
447 #  
448 #  Specifies:
449 #  
450 #      An email address to reach the proxy administrator.
451 #  
452 #  Type of value:
453 #  
454 #      Email address
455 #  
456 #  Default value:
457 #  
458 #      Unset
459 #  
460 #  Effect if unset:
461 #  
462 #      No email address is displayed on error pages and the CGI user
463 #      interface.
464 #  
465 #  Notes:
466 #  
467 #      If both admin-address and proxy-info-url are unset, the whole
468 #      "Local Privoxy Support" box on all generated pages will not
469 #      be shown.
470 #  
471 #admin-address privoxy-admin@example.com
472
473 #  
474 #  2.4. proxy-info-url
475 #  ===================
476 #  
477 #  Specifies:
478 #  
479 #      A URL to documentation about the local Privoxy setup,
480 #      configuration or policies.
481 #  
482 #  Type of value:
483 #  
484 #      URL
485 #  
486 #  Default value:
487 #  
488 #      Unset
489 #  
490 #  Effect if unset:
491 #  
492 #      No link to local documentation is displayed on error pages and
493 #      the CGI user interface.
494 #  
495 #  Notes:
496 #  
497 #      If both admin-address and proxy-info-url are unset, the whole
498 #      "Local Privoxy Support" box on all generated pages will not
499 #      be shown.
500 #  
501 #      This URL shouldn't be blocked ;-)
502 #  
503 #proxy-info-url http://www.example.com/proxy-service.html
504
505 #  
506 #  3. DEBUGGING
507 #  ============
508 #  
509 #  These options are mainly useful when tracing a problem. Note that
510 #  you might also want to invoke Privoxy with the --no-daemon command
511 #  line option when debugging.
512 #  
513
514 #  
515 #  3.1. debug
516 #  ==========
517 #  
518 #  Specifies:
519 #  
520 #      Key values that determine what information gets logged to
521 #      the logfile.
522 #  
523 #  Type of value:
524 #  
525 #      Integer values
526 #  
527 #  Default value:
528 #  
529 #      12289 (i.e.: URLs plus informational and warning messages)
530 #  
531 #  Effect if unset:
532 #  
533 #      Nothing gets logged.
534 #  
535 #  Notes:
536 #  
537 #      The available debug levels are:
538 #  
539 #          debug         1 # show each GET/POST/CONNECT request 
540 #          debug         2 # show each connection status 
541 #          debug         4 # show I/O status 
542 #          debug         8 # show header parsing 
543 #          debug        16 # log all data into the logfile 
544 #          debug        32 # debug force feature 
545 #          debug        64 # debug regular expression filter
546 #          debug       128 # debug fast redirects 
547 #          debug       256 # debug GIF de-animation 
548 #          debug       512 # Common Log Format
549 #          debug      1024 # debug kill pop-ups 
550 #          debug      2048 # CGI user interface 
551 #          debug      4096 # Startup banner and warnings.
552 #          debug      8192 # Non-fatal errors
553 #  
554 #      To select multiple debug levels, you can either add them or
555 #      use multiple debug lines.
556 #  
557 #      A debug level of 1 is informative because it will show you each
558 #      request as it happens. 1, 4096 and 8192 are highly recommended
559 #      so that you will notice when things go wrong. The other levels
560 #      are probably only of interest if you are hunting down a specific
561 #      problem. They can produce a hell of an output (especially 16).
562 #  
563 #      The reporting of fatal errors (i.e. ones which crash Privoxy)
564 #      is always on and cannot be disabled.
565 #  
566 #      If you want to use CLF (Common Log Format), you should set
567 #      "debug 512" ONLY and not enable anything else.
568 #  
569 debug   1    # show each GET/POST/CONNECT request
570 debug   4096 # Startup banner and warnings
571 debug   8192 # Errors - *we highly recommended enabling this*
572
573 #  
574 #  3.2. single-threaded
575 #  ====================
576 #  
577 #  Specifies:
578 #  
579 #      Whether to run only one server thread
580 #  
581 #  Type of value:
582 #  
583 #      None
584 #  
585 #  Default value:
586 #  
587 #      Unset
588 #  
589 #  Effect if unset:
590 #  
591 #      Multi-threaded (or, where unavailable: forked) operation,
592 #      i.e. the ability to serve multiple requests simultaneously.
593 #  
594 #  Notes:
595 #  
596 #      This option is only there for debug purposes and you should
597 #      never need to use it. It will drastically reduce performance.
598 #  
599 #single-threaded
600
601 #  
602 #  4. ACCESS CONTROL AND SECURITY
603 #  ==============================
604 #  
605 #  This section of the config file controls the security-relevant
606 #  aspects of Privoxy's configuration.
607 #  
608
609 #  
610 #  4.1. listen-address
611 #  ===================
612 #  
613 #  Specifies:
614 #  
615 #      The IP address and TCP port on which Privoxy will listen for
616 #      client requests.
617 #  
618 #  Type of value:
619 #  
620 #      [IP-Address]:Port
621 #  
622 #  Default value:
623 #  
624 #      127.0.0.1:8118
625 #  
626 #  Effect if unset:
627 #  
628 #      Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
629 #      recommended for home users who run Privoxy on the same machine
630 #      as their browser.
631 #  
632 #  Notes:
633 #  
634 #      You will need to configure your browser(s) to this proxy address
635 #      and port.
636 #  
637 #      If you already have another service running on port 8118, or
638 #      if you want to serve requests from other machines (e.g. on your
639 #      local network) as well, you will need to override the default.
640 #  
641 #      If you leave out the IP address, Privoxy will bind to all
642 #      interfaces (addresses) on your machine and may become reachable
643 #      from the Internet. In that case, consider using access control
644 #      lists (ACL's, see below), and/or a firewall.
645 #  
646 #      If you open Privoxy to untrusted users, you will also want
647 #      to turn off the enable-edit-actions and enable-remote-toggle
648 #      options!
649 #  
650 #  Example:
651 #  
652 #      Suppose you are running Privoxy on a machine which has the
653 #      address 192.168.0.1 on your local private network (192.168.0.0)
654 #      and has another outside connection with a different address. You
655 #      want it to serve requests from inside only:
656 #  
657 #        listen-address  192.168.0.1:8118
658 #  
659 listen-address  127.0.0.1:8118
660
661 #  
662 #  4.2. toggle
663 #  ===========
664 #  
665 #  Specifies:
666 #  
667 #      Initial state of "toggle" status
668 #  
669 #  Type of value:
670 #  
671 #      1 or 0
672 #  
673 #  Default value:
674 #  
675 #      1
676 #  
677 #  Effect if unset:
678 #  
679 #      Act as if toggled on
680 #  
681 #  Notes:
682 #  
683 #      If set to 0, Privoxy will start in "toggled off" mode,
684 #      i.e. behave like a normal, content-neutral proxy where all ad
685 #      blocking, filtering, etc are disabled. See enable-remote-toggle
686 #      below. This is not really useful anymore, since toggling is
687 #      much easier via the web interface than via editing the conf file.
688 #  
689 #      The windows version will only display the toggle icon in the
690 #      system tray if this option is present.
691 #  
692 toggle  1
693
694 #  
695 #  4.3. enable-remote-toggle
696 #  =========================
697 #  
698 #  Specifies:
699 #  
700 #      Whether or not the web-based toggle feature may be used
701 #  
702 #  Type of value:
703 #  
704 #      0 or 1
705 #  
706 #  Default value:
707 #  
708 #      1
709 #  
710 #  Effect if unset:
711 #  
712 #      The web-based toggle feature is disabled.
713 #  
714 #  Notes:
715 #  
716 #      When toggled off, Privoxy acts like a normal, content-neutral
717 #      proxy, i.e.  it acts as if none of the actions applied to
718 #      any URL.
719 #  
720 #      For the time being, access to the toggle feature can not be
721 #      controlled separately by "ACLs" or HTTP authentication, so that
722 #      everybody who can access Privoxy (see "ACLs" and listen-address
723 #      above) can toggle it for all users. So this option is not
724 #      recommended for multi-user environments with untrusted users.
725 #  
726 #      Note that you must have compiled Privoxy with support for this
727 #      feature, otherwise this option has no effect.
728 #  
729 enable-remote-toggle  1
730
731 #  
732 #  4.4. enable-edit-actions
733 #  ========================
734 #  
735 #  Specifies:
736 #  
737 #      Whether or not the web-based actions file editor may be used
738 #  
739 #  Type of value:
740 #  
741 #      0 or 1
742 #  
743 #  Default value:
744 #  
745 #      1
746 #  
747 #  Effect if unset:
748 #  
749 #      The web-based actions file editor is disabled.
750 #  
751 #  Notes:
752 #  
753 #      For the time being, access to the editor can not be controlled
754 #      separately by "ACLs" or HTTP authentication, so that everybody
755 #      who can access Privoxy (see "ACLs" and listen-address above)
756 #      can modify its configuration for all users. So this option is
757 #      not recommended for multi-user environments with untrusted users.
758 #  
759 #      Note that you must have compiled Privoxy with support for this
760 #      feature, otherwise this option has no effect.
761 #  
762 enable-edit-actions 1
763
764 #  
765 #  4.5. ACLs: permit-access and deny-access
766 #  ========================================
767 #  
768 #  Specifies:
769 #  
770 #      Who can access what.
771 #  
772 #  Type of value:
773 #  
774 #      src_addr[/src_masklen] [dst_addr[/dst_masklen]]
775 #  
776 #      Where src_addr and dst_addr are IP addresses in dotted decimal
777 #      notation or valid DNS names, and src_masklen and dst_masklen are
778 #      subnet masks in CIDR notation, i.e. integer values from 2 to 30
779 #      representing the length (in bits) of the network address. The
780 #      masks and the whole destination part are optional.
781 #  
782 #  Default value:
783 #  
784 #      Unset
785 #  
786 #  Effect if unset:
787 #  
788 #      Don't restrict access further than implied by listen-address
789 #  
790 #  Notes:
791 #  
792 #      Access controls are included at the request of ISPs and systems
793 #      administrators, and are not usually needed by individual
794 #      users. For a typical home user, it will normally suffice to
795 #      ensure that Privoxy only listens on the localhost (127.0.0.1)
796 #      or internal (home) network address by means of the listen-address
797 #      option.
798 #  
799 #      Please see the warnings in the FAQ that this proxy is not
800 #      intended to be a substitute for a firewall or to encourage
801 #      anyone to defer addressing basic security weaknesses.
802 #  
803 #      Multiple ACL lines are OK. If any ACLs are specified, then
804 #      the Privoxy talks only to IP addresses that match at least one
805 #      permit-access line and don't match any subsequent deny-access
806 #      line. In other words, the last match wins, with the default
807 #      being deny-access.
808 #  
809 #      If Privoxy is using a forwarder (see forward below) for a
810 #      particular destination URL, the dst_addr that is examined is
811 #      the address of the forwarder and NOT the address of the ultimate
812 #      target. This is necessary because it may be impossible for the
813 #      local Privoxy to determine the IP address of the ultimate target
814 #      (that's often what gateways are used for).
815 #  
816 #      You should prefer using IP addresses over DNS names, because
817 #      the address lookups take time. All DNS names must resolve! You
818 #      can not use domain patterns like "*.org" or partial domain
819 #      names. If a DNS name resolves to multiple IP addresses, only
820 #      the first one is used.
821 #  
822 #      Denying access to particular sites by ACL may have undesired
823 #      side effects if the site in question is hosted on a machine
824 #      which also hosts other sites.
825 #  
826 #  Examples:
827 #  
828 #      Explicitly define the default behavior if no ACL and
829 #      listen-address are set: "localhost" is OK. The absence of a
830 #      dst_addr implies that all destination addresses are OK:
831 #  
832 #        permit-access  localhost
833 #  
834 #      Allow any host on the same class C subnet as www.privoxy.org
835 #      access to nothing but www.example.com:
836 #  
837 #        permit-access  www.privoxy.org/24 www.example.com/32
838 #  
839 #      Allow access from any host on the 26-bit subnet 192.168.45.64
840 #      to anywhere, with the exception that 192.168.45.73 may not
841 #      access www.dirty-stuff.example.com:
842 #  
843 #        permit-access  192.168.45.64/26 
844 #        deny-access    192.168.45.73     www.dirty-stuff.example.com
845 #  
846
847 #  
848 #  4.6. buffer-limit
849 #  =================
850 #  
851 #  Specifies:
852 #  
853 #      Maximum size of the buffer for content filtering.
854 #  
855 #  Type of value:
856 #  
857 #      Size in Kbytes
858 #  
859 #  Default value:
860 #  
861 #      4096
862 #  
863 #  Effect if unset:
864 #  
865 #      Use a 4MB (4096 KB) limit.
866 #  
867 #  Notes:
868 #  
869 #      For content filtering, i.e. the +filter and +deanimate-gif
870 #      actions, it is necessary that Privoxy buffers the entire document
871 #      body. This can be potentially dangerous, since a server could
872 #      just keep sending data indefinitely and wait for your RAM to
873 #      exhaust -- with nasty consequences.  Hence this option.
874 #  
875 #      When a document buffer size reaches the buffer-limit, it is
876 #      flushed to the client unfiltered and no further attempt to filter
877 #      the rest of the document is made. Remember that there may be
878 #      multiple threads running, which might require up to buffer-limit
879 #      Kbytes each, unless you have enabled "single-threaded" above.
880 #  
881 buffer-limit 4096
882
883 #  
884 #  5. FORWARDING
885 #  =============
886 #  
887 #  This feature allows routing of HTTP requests through a chain
888 #  of multiple proxies. It can be used to better protect privacy
889 #  and confidentiality when accessing specific domains by routing
890 #  requests to those domains through an anonymous public proxy (see
891 #  e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching
892 #  proxy to speed up browsing. Or chaining to a parent proxy may be
893 #  necessary because the machine that Privoxy runs on has no direct
894 #  Internet access.
895 #  
896 #  Also specified here are SOCKS proxies. Privoxy supports the SOCKS
897 #  4 and SOCKS 4A protocols.
898 #  
899
900 #  
901 #  5.1. forward
902 #  ============
903 #  
904 #  Specifies:
905 #  
906 #      To which parent HTTP proxy specific requests should be routed.
907 #  
908 #  Type of value:
909 #  
910 #      target_pattern http_parent[:port]
911 #  
912 #      where target_pattern is a URL pattern that specifies to which
913 #      requests (i.e. URLs) this forward rule shall apply. Use /
914 #      to denote "all URLs".  http_parent[:port] is the DNS name or
915 #      IP address of the parent HTTP proxy through which the requests
916 #      should be forwarded, optionally followed by its listening port
917 #      (default: 8080). Use a single dot (.) to denote "no forwarding".
918 #  
919 #  Default value:
920 #  
921 #      Unset
922 #  
923 #  Effect if unset:
924 #  
925 #      Don't use parent HTTP proxies.
926 #  
927 #  Notes:
928 #  
929 #      If http_parent is ".", then requests are not forwarded to
930 #      another HTTP proxy but are made directly to the web servers.
931 #  
932 #      Multiple lines are OK, they are checked in sequence, and the
933 #      last match wins.
934 #  
935 #  Examples:
936 #  
937 #      Everything goes to an example anonymizing proxy, except SSL on
938 #      port 443 (which it doesn't handle):
939 #  
940 #        forward   /      anon-proxy.example.org:8080 
941 #        forward   :443   .
942 #  
943 #      Everything goes to our example ISP's caching proxy, except for
944 #      requests to that ISP's sites:
945 #  
946 #        forward   /                  caching-proxy.example-isp.net:8000
947 #        forward   .example-isp.net   .
948 #  
949
950 #  
951 #  5.2. forward-socks4 and forward-socks4a
952 #  =======================================
953 #  
954 #  Specifies:
955 #  
956 #      Through which SOCKS proxy (and to which parent HTTP proxy)
957 #      specific requests should be routed.
958 #  
959 #  Type of value:
960 #  
961 #      target_pattern socks_proxy[:port] http_parent[:port]
962 #  
963 #      where target_pattern is a URL pattern that specifies to which
964 #      requests (i.e. URLs) this forward rule shall apply. Use / to
965 #      denote "all URLs".  http_parent and socks_proxy are IP addresses
966 #      in dotted decimal notation or valid DNS names (http_parent may
967 #      be "." to denote "no HTTP forwarding"), and the optional port
968 #      parameters are TCP ports, i.e. integer values from 1 to 64535
969 #  
970 #  Default value:
971 #  
972 #      Unset
973 #  
974 #  Effect if unset:
975 #  
976 #      Don't use SOCKS proxies.
977 #  
978 #  Notes:
979 #  
980 #      Multiple lines are OK, they are checked in sequence, and the
981 #      last match wins.
982 #  
983 #      The difference between forward-socks4 and forward-socks4a
984 #      is that in the SOCKS 4A protocol, the DNS resolution of the
985 #      target hostname happens on the SOCKS server, while in SOCKS 4
986 #      it happens locally.
987 #  
988 #      If http_parent is ".", then requests are not forwarded to another
989 #      HTTP proxy but are made (HTTP-wise) directly to the web servers,
990 #      albeit through a SOCKS proxy.
991 #  
992 #  Examples:
993 #  
994 #      From the company example.com, direct connections are made to all
995 #      "internal" domains, but everything outbound goes through their
996 #      ISP's proxy by way of example.com's corporate SOCKS 4A gateway
997 #      to the Internet.
998 #  
999 #        forward-socks4a   /              socks-gw.example.com:1080   www-cache.example-isp.net:8080 
1000 #        forward           .example.com   .
1001 #  
1002 #      A rule that uses a SOCKS 4 gateway for all destinations but no
1003 #      HTTP parent looks like this:
1004 #  
1005 #        forward-socks4   /               socks-gw.example.com:1080  .
1006 #  
1007
1008 #  
1009 #  6. WINDOWS GUI OPTIONS
1010 #  ======================
1011 #  
1012 #  Privoxy has a number of options specific to the Windows GUI
1013 #  interface:
1014 #  
1015
1016 #  If "activity-animation" is set to 1, the Privoxy icon will animate
1017 #  when "Privoxy" is active. To turn off, set to 0.
1018 #  
1019 #activity-animation   1
1020
1021 #  If "log-messages" is set to 1, Privoxy will log messages to the
1022 #  console window:
1023 #  
1024 #log-messages   1
1025
1026 #  If "log-buffer-size" is set to 1, the size of the log buffer,
1027 #  i.e. the amount of memory used for the log messages displayed in
1028 #  the console window, will be limited to "log-max-lines" (see below).
1029 #  
1030 #  Warning: Setting this to 0 will result in the buffer to grow
1031 #  infinitely and eat up all your memory!
1032 #  
1033 #log-buffer-size 1
1034
1035 #  log-max-lines is the maximum number of lines held in the log
1036 #  buffer. See above.
1037 #  
1038 #log-max-lines 200
1039
1040 #  If "log-highlight-messages" is set to 1, Privoxy will highlight
1041 #  portions of the log messages with a bold-faced font:
1042 #  
1043 #log-highlight-messages 1
1044
1045 #  The font used in the console window:
1046 #  
1047 #log-font-name Comic Sans MS
1048
1049 #  Font size used in the console window:
1050 #  
1051 #log-font-size 8
1052
1053 #  "show-on-task-bar" controls whether or not Privoxy will appear as
1054 #  a button on the Task bar when minimized:
1055 #  
1056 #show-on-task-bar 0
1057
1058 #  If "close-button-minimizes" is set to 1, the Windows close button
1059 #  will minimize Privoxy instead of closing the program (close with
1060 #  the exit option on the File menu).
1061 #  
1062 #close-button-minimizes 1
1063
1064 #  The "hide-console" option is specific to the MS-Win console version
1065 #  of Privoxy.  If this option is used, Privoxy will disconnect from
1066 #  and hide the command console.
1067 #  
1068 #hide-console
1069
1070 #