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