1 # Sample Configuration File for Privoxy v3.0.17
3 # $Id: p-config.sgml,v 2.65 2010/10/30 16:09:31 fabiankeil Exp $
5 # Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
7 ####################################################################
12 # II. FORMAT OF THE CONFIGURATION FILE #
14 # 1. LOCAL SET-UP DOCUMENTATION #
15 # 2. CONFIGURATION AND LOG FILE LOCATIONS #
17 # 4. ACCESS CONTROL AND SECURITY #
19 # 6. WINDOWS GUI OPTIONS #
21 ####################################################################
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.
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.
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.
43 # II. FORMAT OF THE CONFIGURATION FILE
44 # ====================================
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,
50 # actionsfile default.action
52 # Indicates that the actionsfile is named 'default.action'.
54 # The '#' indicates a comment. Any part of a line following a '#'
55 # is ignored, except if the '#' is preceded by a '\'.
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".
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.
67 # Long lines can be continued on the next line by using a `\' as the
72 # 1. LOCAL SET-UP DOCUMENTATION
73 # ==============================
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.
86 # Location of the Privoxy User Manual.
90 # A fully qualified URI
98 # http://www.privoxy.org/version/user-manual/ will be used,
99 # where version is the Privoxy version.
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.
111 # The best all purpose solution is simply to put the full local
112 # PATH to where the User Manual is located:
114 # user-manual /usr/share/doc/privoxy/user-manual
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/).
122 # If the documentation is not on the local system, it can be
123 # accessed from a remote server, as:
125 # user-manual http://example.com/privoxy/user-manual/
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.
133 #user-manual http://www.privoxy.org/user-manual/
136 # 1.2. trust-info-url
137 # ====================
141 # A URL to be displayed in the error page that users will see if
142 # access to an untrusted page is denied.
154 # No links are displayed on the "untrusted" error page.
158 # The value of this option only matters if the experimental trust
159 # mechanism has been activated. (See trustfile below.)
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.
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!
169 #trust-info-url http://www.example.com/why_we_block.html
170 #trust-info-url http://www.example.com/what_we_allow.html
174 # ===================
178 # An email address to reach the Privoxy administrator.
190 # No email address is displayed on error pages and the CGI user
195 # If both admin-address and proxy-info-url are unset, the whole
196 # "Local Privoxy Support" box on all generated pages will not
199 #admin-address privoxy-admin@example.com
202 # 1.4. proxy-info-url
203 # ====================
207 # A URL to documentation about the local Privoxy setup,
208 # configuration or policies.
220 # No link to local documentation is displayed on error pages and
221 # the CGI user interface.
225 # If both admin-address and proxy-info-url are unset, the whole
226 # "Local Privoxy Support" box on all generated pages will not
229 # This URL shouldn't be blocked ;-)
231 #proxy-info-url http://www.example.com/proxy-service.html
234 # 2. CONFIGURATION AND LOG FILE LOCATIONS
235 # ========================================
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.
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.
252 # The directory where the other configuration files are located.
260 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
268 # No trailing "/", please.
278 # An alternative directory where the templates are loaded from.
290 # The templates are assumed to be located in confdir/template.
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.
308 # The directory where all logging takes place (i.e. where the
309 # logfile is located).
317 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
325 # No trailing "/", please.
335 # The actions file(s) to use
339 # Complete file name, relative to confdir
343 # match-all.action # Actions that are applied to all sites and maybe overruled later on.
345 # default.action # Main actions file
347 # user.action # User customizations
351 # No actions are taken at all. More or less neutral proxying.
355 # Multiple actionsfile lines are permitted, and are in fact
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.
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
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.
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
382 # The filter file(s) to use
386 # File name, relative to confdir
390 # default.filter (Unix) or default.filter.txt (Windows)
394 # No textual content filtering takes place, i.e. all +filter{name}
395 # actions in the actions files are turned neutral.
399 # Multiple filterfile lines are permitted.
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.
408 # The +filter{name} actions rely on the relevant filter (name)
409 # to be defined in a filter file!
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.
415 # It is recommended to place any locally adapted filters into a
416 # separate file, such as user.filter.
418 filterfile default.filter
419 filterfile user.filter # User customizations
427 # The log file to use
431 # File name, relative to logdir
435 # Unset (commented out). When activated: logfile (Unix) or
436 # privoxy.log (Windows).
440 # No logfile is written.
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.
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.
456 # For most troubleshooting purposes, you will have to change that,
457 # please refer to the debugging section for details.
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.
464 # Any log files must be writable by whatever user Privoxy is
465 # being run as (on Unix, default user id is "privoxy").
475 # The name of the trust file to use
479 # File name, relative to confdir
483 # Unset (commented out). When activated: trust (Unix) or trust.txt
488 # The entire trust mechanism is disabled.
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.
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:
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.
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.
514 # If you use the + operator in the trust file, it may grow
515 # considerably over time.
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.
521 # Possible applications include limiting Internet access for
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.
541 # Key values that determine what information gets logged.
549 # 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)
553 # Default value is used (see above).
557 # The available debug levels are:
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 # debug 32768 # log all data read from the network
576 # To select multiple debug levels, you can either add them or
577 # use multiple debug lines.
579 # A debug level of 1 is informative because it will show you each
580 # request as it happens. 1, 1024, 4096 and 8192 are recommended
581 # so that you will notice when things go wrong. The other levels
582 # are probably only of interest if you are hunting down a specific
583 # problem. They can produce a hell of an output (especially 16).
585 # Privoxy used to ship with the debug levels recommended above
586 # enabled by default, but due to privacy concerns 3.0.7 and later
587 # are configured to only log fatal errors.
589 # If you are used to the more verbose settings, simply enable
590 # the debug lines below again.
592 # If you want to use pure CLF (Common Log Format), you should set
593 # "debug 512" ONLY and not enable anything else.
595 # Privoxy has a hard-coded limit for the length of log messages. If
596 # it's reached, messages are logged truncated and marked with
597 # "... [too long, truncated]".
599 # Please don't file any support requests without trying to
600 # reproduce the problem with increased debug level first. Once
601 # you read the log messages, you may even be able to solve the
602 # problem on your own.
604 #debug 1 # Log the destination for each request Privoxy let through.
605 #debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
606 #debug 4096 # Startup banner and warnings
607 #debug 8192 # Non-fatal errors
610 # 3.2. single-threaded
611 # =====================
615 # Whether to run only one server thread.
627 # Multi-threaded (or, where unavailable: forked) operation,
628 # i.e. the ability to serve multiple requests simultaneously.
632 # This option is only there for debugging purposes. It will
633 # drastically reduce performance.
643 # The hostname shown on the CGI pages.
655 # The hostname provided by the operating system is used.
659 # On some misconfigured systems resolving the hostname fails or
660 # takes too much time and slows Privoxy down. Setting a fixed
661 # hostname works around the problem.
663 # In other circumstances it might be desirable to show a hostname
664 # other than the one returned by the operating system. For example
665 # if the system has several different hostnames and you don't
666 # want to use the first one.
668 # Note that Privoxy does not validate the specified hostname value.
670 #hostname hostname.example.org
673 # 4. ACCESS CONTROL AND SECURITY
674 # ===============================
676 # This section of the config file controls the security-relevant
677 # aspects of Privoxy's configuration.
681 # 4.1. listen-address
682 # ====================
686 # The IP address and TCP port on which Privoxy will listen for
699 # Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable
700 # and recommended for home users who run Privoxy on the same
701 # machine as their browser.
705 # You will need to configure your browser(s) to this proxy address
708 # If you already have another service running on port 8118, or
709 # if you want to serve requests from other machines (e.g. on your
710 # local network) as well, you will need to override the default.
712 # IPv6 addresses containing colons have to be quoted by brackets.
714 # If you leave out the IP address, Privoxy will bind to all IPv4
715 # interfaces (addresses) on your machine and may become reachable
716 # from the Internet. In that case, consider using access control
717 # lists (ACL's, see below), and/or a firewall.
719 # If you open Privoxy to untrusted users, you will also
720 # want to make sure that the following actions are disabled:
721 # enable-edit-actions and enable-remote-toggle
725 # Suppose you are running Privoxy on a machine which has the
726 # address 192.168.0.1 on your local private network (192.168.0.0)
727 # and has another outside connection with a different address. You
728 # want it to serve requests from inside only:
730 # listen-address 192.168.0.1:8118
733 # Suppose you are running Privoxy on an IPv6-capable machine and
734 # you want it to listen on the IPv6 address of the loopback device:
736 # listen-address [::1]:8118
739 listen-address 127.0.0.1:8118
747 # Initial state of "toggle" status
759 # Act as if toggled on
763 # If set to 0, Privoxy will start in "toggled off" mode,
764 # i.e. mostly behave like a normal, content-neutral proxy
765 # with both ad blocking and content filtering disabled. See
766 # enable-remote-toggle below.
768 # The windows version will only display the toggle icon in the
769 # system tray if this option is present.
774 # 4.3. enable-remote-toggle
775 # ==========================
779 # Whether or not the web-based toggle feature may be used
791 # The web-based toggle feature is disabled.
795 # When toggled off, Privoxy mostly acts like a normal,
796 # content-neutral proxy, i.e. doesn't block ads or filter content.
798 # Access to the toggle feature can not be controlled separately by
799 # "ACLs" or HTTP authentication, so that everybody who can access
800 # Privoxy (see "ACLs" and listen-address above) can toggle it
801 # for all users. So this option is not recommended for multi-user
802 # environments with untrusted users.
804 # Note that malicious client side code (e.g Java) is also capable
805 # of using this option.
807 # As a lot of Privoxy users don't read documentation, this feature
808 # is disabled by default.
810 # Note that you must have compiled Privoxy with support for this
811 # feature, otherwise this option has no effect.
813 enable-remote-toggle 0
816 # 4.4. enable-remote-http-toggle
817 # ===============================
821 # Whether or not Privoxy recognizes special HTTP headers to change
834 # Privoxy ignores special HTTP headers.
838 # When toggled on, the client can change Privoxy's behaviour by
839 # setting special HTTP headers. Currently the only supported
840 # special header is "X-Filter: No", to disable filtering for
841 # the ongoing request, even if it is enabled in one of the
844 # This feature is disabled by default. If you are using Privoxy in
845 # a environment with trusted clients, you may enable this feature
846 # at your discretion. Note that malicious client side code (e.g
847 # Java) is also capable of using this feature.
849 # This option will be removed in future releases as it has been
850 # obsoleted by the more general header taggers.
852 enable-remote-http-toggle 0
855 # 4.5. enable-edit-actions
856 # =========================
860 # Whether or not the web-based actions file editor may be used
872 # The web-based actions file editor is disabled.
876 # Access to the editor can not be controlled separately by
877 # "ACLs" or HTTP authentication, so that everybody who can access
878 # Privoxy (see "ACLs" and listen-address above) can modify its
879 # configuration for all users.
881 # This option is not recommended for environments with untrusted
882 # users and as a lot of Privoxy users don't read documentation,
883 # this feature is disabled by default.
885 # Note that malicious client side code (e.g Java) is also capable
886 # of using the actions editor and you shouldn't enable this
887 # options unless you understand the consequences and are sure
888 # your browser is configured correctly.
890 # Note that you must have compiled Privoxy with support for this
891 # feature, otherwise this option has no effect.
893 enable-edit-actions 0
896 # 4.6. enforce-blocks
897 # ====================
901 # Whether the user is allowed to ignore blocks and can "go there
914 # Blocks are not enforced.
918 # Privoxy is mainly used to block and filter requests as a service
919 # to the user, for example to block ads and other junk that clogs
920 # the pipes. Privoxy's configuration isn't perfect and sometimes
921 # innocent pages are blocked. In this situation it makes sense to
922 # allow the user to enforce the request and have Privoxy ignore
925 # In the default configuration Privoxy's "Blocked" page contains
926 # a "go there anyway" link to adds a special string (the force
927 # prefix) to the request URL. If that link is used, Privoxy
928 # will detect the force prefix, remove it again and let the
931 # Of course Privoxy can also be used to enforce a network
932 # policy. In that case the user obviously should not be able to
933 # bypass any blocks, and that's what the "enforce-blocks" option
934 # is for. If it's enabled, Privoxy hides the "go there anyway"
935 # link. If the user adds the force prefix by hand, it will not
936 # be accepted and the circumvention attempt is logged.
945 # 4.7. ACLs: permit-access and deny-access
946 # =========================================
950 # Who can access what.
954 # src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
956 # Where src_addr and dst_addr are IPv4 addresses in dotted
957 # decimal notation or valid DNS names, port is a port number, and
958 # src_masklen and dst_masklen are subnet masks in CIDR notation,
959 # i.e. integer values from 2 to 30 representing the length
960 # (in bits) of the network address. The masks and the whole
961 # destination part are optional.
963 # If your system implements RFC 3493, then src_addr and dst_addr
964 # can be IPv6 addresses delimeted by brackets, port can be a
965 # number or a service name, and src_masklen and dst_masklen can
966 # be a number from 0 to 128.
972 # If no port is specified, any port will match. If no src_masklen
973 # or src_masklen is given, the complete IP address has to match
974 # (i.e. 32 bits for IPv4 and 128 bits for IPv6).
978 # Don't restrict access further than implied by listen-address
982 # Access controls are included at the request of ISPs and systems
983 # administrators, and are not usually needed by individual
984 # users. For a typical home user, it will normally suffice to
985 # ensure that Privoxy only listens on the localhost (127.0.0.1)
986 # or internal (home) network address by means of the listen-address
989 # Please see the warnings in the FAQ that Privoxy is not intended
990 # to be a substitute for a firewall or to encourage anyone to
991 # defer addressing basic security weaknesses.
993 # Multiple ACL lines are OK. If any ACLs are specified, Privoxy
994 # only talks to IP addresses that match at least one permit-access
995 # line and don't match any subsequent deny-access line. In other
996 # words, the last match wins, with the default being deny-access.
998 # If Privoxy is using a forwarder (see forward below) for a
999 # particular destination URL, the dst_addr that is examined is
1000 # the address of the forwarder and NOT the address of the ultimate
1001 # target. This is necessary because it may be impossible for the
1002 # local Privoxy to determine the IP address of the ultimate target
1003 # (that's often what gateways are used for).
1005 # You should prefer using IP addresses over DNS names, because
1006 # the address lookups take time. All DNS names must resolve! You
1007 # can not use domain patterns like "*.org" or partial domain
1008 # names. If a DNS name resolves to multiple IP addresses, only
1009 # the first one is used.
1011 # Some systems allows IPv4 client to connect to IPv6 server
1012 # socket. Then the client's IPv4 address will be translated by
1013 # system into IPv6 address space with special prefix ::ffff:0:0/96
1014 # (so called IPv4 mapped IPv6 address). Privoxy can handle it
1015 # and maps such ACL addresses automatically.
1017 # Denying access to particular sites by ACL may have undesired
1018 # side effects if the site in question is hosted on a machine
1019 # which also hosts other sites (most sites are).
1023 # Explicitly define the default behavior if no ACL and
1024 # listen-address are set: "localhost" is OK. The absence of a
1025 # dst_addr implies that all destination addresses are OK:
1027 # permit-access localhost
1030 # Allow any host on the same class C subnet as www.privoxy.org
1031 # access to nothing but www.example.com (or other domains hosted
1032 # on the same system):
1034 # permit-access www.privoxy.org/24 www.example.com/32
1037 # Allow access from any host on the 26-bit subnet 192.168.45.64 to
1038 # anywhere, with the exception that 192.168.45.73 may not access
1039 # the IP address behind www.dirty-stuff.example.com:
1041 # permit-access 192.168.45.64/26
1042 # deny-access 192.168.45.73 www.dirty-stuff.example.com
1044 # Allow access from the IPv4 network 192.0.2.0/24 even if listening
1045 # on an IPv6 wild card address (not supported on all platforms):
1047 # permit-access 192.0.2.0/24
1050 # This is equivalent to the following line even if listening on
1051 # an IPv4 address (not supported on all platforms):
1053 # permit-access [::ffff:192.0.2.0]/120
1057 # ==================
1061 # Maximum size of the buffer for content filtering.
1073 # Use a 4MB (4096 KB) limit.
1077 # For content filtering, i.e. the +filter and +deanimate-gif
1078 # actions, it is necessary that Privoxy buffers the entire document
1079 # body. This can be potentially dangerous, since a server could
1080 # just keep sending data indefinitely and wait for your RAM to
1081 # exhaust -- with nasty consequences. Hence this option.
1083 # When a document buffer size reaches the buffer-limit, it is
1084 # flushed to the client unfiltered and no further attempt to filter
1085 # the rest of the document is made. Remember that there may be
1086 # multiple threads running, which might require up to buffer-limit
1087 # Kbytes each, unless you have enabled "single-threaded" above.
1095 # This feature allows routing of HTTP requests through a chain of
1098 # Forwarding can be used to chain Privoxy with a caching proxy to
1099 # speed up browsing. Using a parent proxy may also be necessary if
1100 # the machine that Privoxy runs on has no direct Internet access.
1102 # Note that parent proxies can severely decrease your privacy
1103 # level. For example a parent proxy could add your IP address to the
1104 # request headers and if it's a caching proxy it may add the "Etag"
1105 # header to revalidation requests again, even though you configured
1106 # Privoxy to remove it. It may also ignore Privoxy's header time
1107 # randomization and use the original values which could be used by
1108 # the server as cookie replacement to track your steps between visits.
1110 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1111 # 4 and SOCKS 4A protocols.
1120 # To which parent HTTP proxy specific requests should be routed.
1124 # target_pattern http_parent[:port]
1126 # where target_pattern is a URL pattern that specifies to which
1127 # requests (i.e. URLs) this forward rule shall apply. Use /
1128 # to denote "all URLs". http_parent[:port] is the DNS name or
1129 # IP address of the parent HTTP proxy through which the requests
1130 # should be forwarded, optionally followed by its listening port
1131 # (default: 8000). Use a single dot (.) to denote "no forwarding".
1139 # Don't use parent HTTP proxies.
1143 # If http_parent is ".", then requests are not forwarded to
1144 # another HTTP proxy but are made directly to the web servers.
1146 # http_parent can be a numerical IPv6 address (if RFC 3493 is
1147 # implemented). To prevent clashes with the port delimiter,
1148 # the whole IP address has to be put into brackets. On the other
1149 # hand a target_pattern containing an IPv6 address has to be put
1150 # into angle brackets (normal brackets are reserved for regular
1151 # expressions already).
1153 # Multiple lines are OK, they are checked in sequence, and the
1158 # Everything goes to an example parent proxy, except SSL on port
1159 # 443 (which it doesn't handle):
1161 # forward / parent-proxy.example.org:8080
1165 # Everything goes to our example ISP's caching proxy, except for
1166 # requests to that ISP's sites:
1168 # forward / caching-proxy.isp.example.net:8000
1169 # forward .isp.example.net .
1172 # Parent proxy specified by an IPv6 address:
1174 # foward / [2001:DB8::1]:8000
1177 # Suppose your parent proxy doesn't support IPv6:
1179 # forward / parent-proxy.example.org:8000
1180 # forward ipv6-server.example.org .
1181 # forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
1184 # 5.2. forward-socks4, forward-socks4a and forward-socks5
1185 # ========================================================
1189 # Through which SOCKS proxy (and optionally to which parent HTTP
1190 # proxy) specific requests should be routed.
1194 # target_pattern socks_proxy[:port] http_parent[:port]
1196 # where target_pattern is a URL pattern that specifies to which
1197 # requests (i.e. URLs) this forward rule shall apply. Use / to
1198 # denote "all URLs". http_parent and socks_proxy are IP addresses
1199 # in dotted decimal notation or valid DNS names (http_parent may
1200 # be "." to denote "no HTTP forwarding"), and the optional port
1201 # parameters are TCP ports, i.e. integer values from 1 to 65535
1209 # Don't use SOCKS proxies.
1213 # Multiple lines are OK, they are checked in sequence, and the
1216 # The difference between forward-socks4 and forward-socks4a
1217 # is that in the SOCKS 4A protocol, the DNS resolution of the
1218 # target hostname happens on the SOCKS server, while in SOCKS 4
1219 # it happens locally.
1221 # With forward-socks5 the DNS resolution will happen on the remote
1224 # socks_proxy and http_parent can be a numerical IPv6 address
1225 # (if RFC 3493 is implemented). To prevent clashes with the port
1226 # delimiter, the whole IP address has to be put into brackets. On
1227 # the other hand a target_pattern containing an IPv6 address has
1228 # to be put into angle brackets (normal brackets are reserved
1229 # for regular expressions already).
1231 # If http_parent is ".", then requests are not forwarded to another
1232 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
1233 # albeit through a SOCKS proxy.
1237 # From the company example.com, direct connections are made to all
1238 # "internal" domains, but everything outbound goes through their
1239 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway
1242 # forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
1243 # forward .example.com .
1246 # A rule that uses a SOCKS 4 gateway for all destinations but no
1247 # HTTP parent looks like this:
1249 # forward-socks4 / socks-gw.example.com:1080 .
1252 # To chain Privoxy and Tor, both running on the same system,
1253 # you would use something like:
1255 # forward-socks5 / 127.0.0.1:9050 .
1258 # The public Tor network can't be used to reach your local network,
1259 # if you need to access local servers you therefore might want
1260 # to make some exceptions:
1262 # forward 192.168.*.*/ .
1263 # forward 10.*.*.*/ .
1264 # forward 127.*.*.*/ .
1267 # Unencrypted connections to systems in these address ranges will
1268 # be as (un) secure as the local network is, but the alternative
1269 # is that you can't reach the local network through Privoxy at
1270 # all. Of course this may actually be desired and there is no
1271 # reason to make these exceptions if you aren't sure you need them.
1273 # If you also want to be able to reach servers in your local
1274 # network by using their names, you will need additional exceptions
1275 # that look like this:
1277 # forward localhost/ .
1282 # 5.3. forwarded-connect-retries
1283 # ===============================
1287 # How often Privoxy retries if a forwarded connection request
1292 # Number of retries.
1300 # Connections forwarded through other proxies are treated like
1301 # direct connections and no retry attempts are made.
1305 # forwarded-connect-retries is mainly interesting for socks4a
1306 # connections, where Privoxy can't detect why the connections
1307 # failed. The connection might have failed because of a DNS timeout
1308 # in which case a retry makes sense, but it might also have failed
1309 # because the server doesn't exist or isn't reachable. In this
1310 # case the retry will just delay the appearance of Privoxy's
1313 # Note that in the context of this option, "forwarded connections"
1314 # includes all connections that Privoxy forwards through other
1315 # proxies. This option is not limited to the HTTP CONNECT method.
1317 # Only use this option, if you are getting lots of
1318 # forwarding-related error messages that go away when you try again
1319 # manually. Start with a small value and check Privoxy's logfile
1320 # from time to time, to see how many retries are usually needed.
1322 # Due to a bug, this option currently also causes Privoxy to
1323 # retry in case of certain problems with direct connections.
1327 # forwarded-connect-retries 1
1329 forwarded-connect-retries 0
1335 # 6.1. accept-intercepted-requests
1336 # =================================
1340 # Whether intercepted requests should be treated as valid.
1352 # Only proxy requests are accepted, intercepted requests are
1353 # treated as invalid.
1357 # If you don't trust your clients and want to force them to use
1358 # Privoxy, enable this option and configure your packet filter
1359 # to redirect outgoing HTTP connections into Privoxy.
1361 # Make sure that Privoxy's own requests aren't redirected as well.
1362 # Additionally take care that Privoxy can't intentionally connect
1363 # to itself, otherwise you could run into redirection loops if
1364 # Privoxy's listening port is reachable by the outside or an
1365 # attacker has access to the pages you visit.
1369 # accept-intercepted-requests 1
1371 accept-intercepted-requests 0
1374 # 6.2. allow-cgi-request-crunching
1375 # =================================
1379 # Whether requests to Privoxy's CGI pages can be blocked or
1392 # Privoxy ignores block and redirect actions for its CGI pages.
1396 # By default Privoxy ignores block or redirect actions for
1397 # its CGI pages. Intercepting these requests can be useful in
1398 # multi-user setups to implement fine-grained access control,
1399 # but it can also render the complete web interface useless and
1400 # make debugging problems painful if done without care.
1402 # Don't enable this option unless you're sure that you really
1407 # allow-cgi-request-crunching 1
1409 allow-cgi-request-crunching 0
1412 # 6.3. split-large-forms
1413 # =======================
1417 # Whether the CGI interface should stay compatible with broken
1430 # The CGI form generate long GET URLs.
1434 # Privoxy's CGI forms can lead to rather long URLs. This isn't
1435 # a problem as far as the HTTP standard is concerned, but it can
1436 # confuse clients with arbitrary URL length limitations.
1438 # Enabling split-large-forms causes Privoxy to divide big forms
1439 # into smaller ones to keep the URL length down. It makes editing
1440 # a lot less convenient and you can no longer submit all changes
1441 # at once, but at least it works around this browser bug.
1443 # If you don't notice any editing problems, there is no reason
1444 # to enable this option, but if one of the submit buttons appears
1445 # to be broken, you should give it a try.
1449 # split-large-forms 1
1454 # 6.4. keep-alive-timeout
1455 # ========================
1459 # Number of seconds after which an open connection will no longer
1472 # Connections are not kept alive.
1476 # This option allows clients to keep the connection to Privoxy
1477 # alive. If the server supports it, Privoxy will keep the
1478 # connection to the server alive as well. Under certain
1479 # circumstances this may result in speed-ups.
1481 # By default, Privoxy will close the connection to the server if
1482 # the client connection gets closed, or if the specified timeout
1483 # has been reached without a new request coming in. This behaviour
1484 # can be changed with the connection-sharing option.
1486 # This option has no effect if Privoxy has been compiled without
1487 # keep-alive support.
1489 # Note that a timeout of five seconds as used in the default
1490 # configuration file significantly decreases the number of
1491 # connections that will be reused. The value is used because some
1492 # browsers limit the number of connections they open to a single
1493 # host and apply the same limit to proxies. This can result in a
1494 # single website "grabbing" all the connections the browser allows,
1495 # which means connections to other websites can't be opened until
1496 # the connections currently in use time out.
1498 # Several users have reported this as a Privoxy bug, so the default
1499 # value has been reduced. Consider increasing it to 300 seconds
1500 # or even more if you think your browser can handle it. If your
1501 # browser appears to be hanging it can't.
1505 # keep-alive-timeout 300
1507 keep-alive-timeout 5
1510 # 6.5. default-server-timeout
1511 # ============================
1515 # Assumed server-side keep-alive timeout if not specified by
1528 # Connections for which the server didn't specify the keep-alive
1529 # timeout are not reused.
1533 # Enabling this option significantly increases the number of
1534 # connections that are reused, provided the keep-alive-timeout
1535 # option is also enabled.
1537 # While it also increases the number of connections problems when
1538 # Privoxy tries to reuse a connection that already has been closed
1539 # on the server side, or is closed while Privoxy is trying to
1540 # reuse it, this should only be a problem if it happens for the
1541 # first request sent by the client. If it happens for requests
1542 # on reused client connections, Privoxy will simply close the
1543 # connection and the client is supposed to retry the request
1544 # without bothering the user.
1546 # Enabling this option is therefore only recommended if the
1547 # connection-sharing option is disabled.
1549 # It is an error to specify a value larger than the
1550 # keep-alive-timeout value.
1552 # This option has no effect if Privoxy has been compiled without
1553 # keep-alive support.
1557 # default-server-timeout 60
1559 #default-server-timeout 60
1561 # 6.6. connection-sharing
1562 # ========================
1566 # Whether or not outgoing connections that have been kept alive
1567 # should be shared between different incoming connections.
1579 # Connections are not shared.
1583 # This option has no effect if Privoxy has been compiled without
1584 # keep-alive support, or if it's disabled.
1588 # Note that reusing connections doesn't necessary cause
1589 # speedups. There are also a few privacy implications you should
1592 # If this option is effective, outgoing connections are shared
1593 # between clients (if there are more than one) and closing the
1594 # browser that initiated the outgoing connection does no longer
1595 # affect the connection between Privoxy and the server unless
1596 # the client's request hasn't been completed yet.
1598 # If the outgoing connection is idle, it will not be closed until
1599 # either Privoxy's or the server's timeout is reached. While
1600 # it's open, the server knows that the system running Privoxy is
1603 # If there are more than one client (maybe even belonging to
1604 # multiple users), they will be able to reuse each others
1605 # connections. This is potentially dangerous in case of
1606 # authentication schemes like NTLM where only the connection
1607 # is authenticated, instead of requiring authentication for
1610 # If there is only a single client, and if said client can keep
1611 # connections alive on its own, enabling this option has next to
1612 # no effect. If the client doesn't support connection keep-alive,
1613 # enabling this option may make sense as it allows Privoxy to keep
1614 # outgoing connections alive even if the client itself doesn't
1617 # You should also be aware that enabling this option increases
1618 # the likelihood of getting the "No server or forwarder data"
1619 # error message, especially if you are using a slow connection
1622 # This option should only be used by experienced users who
1623 # understand the risks and can weight them against the benefits.
1627 # connection-sharing 1
1629 #connection-sharing 1
1632 # 6.7. socket-timeout
1633 # ====================
1637 # Number of seconds after which a socket times out if no data
1650 # A default value of 300 seconds is used.
1654 # For SOCKS requests the timeout currently doesn't start until
1655 # the SOCKS server accepted the request. This will be fixed in
1660 # socket-timeout 300
1665 # 6.8. max-client-connections
1666 # ============================
1670 # Maximum number of client connections that will be served.
1682 # Connections are served until a resource limit is reached.
1686 # Privoxy creates one thread (or process) for every incoming
1687 # client connection that isn't rejected based on the access
1690 # If the system is powerful enough, Privoxy can theoretically deal
1691 # with several hundred (or thousand) connections at the same time,
1692 # but some operating systems enforce resource limits by shutting
1693 # down offending processes and their default limits may be below
1694 # the ones Privoxy would require under heavy load.
1696 # Configuring Privoxy to enforce a connection limit below the
1697 # thread or process limit used by the operating system makes
1698 # sure this doesn't happen. Simply increasing the operating
1699 # system's limit would work too, but if Privoxy isn't the only
1700 # application running on the system, you may actually want to
1701 # limit the resources used by Privoxy.
1703 # If Privoxy is only used by a single trusted user, limiting the
1704 # number of client connections is probably unnecessary. If there
1705 # are multiple possibly untrusted users you probably still want
1706 # to additionally use a packet filter to limit the maximal number
1707 # of incoming connections per client. Otherwise a malicious user
1708 # could intentionally create a high number of connections to
1709 # prevent other users from using Privoxy.
1711 # Obviously using this option only makes sense if you choose a
1712 # limit below the one enforced by the operating system.
1716 # max-client-connections 256
1718 #max-client-connections 256
1721 # 6.9. handle-as-empty-doc-returns-ok
1722 # ====================================
1726 # This is a work-around for Firefox bug 492459: " Websites are no
1727 # longer rendered if SSL requests for JavaScripts are blocked by
1728 # a proxy. " (https:/ /bugzilla.mozilla.org/show_bug.cgi?id=492459)
1732 # The status code Privoxy returns for pages blocked with
1733 # +handle-as-empty-document.
1745 # Privoxy returns a status 403(forbidden) for all blocked pages.
1749 # Privoxy returns a status 200(OK) for pages blocked with
1750 # +handle-as-empty-document and a status 403(Forbidden) for all
1751 # other blocked pages.
1753 handle-as-empty-doc-returns-ok 1
1756 # 7. WINDOWS GUI OPTIONS
1757 # =======================
1759 # Privoxy has a number of options specific to the Windows GUI
1763 # If "activity-animation" is set to 1, the Privoxy icon will animate
1764 # when "Privoxy" is active. To turn off, set to 0.
1766 #activity-animation 1
1768 # If "log-messages" is set to 1, Privoxy will log messages to the
1773 # If "log-buffer-size" is set to 1, the size of the log buffer,
1774 # i.e. the amount of memory used for the log messages displayed in
1775 # the console window, will be limited to "log-max-lines" (see below).
1777 # Warning: Setting this to 0 will result in the buffer to grow
1778 # infinitely and eat up all your memory!
1782 # log-max-lines is the maximum number of lines held in the log
1783 # buffer. See above.
1787 # If "log-highlight-messages" is set to 1, Privoxy will highlight
1788 # portions of the log messages with a bold-faced font:
1790 #log-highlight-messages 1
1792 # The font used in the console window:
1794 #log-font-name Comic Sans MS
1796 # Font size used in the console window:
1800 # "show-on-task-bar" controls whether or not Privoxy will appear as
1801 # a button on the Task bar when minimized:
1805 # If "close-button-minimizes" is set to 1, the Windows close button
1806 # will minimize Privoxy instead of closing the program (close with
1807 # the exit option on the File menu).
1809 #close-button-minimizes 1
1811 # The "hide-console" option is specific to the MS-Win console version
1812 # of Privoxy. If this option is used, Privoxy will disconnect from
1813 # and hide the command console.