1 # Sample Configuration File for Privoxy 3.0.25
3 # $Id: p-config.sgml,v 2.114 2016/02/26 12:32:56 fabiankeil Exp $
5 # Copyright (C) 2001-2016 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 #
20 # 7. WINDOWS GUI OPTIONS #
22 ####################################################################
28 # This file holds Privoxy's main configuration. Privoxy detects
29 # configuration changes automatically, so you don't have to restart
30 # it unless you want to load a different configuration file.
32 # The configuration will be reloaded with the first request after
33 # the change was done, this request itself will still use the old
34 # configuration, though. In other words: it takes two requests
35 # before you see the result of your changes. Requests that are
36 # dropped due to ACL don't trigger reloads.
38 # When starting Privoxy on Unix systems, give the location of this
39 # file as last argument. On Windows systems, Privoxy will look for
40 # this file with the name 'config.txt' in the current working
41 # directory of the Privoxy process.
44 # II. FORMAT OF THE CONFIGURATION FILE
45 # ====================================
47 # Configuration lines consist of an initial keyword followed by a
48 # list of values, all separated by whitespace (any number of spaces
49 # or tabs). For example,
51 # actionsfile default.action
53 # Indicates that the actionsfile is named 'default.action'.
55 # The '#' indicates a comment. Any part of a line following a '#' is
56 # ignored, except if the '#' is preceded by a '\'.
58 # Thus, by placing a # at the start of an existing configuration
59 # line, you can make it a comment and it will be treated as if it
60 # weren't there. This is called "commenting out" an option and can
61 # be useful. Removing the # again is called "uncommenting".
63 # Note that commenting out an option and leaving it at its default
64 # are two completely different things! Most options behave very
65 # differently when unset. See the "Effect if unset" explanation in
66 # each option's description for details.
68 # 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
76 # yourself, it might be a good idea to let them know how to reach
77 # you, what you block and why you do that, your policies, etc.
85 # Location of the Privoxy User Manual.
89 # A fully qualified URI
97 # http://www.privoxy.org/version/user-manual/ will be used,
98 # where version is the Privoxy version.
102 # The User Manual URI is the single best source of information
103 # on Privoxy, and is used for help links from some of the
104 # internal CGI pages. The manual itself is normally packaged
105 # with the binary distributions, so you probably want to set
106 # this to a locally installed copy.
110 # The best all purpose solution is simply to put the full local
111 # PATH to where the User Manual is located:
113 # user-manual /usr/share/doc/privoxy/user-manual
115 # The User Manual is then available to anyone with access to
116 # Privoxy, by following the built-in URL: http://
117 # config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
120 # If the documentation is not on the local system, it can be
121 # accessed from a remote server, as:
123 # user-manual http://example.com/privoxy/user-manual/
127 # If set, this option should be the first option in the
128 # config file, because it is used while the config file is
131 #user-manual http://www.privoxy.org/user-manual/
133 # 1.2. trust-info-url
134 # ====================
138 # A URL to be displayed in the error page that users will see if
139 # access to an untrusted page is denied.
151 # No links are displayed on the "untrusted" error page.
155 # The value of this option only matters if the experimental
156 # trust mechanism has been activated. (See trustfile below.)
158 # If you use the trust mechanism, it is a good idea to write up
159 # some on-line documentation about your trust policy and to
160 # specify the URL(s) here. Use multiple times for multiple URLs.
162 # The URL(s) should be added to the trustfile as well, so users
163 # don't end up locked out from the information on why they were
164 # locked out in the first place!
166 #trust-info-url http://www.example.com/why_we_block.html
167 #trust-info-url http://www.example.com/what_we_allow.html
170 # ===================
174 # An email address to reach the Privoxy administrator.
186 # No email address is displayed on error pages and the CGI user
191 # If both admin-address and proxy-info-url are unset, the whole
192 # "Local Privoxy Support" box on all generated pages will not be
195 #admin-address privoxy-admin@example.com
197 # 1.4. proxy-info-url
198 # ====================
202 # A URL to documentation about the local Privoxy setup,
203 # configuration or policies.
215 # No link to local documentation is displayed on error pages and
216 # the CGI user interface.
220 # If both admin-address and proxy-info-url are unset, the whole
221 # "Local Privoxy Support" box on all generated pages will not be
224 # This URL shouldn't be blocked ;-)
226 #proxy-info-url http://www.example.com/proxy-service.html
228 # 2. CONFIGURATION AND LOG FILE LOCATIONS
229 # ========================================
231 # Privoxy can (and normally does) use a number of other files for
232 # additional configuration, help and logging. This section of the
233 # configuration file tells Privoxy where to find those other files.
235 # The user running Privoxy, must have read permission for all
236 # configuration files, and write permission to any files that would
237 # be modified, such as log files and actions files.
245 # The directory where the other configuration files are located.
253 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
261 # No trailing "/", please.
270 # An alternative directory where the templates are loaded from.
282 # The templates are assumed to be located in confdir/template.
286 # Privoxy's original templates are usually overwritten with each
287 # update. Use this option to relocate customized templates that
288 # should be kept. As template variables might change between
289 # updates, you shouldn't expect templates to work with Privoxy
290 # releases other than the one they were part of, though.
294 # 2.3. temporary-directory
295 # =========================
299 # A directory where Privoxy can create temporary files.
311 # No temporary files are created, external filters don't work.
315 # To execute external filters, Privoxy has to create temporary
316 # files. This directive specifies the directory the temporary
317 # files should be written to.
319 # It should be a directory only Privoxy (and trusted users) can
322 #temporary-directory .
329 # The directory where all logging takes place (i.e. where the
330 # logfile is located).
338 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
346 # No trailing "/", please.
355 # The actions file(s) to use
359 # Complete file name, relative to confdir
363 # match-all.action # Actions that are applied to all sites and maybe overruled later on.
365 # default.action # Main actions file
367 # user.action # User customizations
371 # No actions are taken at all. More or less neutral proxying.
375 # Multiple actionsfile lines are permitted, and are in fact
378 # The default values are default.action, which is the "main"
379 # actions file maintained by the developers, and user.action,
380 # where you can make your personal additions.
382 # Actions files contain all the per site and per URL
383 # configuration for ad blocking, cookie management, privacy
384 # considerations, etc.
386 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
387 actionsfile default.action # Main actions file
388 actionsfile user.action # User customizations
395 # The filter file(s) to use
399 # File name, relative to confdir
403 # default.filter (Unix) or default.filter.txt (Windows)
407 # No textual content filtering takes place, i.e. all +filter{name}
408 # actions in the actions files are turned neutral.
412 # Multiple filterfile lines are permitted.
414 # The filter files contain content modification rules that use
415 # regular expressions. These rules permit powerful changes on
416 # the content of Web pages, and optionally the headers as well,
417 # e.g., you could try to disable your favorite JavaScript
418 # annoyances, re-write the actual displayed text, or just have
419 # some fun playing buzzword bingo with web pages.
421 # The +filter{name} actions rely on the relevant filter (name)
422 # to be defined in a filter file!
424 # A pre-defined filter file called default.filter that contains
425 # a number of useful filters for common problems is included in
426 # the distribution. See the section on the filter action for a
429 # It is recommended to place any locally adapted filters into a
430 # separate file, such as user.filter.
432 filterfile default.filter
433 filterfile user.filter # User customizations
440 # The log file to use
444 # File name, relative to logdir
448 # Unset (commented out). When activated: logfile (Unix) or
449 # privoxy.log (Windows).
453 # No logfile is written.
457 # The logfile is where all logging and error messages are
458 # written. The level of detail and number of messages are set
459 # with the debug option (see below). The logfile can be useful
460 # for tracking down a problem with Privoxy (e.g., it's not
461 # blocking an ad you think it should block) and it can help you
462 # to monitor what your browser is doing.
464 # Depending on the debug options below, the logfile may be a
465 # privacy risk if third parties can get access to it. As most
466 # users will never look at it, Privoxy only logs fatal errors by
469 # For most troubleshooting purposes, you will have to change
470 # that, please refer to the debugging section for details.
472 # Any log files must be writable by whatever user Privoxy is
473 # being run as (on Unix, default user id is "privoxy").
475 # To prevent the logfile from growing indefinitely, it is
476 # recommended to periodically rotate or shorten it. Many
477 # operating systems support log rotation out of the box, some
478 # require additional software to do it. For details, please
479 # refer to the documentation for your operating system.
488 # The name of the trust file to use
492 # File name, relative to confdir
496 # Unset (commented out). When activated: trust (Unix) or
497 # trust.txt (Windows)
501 # The entire trust mechanism is disabled.
505 # The trust mechanism is an experimental feature for building
506 # white-lists and should be used with care. It is NOT
507 # recommended for the casual user.
509 # If you specify a trust file, Privoxy will only allow access to
510 # sites that are specified in the trustfile. Sites can be listed
511 # in one of two ways:
513 # Prepending a ~ character limits access to this site only (and
514 # any sub-paths within this site), e.g. ~www.example.com allows
515 # access to ~www.example.com/features/news.html, etc.
517 # Or, you can designate sites as trusted referrers, by
518 # prepending the name with a + character. The effect is that
519 # access to untrusted sites will be granted -- but only if a
520 # link from this trusted referrer was used to get there. The
521 # link target will then be added to the "trustfile" so that
522 # future, direct accesses will be granted. Sites added via this
523 # mechanism do not become trusted referrers themselves (i.e.
524 # they are added with a ~ designation). There is a limit of 512
525 # such entries, after which new entries will not be made.
527 # If you use the + operator in the trust file, it may grow
528 # considerably over time.
530 # It is recommended that Privoxy be compiled with the
531 # --disable-force, --disable-toggle and --disable-editor
532 # options, if this feature is to be used.
534 # Possible applications include limiting Internet access for
542 # These options are mainly useful when tracing a problem. Note that
543 # you might also want to invoke Privoxy with the --no-daemon command
544 # line option when debugging.
552 # Key values that determine what information gets logged.
560 # 0 (i.e.: only fatal errors (that cause Privoxy to exit) are
565 # Default value is used (see above).
569 # The available debug levels are:
571 # debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
572 # debug 2 # show each connection status
573 # debug 4 # show I/O status
574 # debug 8 # show header parsing
575 # debug 16 # log all data written to the network
576 # debug 32 # debug force feature
577 # debug 64 # debug regular expression filters
578 # debug 128 # debug redirects
579 # debug 256 # debug GIF de-animation
580 # debug 512 # Common Log Format
581 # debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
582 # debug 2048 # CGI user interface
583 # debug 4096 # Startup banner and warnings.
584 # debug 8192 # Non-fatal errors
585 # debug 32768 # log all data read from the network
586 # debug 65536 # Log the applying actions
588 # To select multiple debug levels, you can either add them or
589 # use multiple debug lines.
591 # A debug level of 1 is informative because it will show you
592 # each request as it happens. 1, 1024, 4096 and 8192 are
593 # recommended so that you will notice when things go wrong. The
594 # other levels are probably only of interest if you are hunting
595 # down a specific problem. They can produce a hell of an output
598 # If you are used to the more verbose settings, simply enable
599 # the debug lines below again.
601 # If you want to use pure CLF (Common Log Format), you should
602 # set "debug 512" ONLY and not enable anything else.
604 # Privoxy has a hard-coded limit for the length of log messages.
605 # If it's reached, messages are logged truncated and marked with
606 # "... [too long, truncated]".
608 # Please don't file any support requests without trying to
609 # reproduce the problem with increased debug level first. Once
610 # you read the log messages, you may even be able to solve the
611 # problem on your own.
613 #debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
614 #debug 1024 # Actions that are applied to all sites and maybe overruled later on.
615 #debug 4096 # Startup banner and warnings
616 #debug 8192 # Non-fatal errors
618 # 3.2. single-threaded
619 # =====================
623 # Whether to run only one server thread.
635 # Multi-threaded (or, where unavailable: forked) operation, i.e.
636 # the ability to serve multiple requests simultaneously.
640 # This option is only there for debugging purposes. It will
641 # drastically reduce performance.
650 # The hostname shown on the CGI pages.
662 # The hostname provided by the operating system is used.
666 # On some misconfigured systems resolving the hostname fails or
667 # takes too much time and slows Privoxy down. Setting a fixed
668 # hostname works around the problem.
670 # In other circumstances it might be desirable to show a
671 # hostname other than the one returned by the operating system.
672 # For example if the system has several different hostnames and
673 # you don't want to use the first one.
675 # Note that Privoxy does not validate the specified hostname
678 #hostname hostname.example.org
680 # 4. ACCESS CONTROL AND SECURITY
681 # ===============================
683 # This section of the config file controls the security-relevant
684 # aspects of Privoxy's configuration.
687 # 4.1. listen-address
688 # ====================
692 # The address and TCP port on which Privoxy will listen for
707 # Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
708 # suitable and recommended for home users who run Privoxy on the
709 # same machine as their browser.
713 # You will need to configure your browser(s) to this proxy
716 # If you already have another service running on port 8118, or
717 # if you want to serve requests from other machines (e.g. on
718 # your local network) as well, you will need to override the
721 # You can use this statement multiple times to make Privoxy
722 # listen on more ports or more IP addresses. Suitable if your
723 # operating system does not support sharing IPv6 and IPv4
724 # protocols on the same socket.
726 # If a hostname is used instead of an IP address, Privoxy will
727 # try to resolve it to an IP address and if there are multiple,
728 # use the first one returned.
730 # If the address for the hostname isn't already known on the
731 # system (for example because it's in /etc/hostname), this may
732 # result in DNS traffic.
734 # If the specified address isn't available on the system, or if
735 # the hostname can't be resolved, Privoxy will fail to start.
737 # IPv6 addresses containing colons have to be quoted by
738 # brackets. They can only be used if Privoxy has been compiled
739 # with IPv6 support. If you aren't sure if your version supports
740 # it, have a look at http://config.privoxy.org/show-status.
742 # Some operating systems will prefer IPv6 to IPv4 addresses even
743 # if the system has no IPv6 connectivity which is usually not
744 # expected by the user. Some even rely on DNS to resolve
745 # localhost which mean the "localhost" address used may not
748 # It is therefore recommended to explicitly configure the
749 # intended IP address instead of relying on the operating
750 # system, unless there's a strong reason not to.
752 # If you leave out the address, Privoxy will bind to all IPv4
753 # interfaces (addresses) on your machine and may become
754 # reachable from the Internet and/or the local network. Be aware
755 # that some GNU/Linux distributions modify that behaviour
756 # without updating the documentation. Check for non-standard
757 # patches if your Privoxy version behaves differently.
759 # If you configure Privoxy to be reachable from the network,
760 # consider using access control lists (ACL's, see below), and/or
763 # If you open Privoxy to untrusted users, you will also want to
764 # make sure that the following actions are disabled:
765 # enable-edit-actions and enable-remote-toggle
769 # Suppose you are running Privoxy on a machine which has the
770 # address 192.168.0.1 on your local private network
771 # (192.168.0.0) and has another outside connection with a
772 # different address. You want it to serve requests from inside
775 # listen-address 192.168.0.1:8118
777 # Suppose you are running Privoxy on an IPv6-capable machine and
778 # you want it to listen on the IPv6 address of the loopback
781 # listen-address [::1]:8118
783 listen-address 127.0.0.1:8118
790 # Initial state of "toggle" status
802 # Act as if toggled on
806 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
807 # mostly behave like a normal, content-neutral proxy with both
808 # ad blocking and content filtering disabled. See
809 # enable-remote-toggle below.
813 # 4.3. enable-remote-toggle
814 # ==========================
818 # Whether or not the web-based toggle feature may be used
830 # The web-based toggle feature is disabled.
834 # When toggled off, Privoxy mostly acts like a normal,
835 # content-neutral proxy, i.e. doesn't block ads or filter
838 # Access to the toggle feature can not be controlled separately
839 # by "ACLs" or HTTP authentication, so that everybody who can
840 # access Privoxy (see "ACLs" and listen-address above) can
841 # toggle it for all users. So this option is not recommended for
842 # multi-user environments with untrusted users.
844 # Note that malicious client side code (e.g Java) is also
845 # capable of using this option.
847 # As a lot of Privoxy users don't read documentation, this
848 # feature is disabled by default.
850 # Note that you must have compiled Privoxy with support for this
851 # feature, otherwise this option has no effect.
853 enable-remote-toggle 0
855 # 4.4. enable-remote-http-toggle
856 # ===============================
860 # Whether or not Privoxy recognizes special HTTP headers to
861 # change its behaviour.
873 # Privoxy ignores special HTTP headers.
877 # When toggled on, the client can change Privoxy's behaviour by
878 # setting special HTTP headers. Currently the only supported
879 # special header is "X-Filter: No", to disable filtering for the
880 # ongoing request, even if it is enabled in one of the action
883 # This feature is disabled by default. If you are using Privoxy
884 # in a environment with trusted clients, you may enable this
885 # feature at your discretion. Note that malicious client side
886 # code (e.g Java) is also capable of using this feature.
888 # This option will be removed in future releases as it has been
889 # obsoleted by the more general header taggers.
891 enable-remote-http-toggle 0
893 # 4.5. enable-edit-actions
894 # =========================
898 # Whether or not the web-based actions file editor may be used
910 # The web-based actions file editor is disabled.
914 # Access to the editor can not be controlled separately by
915 # "ACLs" or HTTP authentication, so that everybody who can
916 # access Privoxy (see "ACLs" and listen-address above) can
917 # modify its configuration for all users.
919 # This option is not recommended for environments with untrusted
920 # users and as a lot of Privoxy users don't read documentation,
921 # this feature is disabled by default.
923 # Note that malicious client side code (e.g Java) is also
924 # capable of using the actions editor and you shouldn't enable
925 # this options unless you understand the consequences and are
926 # sure your browser is configured correctly.
928 # Note that you must have compiled Privoxy with support for this
929 # feature, otherwise this option has no effect.
931 enable-edit-actions 0
933 # 4.6. enforce-blocks
934 # ====================
938 # Whether the user is allowed to ignore blocks and can "go there
951 # Blocks are not enforced.
955 # Privoxy is mainly used to block and filter requests as a
956 # service to the user, for example to block ads and other junk
957 # that clogs the pipes. Privoxy's configuration isn't perfect
958 # and sometimes innocent pages are blocked. In this situation it
959 # makes sense to allow the user to enforce the request and have
960 # Privoxy ignore the block.
962 # In the default configuration Privoxy's "Blocked" page contains
963 # a "go there anyway" link to adds a special string (the force
964 # prefix) to the request URL. If that link is used, Privoxy will
965 # detect the force prefix, remove it again and let the request
968 # Of course Privoxy can also be used to enforce a network
969 # policy. In that case the user obviously should not be able to
970 # bypass any blocks, and that's what the "enforce-blocks" option
971 # is for. If it's enabled, Privoxy hides the "go there anyway"
972 # link. If the user adds the force prefix by hand, it will not
973 # be accepted and the circumvention attempt is logged.
981 # 4.7. ACLs: permit-access and deny-access
982 # =========================================
986 # Who can access what.
990 # src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
992 # Where src_addr and dst_addr are IPv4 addresses in dotted
993 # decimal notation or valid DNS names, port is a port number,
994 # and src_masklen and dst_masklen are subnet masks in CIDR
995 # notation, i.e. integer values from 2 to 30 representing the
996 # length (in bits) of the network address. The masks and the
997 # whole destination part are optional.
999 # If your system implements RFC 3493, then src_addr and dst_addr
1000 # can be IPv6 addresses delimeted by brackets, port can be a
1001 # number or a service name, and src_masklen and dst_masklen can
1002 # be a number from 0 to 128.
1008 # If no port is specified, any port will match. If no
1009 # src_masklen or src_masklen is given, the complete IP address
1010 # has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1014 # Don't restrict access further than implied by listen-address
1018 # Access controls are included at the request of ISPs and
1019 # systems administrators, and are not usually needed by
1020 # individual users. For a typical home user, it will normally
1021 # suffice to ensure that Privoxy only listens on the localhost
1022 # (127.0.0.1) or internal (home) network address by means of the
1023 # listen-address option.
1025 # Please see the warnings in the FAQ that Privoxy is not
1026 # intended to be a substitute for a firewall or to encourage
1027 # anyone to defer addressing basic security weaknesses.
1029 # Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1030 # only talks to IP addresses that match at least one
1031 # permit-access line and don't match any subsequent deny-access
1032 # line. In other words, the last match wins, with the default
1033 # being deny-access.
1035 # If Privoxy is using a forwarder (see forward below) for a
1036 # particular destination URL, the dst_addr that is examined is
1037 # the address of the forwarder and NOT the address of the
1038 # ultimate target. This is necessary because it may be
1039 # impossible for the local Privoxy to determine the IP address
1040 # of the ultimate target (that's often what gateways are used
1043 # You should prefer using IP addresses over DNS names, because
1044 # the address lookups take time. All DNS names must resolve! You
1045 # can not use domain patterns like "*.org" or partial domain
1046 # names. If a DNS name resolves to multiple IP addresses, only
1047 # the first one is used.
1049 # Some systems allow IPv4 clients to connect to IPv6 server
1050 # sockets. Then the client's IPv4 address will be translated by
1051 # the system into IPv6 address space with special prefix
1052 # ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1053 # can handle it and maps such ACL addresses automatically.
1055 # Denying access to particular sites by ACL may have undesired
1056 # side effects if the site in question is hosted on a machine
1057 # which also hosts other sites (most sites are).
1061 # Explicitly define the default behavior if no ACL and
1062 # listen-address are set: "localhost" is OK. The absence of a
1063 # dst_addr implies that all destination addresses are OK:
1065 # permit-access localhost
1067 # Allow any host on the same class C subnet as www.privoxy.org
1068 # access to nothing but www.example.com (or other domains hosted
1069 # on the same system):
1071 # permit-access www.privoxy.org/24 www.example.com/32
1073 # Allow access from any host on the 26-bit subnet 192.168.45.64
1074 # to anywhere, with the exception that 192.168.45.73 may not
1075 # access the IP address behind www.dirty-stuff.example.com:
1077 # permit-access 192.168.45.64/26
1078 # deny-access 192.168.45.73 www.dirty-stuff.example.com
1080 # Allow access from the IPv4 network 192.0.2.0/24 even if
1081 # listening on an IPv6 wild card address (not supported on all
1084 # permit-access 192.0.2.0/24
1086 # This is equivalent to the following line even if listening on
1087 # an IPv4 address (not supported on all platforms):
1089 # permit-access [::ffff:192.0.2.0]/120
1093 # ==================
1097 # Maximum size of the buffer for content filtering.
1109 # Use a 4MB (4096 KB) limit.
1113 # For content filtering, i.e. the +filter and +deanimate-gif
1114 # actions, it is necessary that Privoxy buffers the entire
1115 # document body. This can be potentially dangerous, since a
1116 # server could just keep sending data indefinitely and wait for
1117 # your RAM to exhaust -- with nasty consequences. Hence this
1120 # When a document buffer size reaches the buffer-limit, it is
1121 # flushed to the client unfiltered and no further attempt to
1122 # filter the rest of the document is made. Remember that there
1123 # may be multiple threads running, which might require up to
1124 # buffer-limit Kbytes each, unless you have enabled
1125 # "single-threaded" above.
1129 # 4.9. enable-proxy-authentication-forwarding
1130 # ============================================
1134 # Whether or not proxy authentication through Privoxy should
1147 # Proxy authentication headers are removed.
1151 # Privoxy itself does not support proxy authentication, but can
1152 # allow clients to authenticate against Privoxy's parent proxy.
1154 # By default Privoxy (3.0.21 and later) don't do that and remove
1155 # Proxy-Authorization headers in requests and Proxy-Authenticate
1156 # headers in responses to make it harder for malicious sites to
1157 # trick inexperienced users into providing login information.
1159 # If this option is enabled the headers are forwarded.
1161 # Enabling this option is not recommended if there is no parent
1162 # proxy that requires authentication or if the local network
1163 # between Privoxy and the parent proxy isn't trustworthy. If
1164 # proxy authentication is only required for some requests, it is
1165 # recommended to use a client header filter to remove the
1166 # authentication headers for requests where they aren't needed.
1168 enable-proxy-authentication-forwarding 0
1173 # This feature allows routing of HTTP requests through a chain of
1176 # Forwarding can be used to chain Privoxy with a caching proxy to
1177 # speed up browsing. Using a parent proxy may also be necessary if
1178 # the machine that Privoxy runs on has no direct Internet access.
1180 # Note that parent proxies can severely decrease your privacy level.
1181 # For example a parent proxy could add your IP address to the
1182 # request headers and if it's a caching proxy it may add the "Etag"
1183 # header to revalidation requests again, even though you configured
1184 # Privoxy to remove it. It may also ignore Privoxy's header time
1185 # randomization and use the original values which could be used by
1186 # the server as cookie replacement to track your steps between
1189 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1190 # 4 and SOCKS 4A protocols.
1198 # To which parent HTTP proxy specific requests should be routed.
1202 # target_pattern http_parent[:port]
1204 # where target_pattern is a URL pattern that specifies to which
1205 # requests (i.e. URLs) this forward rule shall apply. Use / to
1206 # denote "all URLs". http_parent[:port] is the DNS name or IP
1207 # address of the parent HTTP proxy through which the requests
1208 # should be forwarded, optionally followed by its listening port
1209 # (default: 8000). Use a single dot (.) to denote "no
1218 # Don't use parent HTTP proxies.
1222 # If http_parent is ".", then requests are not forwarded to
1223 # another HTTP proxy but are made directly to the web servers.
1225 # http_parent can be a numerical IPv6 address (if RFC 3493 is
1226 # implemented). To prevent clashes with the port delimiter, the
1227 # whole IP address has to be put into brackets. On the other
1228 # hand a target_pattern containing an IPv6 address has to be put
1229 # into angle brackets (normal brackets are reserved for regular
1230 # expressions already).
1232 # Multiple lines are OK, they are checked in sequence, and the
1237 # Everything goes to an example parent proxy, except SSL on port
1238 # 443 (which it doesn't handle):
1240 # forward / parent-proxy.example.org:8080
1243 # Everything goes to our example ISP's caching proxy, except for
1244 # requests to that ISP's sites:
1246 # forward / caching-proxy.isp.example.net:8000
1247 # forward .isp.example.net .
1249 # Parent proxy specified by an IPv6 address:
1251 # forward / [2001:DB8::1]:8000
1253 # Suppose your parent proxy doesn't support IPv6:
1255 # forward / parent-proxy.example.org:8000
1256 # forward ipv6-server.example.org .
1257 # forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
1260 # 5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1261 # =========================================================================
1265 # Through which SOCKS proxy (and optionally to which parent HTTP
1266 # proxy) specific requests should be routed.
1270 # target_pattern socks_proxy[:port] http_parent[:port]
1272 # where target_pattern is a URL pattern that specifies to which
1273 # requests (i.e. URLs) this forward rule shall apply. Use / to
1274 # denote "all URLs". http_parent and socks_proxy are IP
1275 # addresses in dotted decimal notation or valid DNS names (
1276 # http_parent may be "." to denote "no HTTP forwarding"), and
1277 # the optional port parameters are TCP ports, i.e. integer
1278 # values from 1 to 65535
1286 # Don't use SOCKS proxies.
1290 # Multiple lines are OK, they are checked in sequence, and the
1293 # The difference between forward-socks4 and forward-socks4a is
1294 # that in the SOCKS 4A protocol, the DNS resolution of the
1295 # target hostname happens on the SOCKS server, while in SOCKS 4
1296 # it happens locally.
1298 # With forward-socks5 the DNS resolution will happen on the
1299 # remote server as well.
1301 # forward-socks5t works like vanilla forward-socks5 but lets
1302 # Privoxy additionally use Tor-specific SOCKS extensions.
1303 # Currently the only supported SOCKS extension is optimistic
1304 # data which can reduce the latency for the first request made
1305 # on a newly created connection.
1307 # socks_proxy and http_parent can be a numerical IPv6 address
1308 # (if RFC 3493 is implemented). To prevent clashes with the port
1309 # delimiter, the whole IP address has to be put into brackets.
1310 # On the other hand a target_pattern containing an IPv6 address
1311 # has to be put into angle brackets (normal brackets are
1312 # reserved for regular expressions already).
1314 # If http_parent is ".", then requests are not forwarded to
1315 # another HTTP proxy but are made (HTTP-wise) directly to the
1316 # web servers, albeit through a SOCKS proxy.
1320 # From the company example.com, direct connections are made to
1321 # all "internal" domains, but everything outbound goes through
1322 # their ISP's proxy by way of example.com's corporate SOCKS 4A
1323 # gateway to the Internet.
1325 # forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
1326 # forward .example.com .
1328 # A rule that uses a SOCKS 4 gateway for all destinations but no
1329 # HTTP parent looks like this:
1331 # forward-socks4 / socks-gw.example.com:1080 .
1333 # To chain Privoxy and Tor, both running on the same system, you
1334 # would use something like:
1336 # forward-socks5t / 127.0.0.1:9050 .
1338 # Note that if you got Tor through one of the bundles, you may
1339 # have to change the port from 9050 to 9150 (or even another
1340 # one). For details, please check the documentation on the Tor
1343 # The public Tor network can't be used to reach your local
1344 # network, if you need to access local servers you therefore
1345 # might want to make some exceptions:
1347 # forward 192.168.*.*/ .
1348 # forward 10.*.*.*/ .
1349 # forward 127.*.*.*/ .
1351 # Unencrypted connections to systems in these address ranges
1352 # will be as (un)secure as the local network is, but the
1353 # alternative is that you can't reach the local network through
1354 # Privoxy at all. Of course this may actually be desired and
1355 # there is no reason to make these exceptions if you aren't sure
1358 # If you also want to be able to reach servers in your local
1359 # network by using their names, you will need additional
1360 # exceptions that look like this:
1362 # forward localhost/ .
1365 # 5.3. forwarded-connect-retries
1366 # ===============================
1370 # How often Privoxy retries if a forwarded connection request
1375 # Number of retries.
1383 # Connections forwarded through other proxies are treated like
1384 # direct connections and no retry attempts are made.
1388 # forwarded-connect-retries is mainly interesting for socks4a
1389 # connections, where Privoxy can't detect why the connections
1390 # failed. The connection might have failed because of a DNS
1391 # timeout in which case a retry makes sense, but it might also
1392 # have failed because the server doesn't exist or isn't
1393 # reachable. In this case the retry will just delay the
1394 # appearance of Privoxy's error message.
1396 # Note that in the context of this option, "forwarded
1397 # connections" includes all connections that Privoxy forwards
1398 # through other proxies. This option is not limited to the HTTP
1401 # Only use this option, if you are getting lots of
1402 # forwarding-related error messages that go away when you try
1403 # again manually. Start with a small value and check Privoxy's
1404 # logfile from time to time, to see how many retries are usually
1409 # forwarded-connect-retries 1
1411 forwarded-connect-retries 0
1416 # 6.1. accept-intercepted-requests
1417 # =================================
1421 # Whether intercepted requests should be treated as valid.
1433 # Only proxy requests are accepted, intercepted requests are
1434 # treated as invalid.
1438 # If you don't trust your clients and want to force them to use
1439 # Privoxy, enable this option and configure your packet filter
1440 # to redirect outgoing HTTP connections into Privoxy.
1442 # Note that intercepting encrypted connections (HTTPS) isn't
1445 # Make sure that Privoxy's own requests aren't redirected as
1446 # well. Additionally take care that Privoxy can't intentionally
1447 # connect to itself, otherwise you could run into redirection
1448 # loops if Privoxy's listening port is reachable by the outside
1449 # or an attacker has access to the pages you visit.
1453 # accept-intercepted-requests 1
1455 accept-intercepted-requests 0
1457 # 6.2. allow-cgi-request-crunching
1458 # =================================
1462 # Whether requests to Privoxy's CGI pages can be blocked or
1475 # Privoxy ignores block and redirect actions for its CGI pages.
1479 # By default Privoxy ignores block or redirect actions for its
1480 # CGI pages. Intercepting these requests can be useful in
1481 # multi-user setups to implement fine-grained access control,
1482 # but it can also render the complete web interface useless and
1483 # make debugging problems painful if done without care.
1485 # Don't enable this option unless you're sure that you really
1490 # allow-cgi-request-crunching 1
1492 allow-cgi-request-crunching 0
1494 # 6.3. split-large-forms
1495 # =======================
1499 # Whether the CGI interface should stay compatible with broken
1512 # The CGI form generate long GET URLs.
1516 # Privoxy's CGI forms can lead to rather long URLs. This isn't a
1517 # problem as far as the HTTP standard is concerned, but it can
1518 # confuse clients with arbitrary URL length limitations.
1520 # Enabling split-large-forms causes Privoxy to divide big forms
1521 # into smaller ones to keep the URL length down. It makes
1522 # editing a lot less convenient and you can no longer submit all
1523 # changes at once, but at least it works around this browser
1526 # If you don't notice any editing problems, there is no reason
1527 # to enable this option, but if one of the submit buttons
1528 # appears to be broken, you should give it a try.
1532 # split-large-forms 1
1536 # 6.4. keep-alive-timeout
1537 # ========================
1541 # Number of seconds after which an open connection will no
1554 # Connections are not kept alive.
1558 # This option allows clients to keep the connection to Privoxy
1559 # alive. If the server supports it, Privoxy will keep the
1560 # connection to the server alive as well. Under certain
1561 # circumstances this may result in speed-ups.
1563 # By default, Privoxy will close the connection to the server if
1564 # the client connection gets closed, or if the specified timeout
1565 # has been reached without a new request coming in. This
1566 # behaviour can be changed with the connection-sharing option.
1568 # This option has no effect if Privoxy has been compiled without
1569 # keep-alive support.
1571 # Note that a timeout of five seconds as used in the default
1572 # configuration file significantly decreases the number of
1573 # connections that will be reused. The value is used because
1574 # some browsers limit the number of connections they open to a
1575 # single host and apply the same limit to proxies. This can
1576 # result in a single website "grabbing" all the connections the
1577 # browser allows, which means connections to other websites
1578 # can't be opened until the connections currently in use time
1581 # Several users have reported this as a Privoxy bug, so the
1582 # default value has been reduced. Consider increasing it to 300
1583 # seconds or even more if you think your browser can handle it.
1584 # If your browser appears to be hanging, it probably can't.
1588 # keep-alive-timeout 300
1590 keep-alive-timeout 5
1592 # 6.5. tolerate-pipelining
1593 # =========================
1597 # Whether or not pipelined requests should be served.
1609 # If Privoxy receives more than one request at once, it
1610 # terminates the client connection after serving the first one.
1614 # Privoxy currently doesn't pipeline outgoing requests, thus
1615 # allowing pipelining on the client connection is not guaranteed
1616 # to improve the performance.
1618 # By default Privoxy tries to discourage clients from pipelining
1619 # by discarding aggressively pipelined requests, which forces
1620 # the client to resend them through a new connection.
1622 # This option lets Privoxy tolerate pipelining. Whether or not
1623 # that improves performance mainly depends on the client
1626 # If you are seeing problems with pages not properly loading,
1627 # disabling this option could work around the problem.
1631 # tolerate-pipelining 1
1633 tolerate-pipelining 1
1635 # 6.6. default-server-timeout
1636 # ============================
1640 # Assumed server-side keep-alive timeout if not specified by the
1653 # Connections for which the server didn't specify the keep-alive
1654 # timeout are not reused.
1658 # Enabling this option significantly increases the number of
1659 # connections that are reused, provided the keep-alive-timeout
1660 # option is also enabled.
1662 # While it also increases the number of connections problems
1663 # when Privoxy tries to reuse a connection that already has been
1664 # closed on the server side, or is closed while Privoxy is
1665 # trying to reuse it, this should only be a problem if it
1666 # happens for the first request sent by the client. If it
1667 # happens for requests on reused client connections, Privoxy
1668 # will simply close the connection and the client is supposed to
1669 # retry the request without bothering the user.
1671 # Enabling this option is therefore only recommended if the
1672 # connection-sharing option is disabled.
1674 # It is an error to specify a value larger than the
1675 # keep-alive-timeout value.
1677 # This option has no effect if Privoxy has been compiled without
1678 # keep-alive support.
1682 # default-server-timeout 60
1684 #default-server-timeout 60
1686 # 6.7. connection-sharing
1687 # ========================
1691 # Whether or not outgoing connections that have been kept alive
1692 # should be shared between different incoming connections.
1704 # Connections are not shared.
1708 # This option has no effect if Privoxy has been compiled without
1709 # keep-alive support, or if it's disabled.
1713 # Note that reusing connections doesn't necessary cause
1714 # speedups. There are also a few privacy implications you should
1717 # If this option is effective, outgoing connections are shared
1718 # between clients (if there are more than one) and closing the
1719 # browser that initiated the outgoing connection does no longer
1720 # affect the connection between Privoxy and the server unless
1721 # the client's request hasn't been completed yet.
1723 # If the outgoing connection is idle, it will not be closed
1724 # until either Privoxy's or the server's timeout is reached.
1725 # While it's open, the server knows that the system running
1726 # Privoxy is still there.
1728 # If there are more than one client (maybe even belonging to
1729 # multiple users), they will be able to reuse each others
1730 # connections. This is potentially dangerous in case of
1731 # authentication schemes like NTLM where only the connection is
1732 # authenticated, instead of requiring authentication for each
1735 # If there is only a single client, and if said client can keep
1736 # connections alive on its own, enabling this option has next to
1737 # no effect. If the client doesn't support connection
1738 # keep-alive, enabling this option may make sense as it allows
1739 # Privoxy to keep outgoing connections alive even if the client
1740 # itself doesn't support it.
1742 # You should also be aware that enabling this option increases
1743 # the likelihood of getting the "No server or forwarder data"
1744 # error message, especially if you are using a slow connection
1747 # This option should only be used by experienced users who
1748 # understand the risks and can weight them against the benefits.
1752 # connection-sharing 1
1754 #connection-sharing 1
1756 # 6.8. socket-timeout
1757 # ====================
1761 # Number of seconds after which a socket times out if no data is
1774 # A default value of 300 seconds is used.
1778 # The default is quite high and you probably want to reduce it.
1779 # If you aren't using an occasionally slow proxy like Tor,
1780 # reducing it to a few seconds should be fine.
1784 # socket-timeout 300
1788 # 6.9. max-client-connections
1789 # ============================
1793 # Maximum number of client connections that will be served.
1805 # Connections are served until a resource limit is reached.
1809 # Privoxy creates one thread (or process) for every incoming
1810 # client connection that isn't rejected based on the access
1813 # If the system is powerful enough, Privoxy can theoretically
1814 # deal with several hundred (or thousand) connections at the
1815 # same time, but some operating systems enforce resource limits
1816 # by shutting down offending processes and their default limits
1817 # may be below the ones Privoxy would require under heavy load.
1819 # Configuring Privoxy to enforce a connection limit below the
1820 # thread or process limit used by the operating system makes
1821 # sure this doesn't happen. Simply increasing the operating
1822 # system's limit would work too, but if Privoxy isn't the only
1823 # application running on the system, you may actually want to
1824 # limit the resources used by Privoxy.
1826 # If Privoxy is only used by a single trusted user, limiting the
1827 # number of client connections is probably unnecessary. If there
1828 # are multiple possibly untrusted users you probably still want
1829 # to additionally use a packet filter to limit the maximal
1830 # number of incoming connections per client. Otherwise a
1831 # malicious user could intentionally create a high number of
1832 # connections to prevent other users from using Privoxy.
1834 # Obviously using this option only makes sense if you choose a
1835 # limit below the one enforced by the operating system.
1837 # One most POSIX-compliant systems Privoxy can't properly deal
1838 # with more than FD_SETSIZE file descriptors at the same time
1839 # and has to reject connections if the limit is reached. This
1840 # will likely change in a future version, but currently this
1841 # limit can't be increased without recompiling Privoxy with a
1842 # different FD_SETSIZE limit.
1846 # max-client-connections 256
1848 #max-client-connections 256
1850 # 6.10. handle-as-empty-doc-returns-ok
1851 # =====================================
1855 # The status code Privoxy returns for pages blocked with
1856 # +handle-as-empty-document.
1868 # Privoxy returns a status 403(forbidden) for all blocked pages.
1872 # Privoxy returns a status 200(OK) for pages blocked with
1873 # +handle-as-empty-document and a status 403(Forbidden) for all
1874 # other blocked pages.
1878 # This directive was added as a work-around for Firefox bug
1879 # 492459: "Websites are no longer rendered if SSL requests for
1880 # JavaScripts are blocked by a proxy."
1881 # (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
1882 # has been fixed for quite some time, but this directive is also
1883 # useful to make it harder for websites to detect whether or not
1884 # resources are being blocked.
1886 #handle-as-empty-doc-returns-ok 1
1888 # 6.11. enable-compression
1889 # =========================
1893 # Whether or not buffered content is compressed before delivery.
1905 # Privoxy does not compress buffered content.
1909 # Privoxy compresses buffered content before delivering it to
1910 # the client, provided the client supports it.
1914 # This directive is only supported if Privoxy has been compiled
1915 # with FEATURE_COMPRESSION, which should not to be confused with
1918 # Compressing buffered content is mainly useful if Privoxy and
1919 # the client are running on different systems. If they are
1920 # running on the same system, enabling compression is likely to
1921 # slow things down. If you didn't measure otherwise, you should
1922 # assume that it does and keep this option disabled.
1924 # Privoxy will not compress buffered content below a certain
1927 #enable-compression 1
1929 # 6.12. compression-level
1930 # ========================
1934 # The compression level that is passed to the zlib library when
1935 # compressing buffered content.
1939 # Positive number ranging from 0 to 9.
1947 # Compressing the data more takes usually longer than
1948 # compressing it less or not compressing it at all. Which level
1949 # is best depends on the connection between Privoxy and the
1950 # client. If you can't be bothered to benchmark it for yourself,
1951 # you should stick with the default and keep compression
1954 # If compression is disabled, the compression level is
1959 # # Best speed (compared to the other levels)
1960 # compression-level 1
1962 # # Best compression
1963 # compression-level 9
1965 # # No compression. Only useful for testing as the added header
1966 # # slightly increases the amount of data that has to be sent.
1967 # # If your benchmark shows that using this compression level
1968 # # is superior to using no compression at all, the benchmark
1969 # # is likely to be flawed.
1970 # compression-level 0
1973 #compression-level 1
1975 # 6.13. client-header-order
1976 # ==========================
1980 # The order in which client headers are sorted before forwarding
1985 # Client header names delimited by spaces or tabs
1993 # By default Privoxy leaves the client headers in the order they
1994 # were sent by the client. Headers are modified in-place, new
1995 # headers are added at the end of the already existing headers.
1997 # The header order can be used to fingerprint client requests
1998 # independently of other headers like the User-Agent.
2000 # This directive allows to sort the headers differently to
2001 # better mimic a different User-Agent. Client headers will be
2002 # emitted in the order given, headers whose name isn't
2003 # explicitly specified are added at the end.
2005 # Note that sorting headers in an uncommon way will make
2006 # fingerprinting actually easier. Encrypted headers are not
2007 # affected by this directive.
2009 #client-header-order Host \
2013 # Proxy-Connection \
2017 # If-Modified-Since \
2023 # 6.14. client-specific-tag
2024 # ==========================
2028 # The name of a tag that will always be set for clients that
2029 # requested it through the webinterface.
2033 # Tag name followed by a description that will be shown in the
2042 # +-----------------------------------------------------+
2044 # |-----------------------------------------------------|
2045 # |This is an experimental feature. The syntax is likely|
2046 # |to change in future versions. |
2047 # +-----------------------------------------------------+
2049 # Client-specific tags allow Privoxy admins to create different
2050 # profiles and let the users chose which one they want without
2051 # impacting other users.
2053 # One use case is allowing users to circumvent certain blocks
2054 # without having to allow them to circumvent all blocks. This is
2055 # not possible with the enable-remote-toggle feature because it
2056 # would bluntly disable all blocks for all users and also affect
2057 # other actions like filters. It also is set globally which
2058 # renders it useless in most multi-user setups.
2060 # After a client-specific tag has been defined with the
2061 # client-specific-tag directive, action sections can be
2062 # activated based on the tag by using a CLIENT-TAG pattern. The
2063 # CLIENT-TAG pattern is evaluated at the same priority as URL
2064 # patterns, as a result the last matching pattern wins. Tags
2065 # that are created based on client or server headers are
2066 # evaluated later on and can overrule CLIENT-TAG and URL
2069 # The tag is set for all requests that come from clients that
2070 # requested it to be set. Note that "clients" are differentiated
2071 # by IP address, if the IP address changes the tag has to be
2074 # Clients can request tags to be set by using the CGI interface
2075 # http://config.privoxy.org/show-client-tags. The specific tag
2076 # description is only used on the web page and should be phrased
2077 # in away that the user understand the effect of the tag.
2081 # # Define a couple of tags, the described effect requires action sections
2082 # # that are enabled based on CLIENT-TAG patterns.
2083 # client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
2084 # disable-content-filters Disable content-filters but do not affect other actions
2088 # 6.15. client-tag-lifetime
2089 # ==========================
2093 # How long a temporarily enabled tag remains enabled.
2105 # +-----------------------------------------------------+
2107 # |-----------------------------------------------------|
2108 # |This is an experimental feature. The syntax is likely|
2109 # |to change in future versions. |
2110 # +-----------------------------------------------------+
2112 # In case of some tags users may not want to enable them
2113 # permanently, but only for a short amount of time, for example
2114 # to circumvent a block that is the result of an overly-broad
2117 # The CGI interface http://config.privoxy.org/show-client-tags
2118 # therefore provides a "enable this tag temporarily" option. If
2119 # it is used, the tag will be set until the client-tag-lifetime
2123 # 7. WINDOWS GUI OPTIONS
2124 # =======================
2126 # Privoxy has a number of options specific to the Windows GUI
2131 # If "activity-animation" is set to 1, the Privoxy icon will animate
2132 # when "Privoxy" is active. To turn off, set to 0.
2134 #activity-animation 1
2138 # If "log-messages" is set to 1, Privoxy copies log messages to the
2139 # console window. The log detail depends on the debug directive.
2145 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2146 # the amount of memory used for the log messages displayed in the
2147 # console window, will be limited to "log-max-lines" (see below).
2149 # Warning: Setting this to 0 will result in the buffer to grow
2150 # infinitely and eat up all your memory!
2156 # log-max-lines is the maximum number of lines held in the log
2157 # buffer. See above.
2163 # If "log-highlight-messages" is set to 1, Privoxy will highlight
2164 # portions of the log messages with a bold-faced font:
2166 #log-highlight-messages 1
2170 # The font used in the console window:
2172 #log-font-name Comic Sans MS
2176 # Font size used in the console window:
2182 # "show-on-task-bar" controls whether or not Privoxy will appear as
2183 # a button on the Task bar when minimized:
2189 # If "close-button-minimizes" is set to 1, the Windows close button
2190 # will minimize Privoxy instead of closing the program (close with
2191 # the exit option on the File menu).
2193 #close-button-minimizes 1
2197 # The "hide-console" option is specific to the MS-Win console
2198 # version of Privoxy. If this option is used, Privoxy will
2199 # disconnect from and hide the command console.