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.11 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.11 User Manual</TH
53 HREF="configuration.html"
67 HREF="actions-file.html"
82 >7. The Main Configuration File</A
85 > Again, the main configuration file is named <TT
89 Linux/Unix/BSD and OS/2, and <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).</P
147 >7.1. Local Set-up Documentation</A
150 > If you intend to operate <SPAN
154 than just yourself, it might be a good idea to let them know how to reach
155 you, what you block and why you do that, your policies, etc.
163 >7.1.1. user-manual</A
174 > Location of the <SPAN
184 >A fully qualified URI</P
199 >Effect if unset:</DT
203 HREF="http://www.privoxy.org/user-manual/"
205 >http://www.privoxy.org/<TT
212 will be used, where <TT
227 > The User Manual URI is the single best source of information on
231 >, and is used for help links from some
232 of the internal CGI pages. The manual itself is normally packaged with the
233 binary distributions, so you probably want to set this to a locally
240 > The best all purpose solution is simply to put the full local
259 >  user-manual  /usr/share/doc/privoxy/user-manual</PRE
266 > The User Manual is then available to anyone with access to
270 >, by following the built-in URL:
273 >http://config.privoxy.org/user-manual/</TT
275 (or the shortcut: <TT
277 >http://p.p/user-manual/</TT
281 > If the documentation is not on the local system, it can be accessed
282 from a remote server, as:
293 >  user-manual  http://example.com/privoxy/user-manual/</PRE
318 > If set, this option should be <SPAN
322 >the first option in the config
325 >, because it is used while the config file is being read
341 NAME="TRUST-INFO-URL"
342 >7.1.2. trust-info-url</A
353 > A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
366 >Two example URLs are provided</P
369 >Effect if unset:</DT
372 > No links are displayed on the "untrusted" error page.
379 > The value of this option only matters if the experimental trust mechanism has been
381 HREF="config.html#TRUSTFILE"
392 > If you use the trust mechanism, it is a good idea to write up some on-line
393 documentation about your trust policy and to specify the URL(s) here.
394 Use multiple times for multiple URLs.
397 > The URL(s) should be added to the trustfile as well, so users don't end up
398 locked out from the information on why they were locked out in the first place!
410 >7.1.3. admin-address</A
421 > An email address to reach the <SPAN
446 >Effect if unset:</DT
449 > No email address is displayed on error pages and the CGI user interface.
463 are unset, the whole "Local Privoxy Support" box on all generated pages will
475 NAME="PROXY-INFO-URL"
476 >7.1.4. proxy-info-url</A
487 > A URL to documentation about the local <SPAN
491 configuration or policies.
513 >Effect if unset:</DT
516 > No link to local documentation is displayed on error pages and the CGI user interface.
530 are unset, the whole "Local Privoxy Support" box on all generated pages will
534 > This URL shouldn't be blocked ;-)
547 >7.2. Configuration and Log File Locations</A
553 > can (and normally does) use a number of
554 other files for additional configuration, help and logging.
555 This section of the configuration file tells <SPAN
559 where to find those other files. </P
561 > The user running <SPAN
565 permission for all configuration files, and write permission to any files
566 that would be modified, such as log files and actions files.</P
584 >The directory where the other configuration files are located.</P
596 >/etc/privoxy (Unix) <SPAN
605 > installation dir (Windows) </P
608 >Effect if unset:</DT
652 >An alternative directory where the templates are loaded from.</P
667 >Effect if unset:</DT
670 >The templates are assumed to be located in confdir/template.</P
679 > original templates are usually
680 overwritten with each update. Use this option to relocate customized
681 templates that should be kept. As template variables might change
682 between updates, you shouldn't expect templates to work with
686 > releases other than the one
687 they were part of, though.
710 > The directory where all logging takes place
727 >/var/log/privoxy (Unix) <SPAN
736 > installation dir (Windows) </P
739 >Effect if unset:</DT
772 >7.2.4. actionsfile</A
775 NAME="DEFAULT.ACTION"
778 NAME="STANDARD.ACTION"
793 HREF="actions-file.html"
802 >Complete file name, relative to <TT
818 CLASS="LITERALLAYOUT"
819 > default.action # Main actions file</P
826 CLASS="LITERALLAYOUT"
827 > user.action # User customizations</P
837 >Effect if unset:</DT
840 > No actions are taken at all. More or less neutral proxying.
850 > lines are permitted, and are in fact recommended!
854 The default values are <TT
861 > actions file maintained by the developers, and
865 >, where you can make your personal additions.
869 Actions files contain all the per site and per URL configuration for
870 ad blocking, cookie management, privacy considerations, etc.
871 There is no point in using <SPAN
875 least one actions file.
878 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
882 extension has to be specified. The syntax change was necessary to be consistent
883 with the other file options and to allow previously forbidden characters.
895 >7.2.5. filterfile</A
898 NAME="DEFAULT.FILTER"
910 HREF="filter-file.html"
919 >File name, relative to <TT
928 >default.filter (Unix) <SPAN
934 > default.filter.txt (Windows)</P
937 >Effect if unset:</DT
940 > No textual content filtering takes place, i.e. all
944 HREF="actions-file.html#FILTER"
953 actions in the actions files are turned neutral.
963 > lines are permitted.
967 HREF="filter-file.html"
969 > contain content modification
971 HREF="appendix.html#REGEX"
972 >regular expressions</A
973 >. These rules permit
974 powerful changes on the content of Web pages, and optionally the headers
975 as well, e.g., you could try to disable your favorite JavaScript annoyances,
976 re-write the actual displayed text, or just have some fun
977 playing buzzword bingo with web pages.
984 HREF="actions-file.html#FILTER"
993 actions rely on the relevant filter (<TT
999 to be defined in a filter file!
1002 > A pre-defined filter file called <TT
1006 a number of useful filters for common problems is included in the distribution.
1007 See the section on the <TT
1010 HREF="actions-file.html#FILTER"
1017 > It is recommended to place any locally adapted filters into a separate
1038 CLASS="VARIABLELIST"
1044 > The log file to use
1051 >File name, relative to <TT
1064 >Unset (commented out)</I
1066 >. When activated: logfile (Unix) <SPAN
1072 > privoxy.log (Windows).</P
1075 >Effect if unset:</DT
1078 > No logfile is written.
1085 > The logfile is where all logging and error messages are written. The level
1086 of detail and number of messages are set with the <TT
1090 option (see below). The logfile can be useful for tracking down a problem with
1094 > (e.g., it's not blocking an ad you
1095 think it should block) and it can help you to monitor what your browser
1099 > Depending on the debug options below, the logfile may be a privacy risk
1100 if third parties can get access to it. As most users will never look
1104 > 3.0.7 and later only log fatal
1108 > For most troubleshooting purposes, you will have to change that,
1109 please refer to the debugging section for details.
1112 > Your logfile will grow indefinitely, and you will probably want to
1113 periodically remove it. On Unix systems, you can do this with a cron job
1117 >). For Red Hat based Linux distributions, a
1121 > script has been included.
1124 > Any log files must be writable by whatever user <SPAN
1128 is being run as (on Unix, default user id is <SPAN
1143 >7.2.7. trustfile</A
1148 CLASS="VARIABLELIST"
1154 > The name of the trust file to use
1161 >File name, relative to <TT
1174 >Unset (commented out)</I
1176 >. When activated: trust (Unix) <SPAN
1182 > trust.txt (Windows)</P
1185 >Effect if unset:</DT
1188 > The entire trust mechanism is disabled.
1195 > The trust mechanism is an experimental feature for building white-lists and should
1196 be used with care. It is <SPAN
1202 > recommended for the casual user.
1205 > If you specify a trust file, <SPAN
1209 access to sites that are specified in the trustfile. Sites can be listed
1216 > character limits access to this site
1217 only (and any sub-paths within this site), e.g.
1220 >~www.example.com</TT
1224 >~www.example.com/features/news.html</TT
1228 > Or, you can designate sites as <SPAN
1232 >trusted referrers</I
1235 prepending the name with a <TT
1238 > character. The effect is that
1239 access to untrusted sites will be granted -- but only if a link from this
1240 trusted referrer was used to get there. The link target will then be added
1244 > so that future, direct accesses will be
1245 granted. Sites added via this mechanism do not become trusted referrers
1246 themselves (i.e. they are added with a <TT
1250 There is a limit of 512 such entries, after which new entries will not be
1254 > If you use the <TT
1257 > operator in the trust file, it may grow
1258 considerably over time.
1261 > It is recommended that <SPAN
1267 >--disable-force</TT
1270 >--disable-toggle</TT
1274 > --disable-editor</TT
1275 > options, if this feature is to be
1279 > Possible applications include limiting Internet access for children.
1295 > These options are mainly useful when tracing a problem.
1296 Note that you might also want to invoke
1304 command line option when debugging.
1317 CLASS="VARIABLELIST"
1323 > Key values that determine what information gets logged.
1336 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1339 >Effect if unset:</DT
1342 > Default value is used (see above).
1349 > The available debug levels are:
1359 CLASS="PROGRAMLISTING"
1360 > debug 1 # Log the destination for each request <SPAN
1363 > let through. See also debug 1024.
1364 debug 2 # show each connection status
1365 debug 4 # show I/O status
1366 debug 8 # show header parsing
1367 debug 16 # log all data written to the network into the logfile
1368 debug 32 # debug force feature
1369 debug 64 # debug regular expression filters
1370 debug 128 # debug redirects
1371 debug 256 # debug GIF de-animation
1372 debug 512 # Common Log Format
1373 debug 1024 # Log the destination for requests <SPAN
1376 > didn't let through, and the reason why.
1377 debug 2048 # CGI user interface
1378 debug 4096 # Startup banner and warnings.
1379 debug 8192 # Non-fatal errors</PRE
1386 > To select multiple debug levels, you can either add them or use
1393 > A debug level of 1 is informative because it will show you each request
1394 as it happens. <SPAN
1398 >1, 4096 and 8192 are recommended</I
1401 so that you will notice when things go wrong. The other levels are
1402 probably only of interest if you are hunting down a specific problem.
1403 They can produce a hell of an output (especially 16).
1410 > used to ship with the debug levels recommended above enabled by
1411 default, but due to privacy concerns 3.0.7 and later are configured to
1412 only log fatal errors.
1415 > If you are used to the more verbose settings, simply enable the debug lines
1419 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1429 > and not enable anything else.
1435 > has a hard-coded limit for the
1436 length of log messages. If it's reached, messages are logged truncated
1437 and marked with <SPAN
1439 >"... [too long, truncated]"</SPAN
1443 > Please don't file any support requests without trying to reproduce
1444 the problem with increased debug level first. Once you read the log
1445 messages, you may even be able to solve the problem on your own.
1456 NAME="SINGLE-THREADED"
1457 >7.3.2. single-threaded</A
1462 CLASS="VARIABLELIST"
1468 > Whether to run only one server thread.
1496 >Effect if unset:</DT
1499 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1500 serve multiple requests simultaneously.
1507 > This option is only there for debugging purposes.
1512 >It will drastically reduce performance.</I
1531 CLASS="VARIABLELIST"
1537 > The hostname shown on the CGI pages.
1559 >Effect if unset:</DT
1562 > The hostname provided by the operating system is used.
1569 > On some misconfigured systems resolving the hostname fails or
1570 takes too much time and slows Privoxy down. Setting a fixed hostname
1571 works around the problem.
1574 > In other circumstances it might be desirable to show a hostname
1575 other than the one returned by the operating system. For example
1576 if the system has several different hostnames and you don't want
1577 to use the first one.
1580 > Note that Privoxy does not validate the specified hostname value.
1592 NAME="ACCESS-CONTROL"
1593 >7.4. Access Control and Security</A
1596 > This section of the config file controls the security-relevant aspects
1607 NAME="LISTEN-ADDRESS"
1608 >7.4.1. listen-address</A
1613 CLASS="VARIABLELIST"
1619 > The IP address and TCP port on which <SPAN
1623 listen for client requests.
1649 >Effect if unset:</DT
1652 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1653 home users who run <SPAN
1656 > on the same machine as
1664 > You will need to configure your browser(s) to this proxy address and port.
1667 > If you already have another service running on port 8118, or if you want to
1668 serve requests from other machines (e.g. on your local network) as well, you
1669 will need to override the default.
1672 > If you leave out the IP address, <SPAN
1676 bind to all interfaces (addresses) on your machine and may become reachable
1677 from the Internet. In that case, consider using <A
1678 HREF="config.html#ACLS"
1679 >access control lists</A
1680 > (ACL's, see below), and/or
1687 > to untrusted users, you will
1688 also want to make sure that the following actions are disabled: <TT
1691 HREF="config.html#ENABLE-EDIT-ACTIONS"
1692 >enable-edit-actions</A
1698 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1699 >enable-remote-toggle</A
1708 > Suppose you are running <SPAN
1712 a machine which has the address 192.168.0.1 on your local private network
1713 (192.168.0.0) and has another outside connection with a different address.
1714 You want it to serve requests from inside only:
1724 CLASS="PROGRAMLISTING"
1725 > listen-address 192.168.0.1:8118</PRE
1746 CLASS="VARIABLELIST"
1752 > Initial state of "toggle" status
1768 >Effect if unset:</DT
1771 > Act as if toggled on
1778 > If set to 0, <SPAN
1784 >"toggled off"</SPAN
1785 > mode, i.e. mostly behave like a normal,
1786 content-neutral proxy with both ad blocking and content filtering
1789 >enable-remote-toggle</TT
1793 > The windows version will only display the toggle icon in the system tray
1794 if this option is present.
1805 NAME="ENABLE-REMOTE-TOGGLE"
1806 >7.4.3. enable-remote-toggle</A
1811 CLASS="VARIABLELIST"
1817 > Whether or not the <A
1818 HREF="http://config.privoxy.org/toggle"
1838 >Effect if unset:</DT
1841 > The web-based toggle feature is disabled.
1848 > When toggled off, <SPAN
1851 > mostly acts like a normal,
1852 content-neutral proxy, i.e. doesn't block ads or filter content.
1855 > Access to the toggle feature can <SPAN
1862 controlled separately by <SPAN
1865 > or HTTP authentication,
1866 so that everybody who can access <SPAN
1877 toggle it for all users. So this option is <SPAN
1884 for multi-user environments with untrusted users.
1887 > Note that malicious client side code (e.g Java) is also
1888 capable of using this option.
1895 documentation, this feature is disabled by default.
1898 > Note that you must have compiled <SPAN
1902 support for this feature, otherwise this option has no effect.
1913 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1914 >7.4.4. enable-remote-http-toggle</A
1919 CLASS="VARIABLELIST"
1925 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1941 >Effect if unset:</DT
1944 > Privoxy ignores special HTTP headers.
1951 > When toggled on, the client can change <SPAN
1955 behaviour by setting special HTTP headers. Currently the only supported
1956 special header is <SPAN
1958 >"X-Filter: No"</SPAN
1959 >, to disable filtering for
1960 the ongoing request, even if it is enabled in one of the action files.
1963 > This feature is disabled by default. If you are using
1967 > in a environment with trusted clients,
1968 you may enable this feature at your discretion. Note that malicious client
1969 side code (e.g Java) is also capable of using this feature.
1972 > This option will be removed in future releases as it has been obsoleted
1973 by the more general header taggers.
1984 NAME="ENABLE-EDIT-ACTIONS"
1985 >7.4.5. enable-edit-actions</A
1990 CLASS="VARIABLELIST"
1996 > Whether or not the <A
1997 HREF="http://config.privoxy.org/show-status"
2017 >Effect if unset:</DT
2020 > The web-based actions file editor is disabled.
2027 > Access to the editor can <SPAN
2034 controlled separately by <SPAN
2037 > or HTTP authentication,
2038 so that everybody who can access <SPAN
2049 modify its configuration for all users.
2052 > This option is <SPAN
2059 with untrusted users and as a lot of <SPAN
2063 users don't read documentation, this feature is disabled by default.
2066 > Note that malicious client side code (e.g Java) is also
2067 capable of using the actions editor and you shouldn't enable
2068 this options unless you understand the consequences and are
2069 sure your browser is configured correctly.
2072 > Note that you must have compiled <SPAN
2076 support for this feature, otherwise this option has no effect.
2087 NAME="ENFORCE-BLOCKS"
2088 >7.4.6. enforce-blocks</A
2093 CLASS="VARIABLELIST"
2099 > Whether the user is allowed to ignore blocks and can <SPAN
2101 >"go there anyway"</SPAN
2130 >Effect if unset:</DT
2133 > Blocks are not enforced.
2143 > is mainly used to block and filter
2144 requests as a service to the user, for example to block ads and other
2145 junk that clogs the pipes. <SPAN
2149 isn't perfect and sometimes innocent pages are blocked. In this situation it
2150 makes sense to allow the user to enforce the request and have
2157 > In the default configuration <SPAN
2164 > page contains a <SPAN
2166 >"go there anyway"</SPAN
2168 link to adds a special string (the force prefix) to the request URL.
2169 If that link is used, <SPAN
2173 detect the force prefix, remove it again and let the request pass.
2179 > can also be used to enforce
2180 a network policy. In that case the user obviously should not be able to
2181 bypass any blocks, and that's what the <SPAN
2183 >"enforce-blocks"</SPAN
2185 option is for. If it's enabled, <SPAN
2191 >"go there anyway"</SPAN
2192 > link. If the user adds the force
2193 prefix by hand, it will not be accepted and the circumvention attempt
2213 >7.4.7. ACLs: permit-access and deny-access</A
2216 NAME="PERMIT-ACCESS"
2224 CLASS="VARIABLELIST"
2230 > Who can access what.
2272 > are IP addresses in dotted decimal notation or valid
2284 > are subnet masks in CIDR notation, i.e. integer
2285 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2286 destination part are optional.
2302 >Effect if unset:</DT
2305 > Don't restrict access further than implied by <TT
2315 > Access controls are included at the request of ISPs and systems
2316 administrators, and <SPAN
2320 >are not usually needed by individual users</I
2323 For a typical home user, it will normally suffice to ensure that
2327 > only listens on the localhost
2328 (127.0.0.1) or internal (home) network address by means of the
2330 HREF="config.html#LISTEN-ADDRESS"
2342 > Please see the warnings in the FAQ that <SPAN
2346 is not intended to be a substitute for a firewall or to encourage anyone
2347 to defer addressing basic security weaknesses.
2350 > Multiple ACL lines are OK.
2351 If any ACLs are specified, <SPAN
2355 to IP addresses that match at least one <TT
2359 and don't match any subsequent <TT
2362 > line. In other words, the
2363 last match wins, with the default being <TT
2372 > is using a forwarder (see <TT
2376 for a particular destination URL, the <TT
2382 that is examined is the address of the forwarder and <SPAN
2389 of the ultimate target. This is necessary because it may be impossible for the local
2393 > to determine the IP address of the
2394 ultimate target (that's often what gateways are used for).
2397 > You should prefer using IP addresses over DNS names, because the address lookups take
2398 time. All DNS names must resolve! You can <SPAN
2404 > use domain patterns
2408 > or partial domain names. If a DNS name resolves to multiple
2409 IP addresses, only the first one is used.
2412 > Denying access to particular sites by ACL may have undesired side effects
2413 if the site in question is hosted on a machine which also hosts other sites
2421 > Explicitly define the default behavior if no ACL and
2429 is OK. The absence of a <TT
2441 > destination addresses are OK:
2452 > permit-access localhost</PRE
2459 > Allow any host on the same class C subnet as www.privoxy.org access to
2460 nothing but www.example.com (or other domains hosted on the same system):
2471 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2478 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2479 with the exception that 192.168.45.73 may not access the IP address behind
2480 www.dirty-stuff.example.com:
2491 > permit-access 192.168.45.64/26
2492 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2508 >7.4.8. buffer-limit</A
2513 CLASS="VARIABLELIST"
2519 > Maximum size of the buffer for content filtering.
2535 >Effect if unset:</DT
2538 > Use a 4MB (4096 KB) limit.
2545 > For content filtering, i.e. the <TT
2552 > actions, it is necessary that
2556 > buffers the entire document body.
2557 This can be potentially dangerous, since a server could just keep sending
2558 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2562 > When a document buffer size reaches the <TT
2566 flushed to the client unfiltered and no further attempt to
2567 filter the rest of the document is made. Remember that there may be multiple threads
2568 running, which might require up to <TT
2578 >, unless you have enabled <SPAN
2580 >"single-threaded"</SPAN
2598 > This feature allows routing of HTTP requests through a chain of
2599 multiple proxies.</P
2601 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2602 up browsing. Using a parent proxy may also be necessary if the machine
2606 > runs on has no direct Internet access.</P
2608 > Note that parent proxies can severely decrease your privacy level.
2609 For example a parent proxy could add your IP address to the request
2610 headers and if it's a caching proxy it may add the <SPAN
2614 header to revalidation requests again, even though you configured Privoxy
2615 to remove it. It may also ignore Privoxy's header time randomization and use the
2616 original values which could be used by the server as cookie replacement
2617 to track your steps between visits.</P
2619 > Also specified here are SOCKS proxies. <SPAN
2623 supports the SOCKS 4 and SOCKS 4A protocols.</P
2635 CLASS="VARIABLELIST"
2641 > To which parent HTTP proxy specific requests should be routed.
2673 HREF="actions-file.html#AF-PATTERNS"
2676 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2695 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2696 optionally followed by its listening port (default: 8080).
2697 Use a single dot (<TT
2702 >"no forwarding"</SPAN
2719 >Effect if unset:</DT
2722 > Don't use parent HTTP proxies.
2737 >, then requests are not
2738 forwarded to another HTTP proxy but are made directly to the web servers.
2741 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2748 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2759 > forward / parent-proxy.example.org:8080
2767 > Everything goes to our example ISP's caching proxy, except for requests
2768 to that ISP's sites:
2779 > forward / caching-proxy.isp.example.net:8000
2780 forward .isp.example.net .</PRE
2796 >7.5.2. forward-socks4, forward-socks4a and forward-socks5</A
2799 NAME="FORWARD-SOCKS4"
2802 NAME="FORWARD-SOCKS4A"
2807 CLASS="VARIABLELIST"
2813 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2857 HREF="actions-file.html#AF-PATTERNS"
2859 > that specifies to which
2860 requests (i.e. URLs) this forward rule shall apply. Use <TT
2879 are IP addresses in dotted decimal notation or valid DNS names
2891 >"no HTTP forwarding"</SPAN
2892 >), and the optional
2898 > parameters are TCP ports,
2899 i.e. integer values from 1 to 65535
2915 >Effect if unset:</DT
2918 > Don't use SOCKS proxies.
2925 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2928 > The difference between <TT
2933 >forward-socks4a</TT
2935 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2936 server, while in SOCKS 4 it happens locally.
2942 > the DNS resolution will happen on the remote server as well.
2953 >, then requests are not
2954 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2962 > From the company example.com, direct connections are made to all
2966 > domains, but everything outbound goes through
2967 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2979 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2980 forward .example.com .</PRE
2987 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2998 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3005 > To chain Privoxy and Tor, both running on the same system, you would use
3017 > forward-socks4a / 127.0.0.1:9050 .</PRE
3027 > network can't be used to
3028 reach your local network, if you need to access local servers you
3029 therefore might want to make some exceptions:
3040 > forward 192.168.*.*/ .
3042 forward 127.*.*.*/ .</PRE
3049 > Unencrypted connections to systems in these address ranges will
3050 be as (un)secure as the local network is, but the alternative is that you
3051 can't reach the local network through <SPAN
3055 at all. Of course this may actually be desired and there is no reason
3056 to make these exceptions if you aren't sure you need them.
3059 > If you also want to be able to reach servers in your local network by
3060 using their names, you will need additional exceptions that look like
3072 > forward localhost/ .</PRE
3087 NAME="ADVANCED-FORWARDING-EXAMPLES"
3088 >7.5.3. Advanced Forwarding Examples</A
3091 > If you have links to multiple ISPs that provide various special content
3092 only to their subscribers, you can configure multiple <SPAN
3096 which have connections to the respective ISPs to act as forwarders to each other, so that
3103 > users can see the internal content of all ISPs.</P
3105 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3106 isp-b.example.org. Both run <SPAN
3110 configuration can look like this:</P
3123 forward .isp-b.example.net host-b:8118</PRE
3140 forward .isp-a.example.org host-a:8118</PRE
3146 > Now, your users can set their browser's proxy to use either
3147 host-a or host-b and be able to browse the internal content
3148 of both isp-a and isp-b.</P
3150 > If you intend to chain <SPAN
3157 > locally, then chaining as
3160 >browser -> squid -> privoxy</TT
3161 > is the recommended way. </P
3163 > Assuming that <SPAN
3170 run on the same box, your <SPAN
3173 > configuration could then look like this:</P
3183 > # Define Privoxy as parent proxy (without ICP)
3184 cache_peer 127.0.0.1 parent 8118 7 no-query
3186 # Define ACL for protocol FTP
3189 # Do not forward FTP requests to Privoxy
3190 always_direct allow ftp
3192 # Forward all the rest to Privoxy
3193 never_direct allow all</PRE
3199 > You would then need to change your browser's proxy settings to <SPAN
3202 >'s address and port.
3203 Squid normally uses port 3128. If unsure consult <TT
3211 > You could just as well decide to only forward requests you suspect
3212 of leading to Windows executables through a virus-scanning parent proxy,
3215 >antivir.example.com</TT
3227 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3238 NAME="FORWARDED-CONNECT-RETRIES"
3239 >7.5.4. forwarded-connect-retries</A
3244 CLASS="VARIABLELIST"
3250 > How often Privoxy retries if a forwarded connection request fails.
3260 >Number of retries.</I
3278 >Effect if unset:</DT
3281 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3291 >forwarded-connect-retries</I
3293 > is mainly interesting
3294 for socks4a connections, where <SPAN
3297 > can't detect why the connections failed.
3298 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3299 but it might also have failed because the server doesn't exist or isn't reachable. In this
3300 case the retry will just delay the appearance of Privoxy's error message.
3303 > Note that in the context of this option, <SPAN
3305 >"forwarded connections"</SPAN
3306 > includes all connections
3307 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3310 > Only use this option, if you are getting lots of forwarding-related error messages
3311 that go away when you try again manually. Start with a small value and check Privoxy's
3312 logfile from time to time, to see how many retries are usually needed.
3319 > forwarded-connect-retries 1
3330 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3331 >7.5.5. accept-intercepted-requests</A
3336 CLASS="VARIABLELIST"
3342 > Whether intercepted requests should be treated as valid.
3370 >Effect if unset:</DT
3373 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3380 > If you don't trust your clients and want to force them
3385 option and configure your packet filter to redirect outgoing
3386 HTTP connections into <SPAN
3392 > Make sure that <SPAN
3396 aren't redirected as well. Additionally take care that
3400 > can't intentionally connect
3401 to itself, otherwise you could run into redirection loops if
3405 > listening port is reachable
3406 by the outside or an attacker has access to the pages you visit.
3413 > accept-intercepted-requests 1
3424 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3425 >7.5.6. allow-cgi-request-crunching</A
3430 CLASS="VARIABLELIST"
3436 > Whether requests to <SPAN
3439 > CGI pages can be blocked or redirected.
3467 >Effect if unset:</DT
3473 > ignores block and redirect actions for its CGI pages.
3483 > ignores block or redirect actions
3484 for its CGI pages. Intercepting these requests can be useful in multi-user
3485 setups to implement fine-grained access control, but it can also render the complete
3486 web interface useless and make debugging problems painful if done without care.
3489 > Don't enable this option unless you're sure that you really need it.
3496 > allow-cgi-request-crunching 1
3507 NAME="SPLIT-LARGE-FORMS"
3508 >7.5.7. split-large-forms</A
3513 CLASS="VARIABLELIST"
3519 > Whether the CGI interface should stay compatible with broken HTTP clients.
3547 >Effect if unset:</DT
3550 > The CGI form generate long GET URLs.
3560 > CGI forms can lead to
3561 rather long URLs. This isn't a problem as far as the HTTP
3562 standard is concerned, but it can confuse clients with arbitrary
3563 URL length limitations.
3566 > Enabling split-large-forms causes <SPAN
3570 to divide big forms into smaller ones to keep the URL length down.
3571 It makes editing a lot less convenient and you can no longer
3572 submit all changes at once, but at least it works around this
3576 > If you don't notice any editing problems, there is no reason
3577 to enable this option, but if one of the submit buttons appears
3578 to be broken, you should give it a try.
3585 > split-large-forms 1
3596 NAME="KEEP-ALIVE-TIMEOUT"
3597 >7.5.8. keep-alive-timeout</A
3602 CLASS="VARIABLELIST"
3608 > Number of seconds after which an open connection will no longer be reused.
3618 >Time in seconds.</I
3630 >Effect if unset:</DT
3633 > Connections are not reused.
3640 > This option has no effect if <SPAN
3644 has been compiled without keep-alive support.
3651 > keep-alive-timeout 300
3664 >7.6. Windows GUI Options</A
3670 > has a number of options specific to the
3671 Windows GUI interface:</P
3673 NAME="ACTIVITY-ANIMATION"
3678 >"activity-animation"</SPAN
3683 > icon will animate when
3687 > is active. To turn off, set to 0.</P
3692 CLASS="LITERALLAYOUT"
3697 >activity-animation 1</I
3700 </P
3710 >"log-messages"</SPAN
3715 > will log messages to the console
3721 CLASS="LITERALLAYOUT"
3729 </P
3734 NAME="LOG-BUFFER-SIZE"
3740 >"log-buffer-size"</SPAN
3741 > is set to 1, the size of the log buffer,
3742 i.e. the amount of memory used for the log messages displayed in the
3743 console window, will be limited to <SPAN
3745 >"log-max-lines"</SPAN
3748 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3749 eat up all your memory!</P
3754 CLASS="LITERALLAYOUT"
3759 >log-buffer-size 1</I
3762 </P
3767 NAME="LOG-MAX-LINES"
3772 >log-max-lines</SPAN
3773 > is the maximum number of lines held
3774 in the log buffer. See above.</P
3779 CLASS="LITERALLAYOUT"
3784 >log-max-lines 200</I
3787 </P
3792 NAME="LOG-HIGHLIGHT-MESSAGES"
3797 >"log-highlight-messages"</SPAN
3802 > will highlight portions of the log
3803 messages with a bold-faced font:</P
3808 CLASS="LITERALLAYOUT"
3813 >log-highlight-messages 1</I
3816 </P
3821 NAME="LOG-FONT-NAME"
3824 > The font used in the console window:</P
3829 CLASS="LITERALLAYOUT"
3834 >log-font-name Comic Sans MS</I
3837 </P
3842 NAME="LOG-FONT-SIZE"
3845 > Font size used in the console window:</P
3850 CLASS="LITERALLAYOUT"
3858 </P
3863 NAME="SHOW-ON-TASK-BAR"
3869 >"show-on-task-bar"</SPAN
3870 > controls whether or not
3874 > will appear as a button on the Task bar
3880 CLASS="LITERALLAYOUT"
3885 >show-on-task-bar 0</I
3888 </P
3893 NAME="CLOSE-BUTTON-MINIMIZES"
3898 >"close-button-minimizes"</SPAN
3899 > is set to 1, the Windows close
3900 button will minimize <SPAN
3903 > instead of closing
3904 the program (close with the exit option on the File menu).</P
3909 CLASS="LITERALLAYOUT"
3914 >close-button-minimizes 1</I
3917 </P
3927 >"hide-console"</SPAN
3928 > option is specific to the MS-Win console
3932 >. If this option is used,
3936 > will disconnect from and hide the
3942 CLASS="LITERALLAYOUT"
3950 </P
3961 SUMMARY="Footer navigation table"
3972 HREF="configuration.html"
3990 HREF="actions-file.html"
4000 >Privoxy Configuration</TD