1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
5 >The Main Configuration File</TITLE
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10 TITLE="Privoxy 3.0.27 User Manual"
11 HREF="index.html"><LINK
13 TITLE="Privoxy Configuration"
14 HREF="configuration.html"><LINK
17 HREF="actions-file.html"><LINK
20 HREF="../p_doc.css"><META
21 HTTP-EQUIV="Content-Type"
24 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
36 SUMMARY="Header navigation table"
45 >Privoxy 3.0.27 User Manual</TH
53 HREF="configuration.html"
67 HREF="actions-file.html"
82 >7. The Main Configuration File</A
85 > By default, the main configuration file is named <TT
89 with the exception of Windows, where it is named <TT
93 Configuration lines consist of an initial keyword followed by a list of
94 values, all separated by whitespace (any number of spaces or tabs). For
100 CLASS="LITERALLAYOUT"
105 >confdir /etc/privoxy</I
112 > Assigns the value <TT
119 > and thus indicates that the configuration
120 directory is named <SPAN
122 >"/etc/privoxy/"</SPAN
125 > All options in the config file except for <TT
132 > are optional. Watch out in the below description
133 for what happens if you leave them unset.</P
135 > The main config file controls all aspects of <SPAN
139 operation that are not location dependent (i.e. they apply universally, no matter
140 where you may be surfing). Like the filter and action files, the config file is
141 a plain text file and can be modified with a text editor like emacs, vim or
149 >7.1. Local Set-up Documentation</A
152 > If you intend to operate <SPAN
156 than just yourself, it might be a good idea to let them know how to reach
157 you, what you block and why you do that, your policies, etc.
165 >7.1.1. user-manual</A
176 > Location of the <SPAN
186 >A fully qualified URI</P
201 >Effect if unset:</DT
205 HREF="https://www.privoxy.org/user-manual/"
207 >https://www.privoxy.org/<TT
214 will be used, where <TT
229 > The User Manual URI is the single best source of information on
233 >, and is used for help links from some
234 of the internal CGI pages. The manual itself is normally packaged with the
235 binary distributions, so you probably want to set this to a locally
242 > The best all purpose solution is simply to put the full local
260 >  user-manual  /usr/share/doc/privoxy/user-manual</PRE
265 > The User Manual is then available to anyone with access to
269 >, by following the built-in URL:
272 >http://config.privoxy.org/user-manual/</TT
274 (or the shortcut: <TT
276 >http://p.p/user-manual/</TT
280 > If the documentation is not on the local system, it can be accessed
281 from a remote server, as:
291 >  user-manual  http://example.com/privoxy/user-manual/</PRE
314 > If set, this option should be <SPAN
318 >the first option in the config
321 >, because it is used while the config file is being read
337 NAME="TRUST-INFO-URL"
338 >7.1.2. trust-info-url</A
349 > A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
371 >Effect if unset:</DT
374 > No links are displayed on the "untrusted" error page.
381 > The value of this option only matters if the experimental trust mechanism has been
383 HREF="config.html#TRUSTFILE"
394 > If you use the trust mechanism, it is a good idea to write up some on-line
395 documentation about your trust policy and to specify the URL(s) here.
396 Use multiple times for multiple URLs.
399 > The URL(s) should be added to the trustfile as well, so users don't end up
400 locked out from the information on why they were locked out in the first place!
412 >7.1.3. admin-address</A
423 > An email address to reach the <SPAN
448 >Effect if unset:</DT
451 > No email address is displayed on error pages and the CGI user interface.
465 are unset, the whole "Local Privoxy Support" box on all generated pages will
477 NAME="PROXY-INFO-URL"
478 >7.1.4. proxy-info-url</A
489 > A URL to documentation about the local <SPAN
493 configuration or policies.
515 >Effect if unset:</DT
518 > No link to local documentation is displayed on error pages and the CGI user interface.
532 are unset, the whole "Local Privoxy Support" box on all generated pages will
536 > This URL shouldn't be blocked ;-)
549 >7.2. Configuration and Log File Locations</A
555 > can (and normally does) use a number of
556 other files for additional configuration, help and logging.
557 This section of the configuration file tells <SPAN
561 where to find those other files.</P
563 > The user running <SPAN
567 permission for all configuration files, and write permission to any files
568 that would be modified, such as log files and actions files.</P
586 >The directory where the other configuration files are located.</P
598 >/etc/privoxy (Unix) <SPAN
607 > installation dir (Windows) </P
610 >Effect if unset:</DT
654 >An alternative directory where the templates are loaded from.</P
669 >Effect if unset:</DT
672 >The templates are assumed to be located in confdir/template.</P
681 > original templates are usually
682 overwritten with each update. Use this option to relocate customized
683 templates that should be kept. As template variables might change
684 between updates, you shouldn't expect templates to work with
688 > releases other than the one
689 they were part of, though.
700 NAME="TEMPORARY-DIRECTORY"
701 >7.2.3. temporary-directory</A
712 >A directory where Privoxy can create temporary files.</P
727 >Effect if unset:</DT
730 >No temporary files are created, external filters don't work.</P
739 HREF="actions-file.html#EXTERNAL-FILTER"
747 > has to create temporary files.
748 This directive specifies the directory the temporary files should
752 > It should be a directory only <SPAN
756 (and trusted users) can access.
779 > The directory where all logging takes place
796 >/var/log/privoxy (Unix) <SPAN
805 > installation dir (Windows) </P
808 >Effect if unset:</DT
841 >7.2.5. actionsfile</A
844 NAME="DEFAULT.ACTION"
847 NAME="STANDARD.ACTION"
862 HREF="actions-file.html"
871 >Complete file name, relative to <TT
887 CLASS="LITERALLAYOUT"
888 > match-all.action # Actions that are applied to all sites and maybe overruled later on.</P
895 CLASS="LITERALLAYOUT"
896 > default.action # Main actions file</P
903 CLASS="LITERALLAYOUT"
904 > user.action # User customizations</P
914 >Effect if unset:</DT
917 > No actions are taken at all. More or less neutral proxying.
927 > lines are permitted, and are in fact recommended!
930 > The default values are <TT
937 > actions file maintained by the developers, and
941 >, where you can make your personal additions.
944 > Actions files contain all the per site and per URL configuration for
945 ad blocking, cookie management, privacy considerations, etc.
957 >7.2.6. filterfile</A
960 NAME="DEFAULT.FILTER"
972 HREF="filter-file.html"
981 >File name, relative to <TT
990 >default.filter (Unix) <SPAN
996 > default.filter.txt (Windows)</P
999 >Effect if unset:</DT
1002 > No textual content filtering takes place, i.e. all
1006 HREF="actions-file.html#FILTER"
1015 actions in the actions files are turned neutral.
1025 > lines are permitted.
1029 HREF="filter-file.html"
1031 > contain content modification
1033 HREF="appendix.html#REGEX"
1034 >regular expressions</A
1035 >. These rules permit
1036 powerful changes on the content of Web pages, and optionally the headers
1037 as well, e.g., you could try to disable your favorite JavaScript annoyances,
1038 re-write the actual displayed text, or just have some fun
1039 playing buzzword bingo with web pages.
1046 HREF="actions-file.html#FILTER"
1055 actions rely on the relevant filter (<TT
1061 to be defined in a filter file!
1064 > A pre-defined filter file called <TT
1068 a number of useful filters for common problems is included in the distribution.
1069 See the section on the <TT
1072 HREF="actions-file.html#FILTER"
1079 > It is recommended to place any locally adapted filters into a separate
1100 CLASS="VARIABLELIST"
1106 > The log file to use
1113 >File name, relative to <TT
1126 >Unset (commented out)</I
1128 >. When activated: logfile (Unix) <SPAN
1134 > privoxy.log (Windows).</P
1137 >Effect if unset:</DT
1140 > No logfile is written.
1147 > The logfile is where all logging and error messages are written. The level
1148 of detail and number of messages are set with the <TT
1152 option (see below). The logfile can be useful for tracking down a problem with
1156 > (e.g., it's not blocking an ad you
1157 think it should block) and it can help you to monitor what your browser
1161 > Depending on the debug options below, the logfile may be a privacy risk
1162 if third parties can get access to it. As most users will never look
1166 > only logs fatal errors by default.
1169 > For most troubleshooting purposes, you will have to change that,
1170 please refer to the debugging section for details.
1173 > Any log files must be writable by whatever user <SPAN
1177 is being run as (on Unix, default user id is <SPAN
1183 > To prevent the logfile from growing indefinitely, it is recommended to
1184 periodically rotate or shorten it. Many operating systems support log
1185 rotation out of the box, some require additional software to do it.
1186 For details, please refer to the documentation for your operating system.
1198 >7.2.8. trustfile</A
1203 CLASS="VARIABLELIST"
1209 > The name of the trust file to use
1216 >File name, relative to <TT
1229 >Unset (commented out)</I
1231 >. When activated: trust (Unix) <SPAN
1237 > trust.txt (Windows)</P
1240 >Effect if unset:</DT
1243 > The entire trust mechanism is disabled.
1250 > The trust mechanism is an experimental feature for building white-lists and should
1251 be used with care. It is <SPAN
1257 > recommended for the casual user.
1260 > If you specify a trust file, <SPAN
1264 access to sites that are specified in the trustfile. Sites can be listed
1271 > character limits access to this site
1272 only (and any sub-paths within this site), e.g.
1275 >~www.example.com</TT
1279 >~www.example.com/features/news.html</TT
1283 > Or, you can designate sites as <SPAN
1287 >trusted referrers</I
1290 prepending the name with a <TT
1293 > character. The effect is that
1294 access to untrusted sites will be granted -- but only if a link from this
1295 trusted referrer was used to get there. The link target will then be added
1299 > so that future, direct accesses will be
1300 granted. Sites added via this mechanism do not become trusted referrers
1301 themselves (i.e. they are added with a <TT
1305 There is a limit of 512 such entries, after which new entries will not be
1309 > If you use the <TT
1312 > operator in the trust file, it may grow
1313 considerably over time.
1316 > It is recommended that <SPAN
1322 >--disable-force</TT
1325 >--disable-toggle</TT
1329 > --disable-editor</TT
1330 > options, if this feature is to be
1334 > Possible applications include limiting Internet access for children.
1350 > These options are mainly useful when tracing a problem.
1351 Note that you might also want to invoke
1359 command line option when debugging.
1372 CLASS="VARIABLELIST"
1378 > Key values that determine what information gets logged.
1391 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1394 >Effect if unset:</DT
1397 > Default value is used (see above).
1404 > The available debug levels are:
1413 CLASS="PROGRAMLISTING"
1414 > debug 1 # Log the destination for each request <SPAN
1417 > let through. See also debug 1024.
1418 debug 2 # show each connection status
1419 debug 4 # show I/O status
1420 debug 8 # show header parsing
1421 debug 16 # log all data written to the network
1422 debug 32 # debug force feature
1423 debug 64 # debug regular expression filters
1424 debug 128 # debug redirects
1425 debug 256 # debug GIF de-animation
1426 debug 512 # Common Log Format
1427 debug 1024 # Log the destination for requests <SPAN
1430 > didn't let through, and the reason why.
1431 debug 2048 # CGI user interface
1432 debug 4096 # Startup banner and warnings.
1433 debug 8192 # Non-fatal errors
1434 debug 32768 # log all data read from the network
1435 debug 65536 # Log the applying actions</PRE
1440 > To select multiple debug levels, you can either add them or use
1447 > A debug level of 1 is informative because it will show you each request
1448 as it happens. <SPAN
1452 >1, 1024, 4096 and 8192 are recommended</I
1455 so that you will notice when things go wrong. The other levels are
1456 probably only of interest if you are hunting down a specific problem.
1457 They can produce a hell of an output (especially 16).
1460 > If you are used to the more verbose settings, simply enable the debug lines
1464 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1474 > and not enable anything else.
1480 > has a hard-coded limit for the
1481 length of log messages. If it's reached, messages are logged truncated
1482 and marked with <SPAN
1484 >"... [too long, truncated]"</SPAN
1488 > Please don't file any support requests without trying to reproduce
1489 the problem with increased debug level first. Once you read the log
1490 messages, you may even be able to solve the problem on your own.
1501 NAME="SINGLE-THREADED"
1502 >7.3.2. single-threaded</A
1507 CLASS="VARIABLELIST"
1513 > Whether to run only one server thread.
1541 >Effect if unset:</DT
1544 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1545 serve multiple requests simultaneously.
1552 > This option is only there for debugging purposes.
1557 >It will drastically reduce performance.</I
1576 CLASS="VARIABLELIST"
1582 > The hostname shown on the CGI pages.
1604 >Effect if unset:</DT
1607 > The hostname provided by the operating system is used.
1614 > On some misconfigured systems resolving the hostname fails or
1615 takes too much time and slows Privoxy down. Setting a fixed hostname
1616 works around the problem.
1619 > In other circumstances it might be desirable to show a hostname
1620 other than the one returned by the operating system. For example
1621 if the system has several different hostnames and you don't want
1622 to use the first one.
1625 > Note that Privoxy does not validate the specified hostname value.
1637 NAME="ACCESS-CONTROL"
1638 >7.4. Access Control and Security</A
1641 > This section of the config file controls the security-relevant aspects
1652 NAME="LISTEN-ADDRESS"
1653 >7.4.1. listen-address</A
1658 CLASS="VARIABLELIST"
1664 > The address and TCP port on which <SPAN
1668 listen for client requests.
1706 >Effect if unset:</DT
1709 > Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1710 recommended for home users who run <SPAN
1714 the same machine as their browser.
1721 > You will need to configure your browser(s) to this proxy address and port.
1724 > If you already have another service running on port 8118, or if you want to
1725 serve requests from other machines (e.g. on your local network) as well, you
1726 will need to override the default.
1729 > You can use this statement multiple times to make
1733 > listen on more ports or more
1737 > addresses. Suitable if your operating system does not
1738 support sharing <ABBR
1748 > If a hostname is used instead of an IP address, <SPAN
1752 will try to resolve it to an IP address and if there are multiple, use the first
1756 > If the address for the hostname isn't already known on the system
1757 (for example because it's in /etc/hostname), this may result in DNS
1761 > If the specified address isn't available on the system, or if the
1762 hostname can't be resolved, <SPAN
1769 > IPv6 addresses containing colons have to be quoted by brackets.
1770 They can only be used if <SPAN
1774 been compiled with IPv6 support. If you aren't sure if your version
1775 supports it, have a look at
1778 >http://config.privoxy.org/show-status</TT
1782 > Some operating systems will prefer IPv6 to IPv4 addresses even if the
1783 system has no IPv6 connectivity which is usually not expected by the user.
1784 Some even rely on DNS to resolve localhost which mean the "localhost" address
1785 used may not actually be local.
1788 > It is therefore recommended to explicitly configure the intended IP address
1789 instead of relying on the operating system, unless there's a strong reason not to.
1792 > If you leave out the address, <SPAN
1796 IPv4 interfaces (addresses) on your machine and may become reachable from the
1797 Internet and/or the local network. Be aware that some GNU/Linux distributions
1798 modify that behaviour without updating the documentation. Check for non-standard
1799 patches if your <SPAN
1802 > version behaves differently.
1805 > If you configure <SPAN
1808 > to be reachable from the
1809 network, consider using <A
1810 HREF="config.html#ACLS"
1811 >access control lists</A
1813 (ACL's, see below), and/or a firewall.
1819 > to untrusted users, you will
1820 also want to make sure that the following actions are disabled: <TT
1823 HREF="config.html#ENABLE-EDIT-ACTIONS"
1824 >enable-edit-actions</A
1830 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1831 >enable-remote-toggle</A
1840 > Suppose you are running <SPAN
1844 a machine which has the address 192.168.0.1 on your local private network
1845 (192.168.0.0) and has another outside connection with a different address.
1846 You want it to serve requests from inside only:
1855 CLASS="PROGRAMLISTING"
1856 > listen-address 192.168.0.1:8118</PRE
1861 > Suppose you are running <SPAN
1865 IPv6-capable machine and you want it to listen on the IPv6 address
1866 of the loopback device:
1875 CLASS="PROGRAMLISTING"
1876 > listen-address [::1]:8118</PRE
1895 CLASS="VARIABLELIST"
1901 > Initial state of "toggle" status
1917 >Effect if unset:</DT
1920 > Act as if toggled on
1927 > If set to 0, <SPAN
1933 >"toggled off"</SPAN
1934 > mode, i.e. mostly behave like a normal,
1935 content-neutral proxy with both ad blocking and content filtering
1938 >enable-remote-toggle</TT
1950 NAME="ENABLE-REMOTE-TOGGLE"
1951 >7.4.3. enable-remote-toggle</A
1956 CLASS="VARIABLELIST"
1962 > Whether or not the <A
1963 HREF="http://config.privoxy.org/toggle"
1983 >Effect if unset:</DT
1986 > The web-based toggle feature is disabled.
1993 > When toggled off, <SPAN
1996 > mostly acts like a normal,
1997 content-neutral proxy, i.e. doesn't block ads or filter content.
2000 > Access to the toggle feature can <SPAN
2007 controlled separately by <SPAN
2010 > or HTTP authentication,
2011 so that everybody who can access <SPAN
2022 toggle it for all users. So this option is <SPAN
2029 for multi-user environments with untrusted users.
2032 > Note that malicious client side code (e.g Java) is also
2033 capable of using this option.
2040 documentation, this feature is disabled by default.
2043 > Note that you must have compiled <SPAN
2047 support for this feature, otherwise this option has no effect.
2058 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
2059 >7.4.4. enable-remote-http-toggle</A
2064 CLASS="VARIABLELIST"
2070 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
2086 >Effect if unset:</DT
2089 > Privoxy ignores special HTTP headers.
2096 > When toggled on, the client can change <SPAN
2100 behaviour by setting special HTTP headers. Currently the only supported
2101 special header is <SPAN
2103 >"X-Filter: No"</SPAN
2104 >, to disable filtering for
2105 the ongoing request, even if it is enabled in one of the action files.
2108 > This feature is disabled by default. If you are using
2112 > in a environment with trusted clients,
2113 you may enable this feature at your discretion. Note that malicious client
2114 side code (e.g Java) is also capable of using this feature.
2117 > This option will be removed in future releases as it has been obsoleted
2118 by the more general header taggers.
2129 NAME="ENABLE-EDIT-ACTIONS"
2130 >7.4.5. enable-edit-actions</A
2135 CLASS="VARIABLELIST"
2141 > Whether or not the <A
2142 HREF="http://config.privoxy.org/show-status"
2162 >Effect if unset:</DT
2165 > The web-based actions file editor is disabled.
2172 > Access to the editor can <SPAN
2179 controlled separately by <SPAN
2182 > or HTTP authentication,
2183 so that everybody who can access <SPAN
2194 modify its configuration for all users.
2197 > This option is <SPAN
2204 with untrusted users and as a lot of <SPAN
2208 users don't read documentation, this feature is disabled by default.
2211 > Note that malicious client side code (e.g Java) is also
2212 capable of using the actions editor and you shouldn't enable
2213 this options unless you understand the consequences and are
2214 sure your browser is configured correctly.
2217 > Note that you must have compiled <SPAN
2221 support for this feature, otherwise this option has no effect.
2232 NAME="ENFORCE-BLOCKS"
2233 >7.4.6. enforce-blocks</A
2238 CLASS="VARIABLELIST"
2244 > Whether the user is allowed to ignore blocks and can <SPAN
2246 >"go there anyway"</SPAN
2275 >Effect if unset:</DT
2278 > Blocks are not enforced.
2288 > is mainly used to block and filter
2289 requests as a service to the user, for example to block ads and other
2290 junk that clogs the pipes. <SPAN
2294 isn't perfect and sometimes innocent pages are blocked. In this situation it
2295 makes sense to allow the user to enforce the request and have
2302 > In the default configuration <SPAN
2309 > page contains a <SPAN
2311 >"go there anyway"</SPAN
2313 link to adds a special string (the force prefix) to the request URL.
2314 If that link is used, <SPAN
2318 detect the force prefix, remove it again and let the request pass.
2324 > can also be used to enforce
2325 a network policy. In that case the user obviously should not be able to
2326 bypass any blocks, and that's what the <SPAN
2328 >"enforce-blocks"</SPAN
2330 option is for. If it's enabled, <SPAN
2336 >"go there anyway"</SPAN
2337 > link. If the user adds the force
2338 prefix by hand, it will not be accepted and the circumvention attempt
2358 >7.4.7. ACLs: permit-access and deny-access</A
2361 NAME="PERMIT-ACCESS"
2369 CLASS="VARIABLELIST"
2375 > Who can access what.
2427 > are IPv4 addresses in dotted decimal notation or valid
2445 > are subnet masks in CIDR notation, i.e. integer
2446 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2447 destination part are optional.
2450 > If your system implements
2452 HREF="http://tools.ietf.org/html/rfc3493"
2466 > can be IPv6 addresses delimeted by
2473 or a service name, and
2507 any port will match. If no <TT
2518 > is given, the complete IP
2519 address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
2523 >Effect if unset:</DT
2526 > Don't restrict access further than implied by <TT
2536 > Access controls are included at the request of ISPs and systems
2537 administrators, and <SPAN
2541 >are not usually needed by individual users</I
2544 For a typical home user, it will normally suffice to ensure that
2548 > only listens on the localhost
2549 (127.0.0.1) or internal (home) network address by means of the
2551 HREF="config.html#LISTEN-ADDRESS"
2563 > Please see the warnings in the FAQ that <SPAN
2567 is not intended to be a substitute for a firewall or to encourage anyone
2568 to defer addressing basic security weaknesses.
2571 > Multiple ACL lines are OK.
2572 If any ACLs are specified, <SPAN
2576 to IP addresses that match at least one <TT
2580 and don't match any subsequent <TT
2583 > line. In other words, the
2584 last match wins, with the default being <TT
2593 > is using a forwarder (see <TT
2597 for a particular destination URL, the <TT
2603 that is examined is the address of the forwarder and <SPAN
2610 of the ultimate target. This is necessary because it may be impossible for the local
2614 > to determine the IP address of the
2615 ultimate target (that's often what gateways are used for).
2618 > You should prefer using IP addresses over DNS names, because the address lookups take
2619 time. All DNS names must resolve! You can <SPAN
2625 > use domain patterns
2629 > or partial domain names. If a DNS name resolves to multiple
2630 IP addresses, only the first one is used.
2633 > Some systems allow IPv4 clients to connect to IPv6 server sockets.
2634 Then the client's IPv4 address will be translated by the system into
2635 IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
2636 mapped IPv6 address). <SPAN
2640 and maps such ACL addresses automatically.
2643 > Denying access to particular sites by ACL may have undesired side effects
2644 if the site in question is hosted on a machine which also hosts other sites
2652 > Explicitly define the default behavior if no ACL and
2660 is OK. The absence of a <TT
2672 > destination addresses are OK:
2682 > permit-access localhost</PRE
2687 > Allow any host on the same class C subnet as www.privoxy.org access to
2688 nothing but www.example.com (or other domains hosted on the same system):
2698 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2703 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2704 with the exception that 192.168.45.73 may not access the IP address behind
2705 www.dirty-stuff.example.com:
2715 > permit-access 192.168.45.64/26
2716 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2721 > Allow access from the IPv4 network 192.0.2.0/24 even if listening on
2722 an IPv6 wild card address (not supported on all platforms):
2731 CLASS="PROGRAMLISTING"
2732 > permit-access 192.0.2.0/24</PRE
2737 > This is equivalent to the following line even if listening on an
2738 IPv4 address (not supported on all platforms):
2747 CLASS="PROGRAMLISTING"
2748 > permit-access [::ffff:192.0.2.0]/120</PRE
2762 >7.4.8. buffer-limit</A
2767 CLASS="VARIABLELIST"
2773 > Maximum size of the buffer for content filtering.
2789 >Effect if unset:</DT
2792 > Use a 4MB (4096 KB) limit.
2799 > For content filtering, i.e. the <TT
2806 > actions, it is necessary that
2810 > buffers the entire document body.
2811 This can be potentially dangerous, since a server could just keep sending
2812 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2816 > When a document buffer size reaches the <TT
2820 flushed to the client unfiltered and no further attempt to
2821 filter the rest of the document is made. Remember that there may be multiple threads
2822 running, which might require up to <TT
2832 >, unless you have enabled <SPAN
2834 >"single-threaded"</SPAN
2847 NAME="ENABLE-PROXY-AUTHENTICATION-FORWARDING"
2848 >7.4.9. enable-proxy-authentication-forwarding</A
2853 CLASS="VARIABLELIST"
2859 > Whether or not proxy authentication through <SPAN
2878 >Effect if unset:</DT
2881 > Proxy authentication headers are removed.
2888 > Privoxy itself does not support proxy authentication, but can
2889 allow clients to authenticate against Privoxy's parent proxy.
2892 > By default Privoxy (3.0.21 and later) don't do that and remove
2893 Proxy-Authorization headers in requests and Proxy-Authenticate
2894 headers in responses to make it harder for malicious sites to
2895 trick inexperienced users into providing login information.
2898 > If this option is enabled the headers are forwarded.
2901 > Enabling this option is <SPAN
2908 no parent proxy that requires authentication or if the local network between
2909 Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
2910 only required for some requests, it is recommended to use a client header filter
2911 to remove the authentication headers for requests where they aren't needed.
2922 NAME="TRUSTED-CGI-REFERER"
2923 >7.4.10. trusted-cgi-referer</A
2928 CLASS="VARIABLELIST"
2934 > A trusted website or webpage whose links can be followed to reach sensitive CGI pages
2941 >URL or URL prefix</P
2950 >Effect if unset:</DT
2953 > No external pages are considered trusted referers.
2963 > accepts configuration changes through CGI pages like
2965 HREF="config.html#CLIENT-SPECIFIC-TAG"
2969 HREF="config.html#ENABLE-REMOTE-TOGGLE"
2972 the Referer header to see if the request comes from a trusted source.
2975 > By default only the webinterface domains
2977 HREF="http://config.privoxy.org/"
2979 >config.privoxy.org</A
2987 are considered trustworthy.
2988 Requests originating from other domains are rejected to prevent
2989 third-parties from modifiying Privoxy's state by e.g. embedding
2990 images that result in CGI requests.
2993 > In some environments it may be desirable to embed links to CGI pages
2994 on external pages, for example on an Intranet homepage the Privoxy admin
3000 >"trusted-cgi-referer"</SPAN
3001 > option can be used to add that page,
3002 or the whole domain, as trusted source so the resulting requests aren't
3004 Requests are accepted if the specified trusted-cgi-refer is the prefix
3026 > Declaring pages the admin doesn't control trustworthy may allow
3027 malicious third parties to modify Privoxy's internal state against
3028 the user's wishes and without the user's knowledge.
3048 > This feature allows routing of HTTP requests through a chain of
3049 multiple proxies.</P
3051 > Forwarding can be used to chain Privoxy with a caching proxy to speed
3052 up browsing. Using a parent proxy may also be necessary if the machine
3056 > runs on has no direct Internet access.</P
3058 > Note that parent proxies can severely decrease your privacy level.
3059 For example a parent proxy could add your IP address to the request
3060 headers and if it's a caching proxy it may add the <SPAN
3064 header to revalidation requests again, even though you configured Privoxy
3065 to remove it. It may also ignore Privoxy's header time randomization and use the
3066 original values which could be used by the server as cookie replacement
3067 to track your steps between visits.</P
3069 > Also specified here are SOCKS proxies. <SPAN
3073 supports the SOCKS 4 and SOCKS 4A protocols.</P
3085 CLASS="VARIABLELIST"
3091 > To which parent HTTP proxy specific requests should be routed.
3123 HREF="actions-file.html#AF-PATTERNS"
3126 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
3145 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
3146 optionally followed by its listening port (default: 8000).
3147 Use a single dot (<TT
3152 >"no forwarding"</SPAN
3169 >Effect if unset:</DT
3172 > Don't use parent HTTP proxies.
3187 >, then requests are not
3188 forwarded to another HTTP proxy but are made directly to the web servers.
3197 numerical IPv6 address (if
3199 HREF="http://tools.ietf.org/html/rfc3493"
3203 implemented). To prevent clashes with the port delimiter, the whole IP
3204 address has to be put into brackets. On the other hand a <TT
3209 > containing an IPv6 address
3210 has to be put into angle brackets (normal brackets are reserved for
3211 regular expressions already).
3214 > Multiple lines are OK, they are checked in sequence, and the last match wins.
3221 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
3231 > forward / parent-proxy.example.org:8080
3237 > Everything goes to our example ISP's caching proxy, except for requests
3238 to that ISP's sites:
3248 > forward / caching-proxy.isp.example.net:8000
3249 forward .isp.example.net .</PRE
3254 > Parent proxy specified by an IPv6 address:
3263 CLASS="PROGRAMLISTING"
3264 > forward / [2001:DB8::1]:8000</PRE
3269 > Suppose your parent proxy doesn't support IPv6:
3278 CLASS="PROGRAMLISTING"
3279 > forward / parent-proxy.example.org:8000
3280 forward ipv6-server.example.org .
3281 forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .</PRE
3295 >7.5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</A
3298 NAME="FORWARD-SOCKS4"
3301 NAME="FORWARD-SOCKS4A"
3306 CLASS="VARIABLELIST"
3312 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
3356 HREF="actions-file.html#AF-PATTERNS"
3358 > that specifies to which
3359 requests (i.e. URLs) this forward rule shall apply. Use <TT
3378 are IP addresses in dotted decimal notation or valid DNS names
3390 >"no HTTP forwarding"</SPAN
3391 >), and the optional
3397 > parameters are TCP ports,
3398 i.e. integer values from 1 to 65535
3414 >Effect if unset:</DT
3417 > Don't use SOCKS proxies.
3424 > Multiple lines are OK, they are checked in sequence, and the last match wins.
3427 > The difference between <TT
3432 >forward-socks4a</TT
3434 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
3435 server, while in SOCKS 4 it happens locally.
3441 > the DNS resolution will happen on the remote server as well.
3446 >forward-socks5t</TT
3447 > works like vanilla <TT
3454 > additionally use Tor-specific SOCKS extensions. Currently the only supported
3455 SOCKS extension is optimistic data which can reduce the latency for the first request made
3456 on a newly created connection.
3471 numerical IPv6 address (if
3473 HREF="http://tools.ietf.org/html/rfc3493"
3477 implemented). To prevent clashes with the port delimiter, the whole IP
3478 address has to be put into brackets. On the other hand a <TT
3483 > containing an IPv6 address
3484 has to be put into angle brackets (normal brackets are reserved for
3485 regular expressions already).
3496 >, then requests are not
3497 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
3505 > From the company example.com, direct connections are made to all
3509 > domains, but everything outbound goes through
3510 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
3521 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
3522 forward .example.com .</PRE
3527 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
3537 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3542 > To chain Privoxy and Tor, both running on the same system, you would use
3553 > forward-socks5t / 127.0.0.1:9050 .</PRE
3558 > Note that if you got Tor through one of the bundles, you may
3559 have to change the port from 9050 to 9150 (or even another one).
3560 For details, please check the documentation on the
3562 HREF="https://torproject.org/"
3571 > network can't be used to
3572 reach your local network, if you need to access local servers you
3573 therefore might want to make some exceptions:
3583 > forward 192.168.*.*/ .
3585 forward 127.*.*.*/ .</PRE
3590 > Unencrypted connections to systems in these address ranges will
3591 be as (un)secure as the local network is, but the alternative is that you
3592 can't reach the local network through <SPAN
3596 at all. Of course this may actually be desired and there is no reason
3597 to make these exceptions if you aren't sure you need them.
3600 > If you also want to be able to reach servers in your local network by
3601 using their names, you will need additional exceptions that look like
3612 > forward localhost/ .</PRE
3625 NAME="ADVANCED-FORWARDING-EXAMPLES"
3626 >7.5.3. Advanced Forwarding Examples</A
3629 > If you have links to multiple ISPs that provide various special content
3630 only to their subscribers, you can configure multiple <SPAN
3634 which have connections to the respective ISPs to act as forwarders to each other, so that
3641 > users can see the internal content of all ISPs.</P
3643 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3644 isp-b.example.org. Both run <SPAN
3648 configuration can look like this:</P
3660 forward .isp-b.example.net host-b:8118</PRE
3675 forward .isp-a.example.org host-a:8118</PRE
3680 > Now, your users can set their browser's proxy to use either
3681 host-a or host-b and be able to browse the internal content
3682 of both isp-a and isp-b.</P
3684 > If you intend to chain <SPAN
3691 > locally, then chaining as
3694 >browser -> squid -> privoxy</TT
3695 > is the recommended way.</P
3697 > Assuming that <SPAN
3704 run on the same box, your <SPAN
3707 > configuration could then look like this:</P
3716 > # Define Privoxy as parent proxy (without ICP)
3717 cache_peer 127.0.0.1 parent 8118 7 no-query
3719 # Define ACL for protocol FTP
3722 # Do not forward FTP requests to Privoxy
3723 always_direct allow ftp
3725 # Forward all the rest to Privoxy
3726 never_direct allow all</PRE
3731 > You would then need to change your browser's proxy settings to <SPAN
3734 >'s address and port.
3735 Squid normally uses port 3128. If unsure consult <TT
3743 > You could just as well decide to only forward requests you suspect
3744 of leading to Windows executables through a virus-scanning parent proxy,
3747 >antivir.example.com</TT
3758 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3768 NAME="FORWARDED-CONNECT-RETRIES"
3769 >7.5.4. forwarded-connect-retries</A
3774 CLASS="VARIABLELIST"
3780 > How often Privoxy retries if a forwarded connection request fails.
3790 >Number of retries.</I
3808 >Effect if unset:</DT
3811 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3821 >forwarded-connect-retries</I
3823 > is mainly interesting
3824 for socks4a connections, where <SPAN
3827 > can't detect why the connections failed.
3828 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3829 but it might also have failed because the server doesn't exist or isn't reachable. In this
3830 case the retry will just delay the appearance of Privoxy's error message.
3833 > Note that in the context of this option, <SPAN
3835 >"forwarded connections"</SPAN
3836 > includes all connections
3837 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3840 > Only use this option, if you are getting lots of forwarding-related error messages
3841 that go away when you try again manually. Start with a small value and check Privoxy's
3842 logfile from time to time, to see how many retries are usually needed.
3849 > forwarded-connect-retries 1
3862 >7.6. Miscellaneous</A
3869 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3870 >7.6.1. accept-intercepted-requests</A
3875 CLASS="VARIABLELIST"
3881 > Whether intercepted requests should be treated as valid.
3909 >Effect if unset:</DT
3912 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3919 > If you don't trust your clients and want to force them
3924 option and configure your packet filter to redirect outgoing
3925 HTTP connections into <SPAN
3931 > Note that intercepting encrypted connections (HTTPS) isn't supported.
3934 > Make sure that <SPAN
3938 aren't redirected as well. Additionally take care that
3942 > can't intentionally connect
3943 to itself, otherwise you could run into redirection loops if
3947 > listening port is reachable
3948 by the outside or an attacker has access to the pages you visit.
3951 > If you are running Privoxy as intercepting proxy without being
3952 able to intercept all client requests you may want to adjust
3953 the CGI templates to make sure they don't reference content from
3961 > accept-intercepted-requests 1
3972 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3973 >7.6.2. allow-cgi-request-crunching</A
3978 CLASS="VARIABLELIST"
3984 > Whether requests to <SPAN
3987 > CGI pages can be blocked or redirected.
4015 >Effect if unset:</DT
4021 > ignores block and redirect actions for its CGI pages.
4031 > ignores block or redirect actions
4032 for its CGI pages. Intercepting these requests can be useful in multi-user
4033 setups to implement fine-grained access control, but it can also render the complete
4034 web interface useless and make debugging problems painful if done without care.
4037 > Don't enable this option unless you're sure that you really need it.
4044 > allow-cgi-request-crunching 1
4055 NAME="SPLIT-LARGE-FORMS"
4056 >7.6.3. split-large-forms</A
4061 CLASS="VARIABLELIST"
4067 > Whether the CGI interface should stay compatible with broken HTTP clients.
4095 >Effect if unset:</DT
4098 > The CGI form generate long GET URLs.
4108 > CGI forms can lead to
4109 rather long URLs. This isn't a problem as far as the HTTP
4110 standard is concerned, but it can confuse clients with arbitrary
4111 URL length limitations.
4114 > Enabling split-large-forms causes <SPAN
4118 to divide big forms into smaller ones to keep the URL length down.
4119 It makes editing a lot less convenient and you can no longer
4120 submit all changes at once, but at least it works around this
4124 > If you don't notice any editing problems, there is no reason
4125 to enable this option, but if one of the submit buttons appears
4126 to be broken, you should give it a try.
4133 > split-large-forms 1
4144 NAME="KEEP-ALIVE-TIMEOUT"
4145 >7.6.4. keep-alive-timeout</A
4150 CLASS="VARIABLELIST"
4156 > Number of seconds after which an open connection will no longer be reused.
4166 >Time in seconds.</I
4178 >Effect if unset:</DT
4181 > Connections are not kept alive.
4188 > This option allows clients to keep the connection to <SPAN
4192 alive. If the server supports it, <SPAN
4196 the connection to the server alive as well. Under certain
4197 circumstances this may result in speed-ups.
4203 > will close the connection to the server if
4204 the client connection gets closed, or if the specified timeout
4205 has been reached without a new request coming in. This behaviour
4206 can be changed with the <A
4207 HREF="#CONNECTION-SHARING"
4209 >connection-sharing</A
4213 > This option has no effect if <SPAN
4217 has been compiled without keep-alive support.
4220 > Note that a timeout of five seconds as used in the default
4221 configuration file significantly decreases the number of
4222 connections that will be reused. The value is used because
4223 some browsers limit the number of connections they open to
4224 a single host and apply the same limit to proxies. This can
4225 result in a single website <SPAN
4229 connections the browser allows, which means connections to
4230 other websites can't be opened until the connections currently
4234 > Several users have reported this as a Privoxy bug, so the
4235 default value has been reduced. Consider increasing it to
4236 300 seconds or even more if you think your browser can handle
4237 it. If your browser appears to be hanging, it probably can't.
4244 > keep-alive-timeout 300
4255 NAME="TOLERATE-PIPELINING"
4256 >7.6.5. tolerate-pipelining</A
4261 CLASS="VARIABLELIST"
4267 > Whether or not pipelined requests should be served.
4289 >Effect if unset:</DT
4292 > If Privoxy receives more than one request at once, it terminates the
4293 client connection after serving the first one.
4303 > currently doesn't pipeline outgoing requests,
4304 thus allowing pipelining on the client connection is not
4305 guaranteed to improve the performance.
4311 > tries to discourage clients from pipelining
4312 by discarding aggressively pipelined requests, which forces the
4313 client to resend them through a new connection.
4316 > This option lets <SPAN
4319 > tolerate pipelining. Whether or not
4320 that improves performance mainly depends on the client configuration.
4323 > If you are seeing problems with pages not properly loading,
4324 disabling this option could work around the problem.
4331 > tolerate-pipelining 1
4342 NAME="DEFAULT-SERVER-TIMEOUT"
4343 >7.6.6. default-server-timeout</A
4348 CLASS="VARIABLELIST"
4354 > Assumed server-side keep-alive timeout if not specified by the server.
4364 >Time in seconds.</I
4376 >Effect if unset:</DT
4379 > Connections for which the server didn't specify the keep-alive
4380 timeout are not reused.
4387 > Enabling this option significantly increases the number of connections
4388 that are reused, provided the <A
4389 HREF="#KEEP-ALIVE-TIMEOUT"
4391 >keep-alive-timeout</A
4396 > While it also increases the number of connections problems
4400 > tries to reuse a connection that already has
4401 been closed on the server side, or is closed while <SPAN
4405 is trying to reuse it, this should only be a problem if it
4406 happens for the first request sent by the client. If it happens
4407 for requests on reused client connections, <SPAN
4411 close the connection and the client is supposed to retry the
4412 request without bothering the user.
4415 > Enabling this option is therefore only recommended if the
4417 HREF="#CONNECTION-SHARING"
4419 >connection-sharing</A
4424 > It is an error to specify a value larger than the <A
4425 HREF="#KEEP-ALIVE-TIMEOUT"
4427 >keep-alive-timeout</A
4431 > This option has no effect if <SPAN
4435 has been compiled without keep-alive support.
4442 > default-server-timeout 60
4453 NAME="CONNECTION-SHARING"
4454 >7.6.7. connection-sharing</A
4459 CLASS="VARIABLELIST"
4465 > Whether or not outgoing connections that have been kept alive
4466 should be shared between different incoming connections.
4488 >Effect if unset:</DT
4491 > Connections are not shared.
4498 > This option has no effect if <SPAN
4502 has been compiled without keep-alive support, or if it's disabled.
4509 > Note that reusing connections doesn't necessary cause speedups.
4510 There are also a few privacy implications you should be aware of.
4513 > If this option is effective, outgoing connections are shared between
4514 clients (if there are more than one) and closing the browser that initiated
4515 the outgoing connection does no longer affect the connection between <SPAN
4519 and the server unless the client's request hasn't been completed yet.
4522 > If the outgoing connection is idle, it will not be closed until either
4526 > or the server's timeout is reached.
4527 While it's open, the server knows that the system running <SPAN
4534 > If there are more than one client (maybe even belonging to multiple users),
4535 they will be able to reuse each others connections. This is potentially
4536 dangerous in case of authentication schemes like NTLM where only the
4537 connection is authenticated, instead of requiring authentication for
4541 > If there is only a single client, and if said client can keep connections
4542 alive on its own, enabling this option has next to no effect. If the client
4543 doesn't support connection keep-alive, enabling this option may make sense
4547 > to keep outgoing connections alive even if the client
4548 itself doesn't support it.
4551 > You should also be aware that enabling this option increases the likelihood
4552 of getting the "No server or forwarder data" error message, especially if you
4553 are using a slow connection to the Internet.
4556 > This option should only be used by experienced users who
4557 understand the risks and can weight them against the benefits.
4564 > connection-sharing 1
4575 NAME="SOCKET-TIMEOUT"
4576 >7.6.8. socket-timeout</A
4581 CLASS="VARIABLELIST"
4587 > Number of seconds after which a socket times out if
4588 no data is received.
4598 >Time in seconds.</I
4610 >Effect if unset:</DT
4613 > A default value of 300 seconds is used.
4620 > The default is quite high and you probably want to reduce it.
4621 If you aren't using an occasionally slow proxy like Tor, reducing
4622 it to a few seconds should be fine.
4629 > socket-timeout 300
4640 NAME="MAX-CLIENT-CONNECTIONS"
4641 >7.6.9. max-client-connections</A
4646 CLASS="VARIABLELIST"
4652 > Maximum number of client connections that will be served.
4662 >Positive number.</I
4674 >Effect if unset:</DT
4677 > Connections are served until a resource limit is reached.
4687 > creates one thread (or process) for every incoming client
4688 connection that isn't rejected based on the access control settings.
4691 > If the system is powerful enough, <SPAN
4694 > can theoretically deal with
4695 several hundred (or thousand) connections at the same time, but some
4696 operating systems enforce resource limits by shutting down offending
4697 processes and their default limits may be below the ones <SPAN
4701 require under heavy load.
4707 > to enforce a connection limit below the thread
4708 or process limit used by the operating system makes sure this doesn't
4709 happen. Simply increasing the operating system's limit would work too,
4713 > isn't the only application running on the system,
4714 you may actually want to limit the resources used by <SPAN
4723 > is only used by a single trusted user, limiting the
4724 number of client connections is probably unnecessary. If there
4725 are multiple possibly untrusted users you probably still want to
4726 additionally use a packet filter to limit the maximal number of
4727 incoming connections per client. Otherwise a malicious user could
4728 intentionally create a high number of connections to prevent other
4729 users from using <SPAN
4735 > Obviously using this option only makes sense if you choose a limit
4736 below the one enforced by the operating system.
4739 > One most POSIX-compliant systems <SPAN
4742 > can't properly deal with
4743 more than FD_SETSIZE file descriptors at the same time and has to reject
4744 connections if the limit is reached. This will likely change in a
4745 future version, but currently this limit can't be increased without
4749 > with a different FD_SETSIZE limit.
4756 > max-client-connections 256
4767 NAME="LISTEN-BACKLOG"
4768 >7.6.10. listen-backlog</A
4773 CLASS="VARIABLELIST"
4779 > Connection queue length requested from the operating system.
4801 >Effect if unset:</DT
4804 > A connection queue length of 128 is requested from the operating system.
4811 > Under high load incoming connection may queue up before Privoxy
4812 gets around to serve them. The queue length is limitted by the
4813 operating system. Once the queue is full, additional connections
4814 are dropped before Privoxy can accept and serve them.
4817 > Increasing the queue length allows Privoxy to accept more
4818 incomming connections that arrive roughly at the same time.
4821 > Note that Privoxy can only request a certain queue length,
4822 whether or not the requested length is actually used depends
4823 on the operating system which may use a different length instead.
4826 > On many operating systems a limit of -1 can be specified to
4827 instruct the operating system to use the maximum queue length
4828 allowed. Check the listen man page to see if your platform allows this.
4831 > On some platforms you can use "netstat -Lan -p tcp" to see the effective
4835 > Effectively using a value above 128 usually requires changing
4836 the system configuration as well. On FreeBSD-based system the
4837 limit is controlled by the kern.ipc.soacceptqueue sysctl.
4844 > listen-backlog 4096
4855 NAME="ENABLE-ACCEPT-FILTER"
4856 >7.6.11. enable-accept-filter</A
4861 CLASS="VARIABLELIST"
4867 > Whether or not Privoxy should use an accept filter
4889 >Effect if unset:</DT
4892 > No accept filter is enabled.
4899 > Accept filters reduce the number of context switches by not
4900 passing sockets for new connections to Privoxy until a complete
4901 HTTP request is available.
4904 > As a result, Privoxy can process the whole request right away
4905 without having to wait for additional data first.
4908 > For this option to work, Privoxy has to be compiled with
4909 FEATURE_ACCEPT_FILTER and the operating system has to support
4910 it (which may require loading a kernel module).
4913 > Currently accept filters are only supported on FreeBSD-based
4916 HREF="https://www.freebsd.org/cgi/man.cgi?query=accf_http"
4921 to learn how to enable the support in the operating system.
4928 > enable-accept-filter 1
4939 NAME="HANDLE-AS-EMPTY-DOC-RETURNS-OK"
4940 >7.6.12. handle-as-empty-doc-returns-ok</A
4945 CLASS="VARIABLELIST"
4951 > The status code Privoxy returns for pages blocked with
4956 HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
4958 >+handle-as-empty-document</A
4982 >Effect if unset:</DT
4985 > Privoxy returns a status 403(forbidden) for all blocked pages.
4992 > Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
4993 and a status 403(Forbidden) for all other blocked pages.
5000 > This directive was added as a work-around for Firefox bug 492459:
5003 >"Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy."</SPAN
5006 HREF="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
5008 >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</A
5010 the bug has been fixed for quite some time, but this directive is also useful
5011 to make it harder for websites to detect whether or not resources are being
5023 NAME="ENABLE-COMPRESSION"
5024 >7.6.13. enable-compression</A
5029 CLASS="VARIABLELIST"
5035 > Whether or not buffered content is compressed before delivery.
5057 >Effect if unset:</DT
5060 > Privoxy does not compress buffered content.
5067 > Privoxy compresses buffered content before delivering it to the client,
5068 provided the client supports it.
5075 > This directive is only supported if Privoxy has been compiled with
5076 FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
5079 > Compressing buffered content is mainly useful if Privoxy and the
5080 client are running on different systems. If they are running on the
5081 same system, enabling compression is likely to slow things down.
5082 If you didn't measure otherwise, you should assume that it does
5083 and keep this option disabled.
5086 > Privoxy will not compress buffered content below a certain length.
5097 NAME="COMPRESSION-LEVEL"
5098 >7.6.14. compression-level</A
5103 CLASS="VARIABLELIST"
5109 > The compression level that is passed to the zlib library when compressing buffered content.
5119 >Positive number ranging from 0 to 9.</I
5134 > Compressing the data more takes usually longer than compressing
5135 it less or not compressing it at all. Which level is best depends
5136 on the connection between Privoxy and the client. If you can't
5137 be bothered to benchmark it for yourself, you should stick with
5138 the default and keep compression disabled.
5141 > If compression is disabled, the compression level is irrelevant.
5155 > # Best speed (compared to the other levels)
5159 # No compression. Only useful for testing as the added header
5160 # slightly increases the amount of data that has to be sent.
5161 # If your benchmark shows that using this compression level
5162 # is superior to using no compression at all, the benchmark
5163 # is likely to be flawed.
5178 NAME="CLIENT-HEADER-ORDER"
5179 >7.6.15. client-header-order</A
5184 CLASS="VARIABLELIST"
5190 > The order in which client headers are sorted before forwarding them.
5200 >Client header names delimited by spaces or tabs</I
5218 > leaves the client headers in the order they
5219 were sent by the client. Headers are modified in-place, new headers
5220 are added at the end of the already existing headers.
5223 > The header order can be used to fingerprint client requests
5224 independently of other headers like the User-Agent.
5227 > This directive allows to sort the headers differently to better
5228 mimic a different User-Agent. Client headers will be emitted
5229 in the order given, headers whose name isn't explicitly specified
5230 are added at the end.
5233 > Note that sorting headers in an uncommon way will make fingerprinting
5234 actually easier. Encrypted headers are not affected by this directive.
5245 NAME="CLIENT-SPECIFIC-TAG"
5246 >7.6.16. client-specific-tag</A
5251 CLASS="VARIABLELIST"
5257 > The name of a tag that will always be set for clients that
5258 requested it through the webinterface.
5268 >Tag name followed by a description that will be shown in the webinterface</I
5301 > This is an experimental feature. The syntax is likely to change
5309 > Client-specific tags allow Privoxy admins to create different
5310 profiles and let the users chose which one they want without
5311 impacting other users.
5314 > One use case is allowing users to circumvent certain blocks
5315 without having to allow them to circumvent all blocks.
5316 This is not possible with the
5318 HREF="config.html#ENABLE-REMOTE-TOGGLE"
5319 >enable-remote-toggle feature</A
5321 because it would bluntly disable all blocks for all users and also affect
5322 other actions like filters.
5323 It also is set globally which renders it useless in most multi-user setups.
5326 > After a client-specific tag has been defined with the client-specific-tag
5327 directive, action sections can be activated based on the tag by using a
5329 HREF="actions-file.html#CLIENT-TAG-PATTERN"
5333 The CLIENT-TAG pattern is evaluated at the same priority
5334 as URL patterns, as a result the last matching pattern wins.
5335 Tags that are created based on client or server headers are evaluated
5336 later on and can overrule CLIENT-TAG and URL patterns!
5339 > The tag is set for all requests that come from clients that requested
5341 Note that "clients" are differentiated by IP address,
5342 if the IP address changes the tag has to be requested again.
5345 > Clients can request tags to be set by using the CGI interface <A
5346 HREF="http://config.privoxy.org/client-tags"
5348 >http://config.privoxy.org/client-tags</A
5350 The specific tag description is only used on the web page and should
5351 be phrased in away that the user understand the effect of the tag.
5365 > # Define a couple of tags, the described effect requires action sections
5366 # that are enabled based on CLIENT-TAG patterns.
5367 client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
5368 disable-content-filters Disable content-filters but do not affect other actions
5382 NAME="CLIENT-TAG-LIFETIME"
5383 >7.6.17. client-tag-lifetime</A
5388 CLASS="VARIABLELIST"
5394 > How long a temporarily enabled tag remains enabled.
5404 >Time in seconds.</I
5437 > This is an experimental feature. The syntax is likely to change
5445 > In case of some tags users may not want to enable them permanently,
5446 but only for a short amount of time, for example to circumvent a block
5447 that is the result of an overly-broad URL pattern.
5450 > The CGI interface <A
5451 HREF="http://config.privoxy.org/client-tags"
5453 >http://config.privoxy.org/client-tags</A
5455 therefore provides a "enable this tag temporarily" option.
5456 If it is used, the tag will be set until the client-tag-lifetime
5471 > # Increase the time to life for temporarily enabled tags to 3 minutes
5472 client-tag-lifetime 180
5486 NAME="TRUST-X-FORWARDED-FOR"
5487 >7.6.18. trust-x-forwarded-for</A
5492 CLASS="VARIABLELIST"
5498 > Whether or not Privoxy should use IP addresses specified with the X-Forwarded-For header
5541 > This is an experimental feature. The syntax is likely to change
5549 > If clients reach Privoxy through another proxy, for example a load
5550 balancer, Privoxy can't tell the client's IP address from the connection.
5551 If multiple clients use the same proxy, they will share the same
5552 client tag settings which is usually not desired.
5555 > This option lets Privoxy use the X-Forwarded-For header value as
5556 client IP address. If the proxy sets the header, multiple clients
5557 using the same proxy do not share the same client tag settings.
5560 > This option should only be enabled if Privoxy can only be reached
5561 through a proxy and if the proxy can be trusted to set the header
5562 correctly. It is recommended that ACL are used to make sure only
5563 trusted systems can reach Privoxy.
5566 > If access to Privoxy isn't limited to trusted systems, this option
5567 would allow malicious clients to change the client tags for other
5568 clients or increase Privoxy's memory requirements by registering
5569 lots of client tag settings for clients that don't exist.
5583 > # Allow systems that can reach Privoxy to provide the client
5584 # IP address with a X-Forwarded-For header.
5585 trust-x-forwarded-for 1
5599 NAME="RECEIVE-BUFFER-SIZE"
5600 >7.6.19. receive-buffer-size</A
5605 CLASS="VARIABLELIST"
5611 > The size of the buffer Privoxy uses to receive data from the server.
5636 > Increasing the receive-buffer-size increases Privoxy's memory usage but
5637 can lower the number of context switches and thereby reduce the
5638 cpu usage and potentially increase the throughput.
5641 > This is mostly relevant for fast network connections and
5642 large downloads that don't require filtering.
5645 > Reducing the buffer size reduces the amount of memory Privoxy
5646 needs to handle the request but increases the number of systemcalls
5647 and may reduce the throughput.
5650 > A dtrace command like:
5653 >"sudo dtrace -n 'syscall::read:return /execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'"</SPAN
5655 can be used to properly tune the receive-buffer-size.
5656 On systems without dtrace, strace or truss may be used as
5657 less convenient alternatives.
5660 > If the buffer is too large it will increase Privoxy's memory
5661 footprint without any benefit. As the memory is (currently)
5662 cleared before using it, a buffer that is too large can
5663 actually reduce the throughput.
5677 > # Increase the receive buffer size
5678 receive-buffer-size 32768
5694 >7.7. Windows GUI Options</A
5700 > has a number of options specific to the
5701 Windows GUI interface:</P
5703 NAME="ACTIVITY-ANIMATION"
5708 >"activity-animation"</SPAN
5713 > icon will animate when
5717 > is active. To turn off, set to 0.</P
5722 CLASS="LITERALLAYOUT"
5727 >activity-animation 1</I
5730 </P
5740 >"log-messages"</SPAN
5745 > copies log messages to the console
5747 The log detail depends on the <A
5748 HREF="config.html#DEBUG"
5755 CLASS="LITERALLAYOUT"
5763 </P
5768 NAME="LOG-BUFFER-SIZE"
5773 >"log-buffer-size"</SPAN
5774 > is set to 1, the size of the log buffer,
5775 i.e. the amount of memory used for the log messages displayed in the
5776 console window, will be limited to <SPAN
5778 >"log-max-lines"</SPAN
5781 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
5782 eat up all your memory!</P
5787 CLASS="LITERALLAYOUT"
5792 >log-buffer-size 1</I
5795 </P
5800 NAME="LOG-MAX-LINES"
5805 >log-max-lines</SPAN
5806 > is the maximum number of lines held
5807 in the log buffer. See above.</P
5812 CLASS="LITERALLAYOUT"
5817 >log-max-lines 200</I
5820 </P
5825 NAME="LOG-HIGHLIGHT-MESSAGES"
5830 >"log-highlight-messages"</SPAN
5835 > will highlight portions of the log
5836 messages with a bold-faced font:</P
5841 CLASS="LITERALLAYOUT"
5846 >log-highlight-messages 1</I
5849 </P
5854 NAME="LOG-FONT-NAME"
5857 > The font used in the console window:</P
5862 CLASS="LITERALLAYOUT"
5867 >log-font-name Comic Sans MS</I
5870 </P
5875 NAME="LOG-FONT-SIZE"
5878 > Font size used in the console window:</P
5883 CLASS="LITERALLAYOUT"
5891 </P
5896 NAME="SHOW-ON-TASK-BAR"
5901 >"show-on-task-bar"</SPAN
5902 > controls whether or not
5906 > will appear as a button on the Task bar
5912 CLASS="LITERALLAYOUT"
5917 >show-on-task-bar 0</I
5920 </P
5925 NAME="CLOSE-BUTTON-MINIMIZES"
5930 >"close-button-minimizes"</SPAN
5931 > is set to 1, the Windows close
5932 button will minimize <SPAN
5935 > instead of closing
5936 the program (close with the exit option on the File menu).</P
5941 CLASS="LITERALLAYOUT"
5946 >close-button-minimizes 1</I
5949 </P
5959 >"hide-console"</SPAN
5960 > option is specific to the MS-Win console
5964 >. If this option is used,
5968 > will disconnect from and hide the
5974 CLASS="LITERALLAYOUT"
5982 </P
5993 SUMMARY="Footer navigation table"
6004 HREF="configuration.html"
6022 HREF="actions-file.html"
6032 >Privoxy Configuration</TD