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.8 User Manual"
11 HREF="index.html"><LINK
13 TITLE="Privoxy Configuration"
14 HREF="configuration.html"><LINK
17 HREF="actions-file.html"><LINK
21 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
33 SUMMARY="Header navigation table"
42 >Privoxy 3.0.8 User Manual</TH
50 HREF="configuration.html"
64 HREF="actions-file.html"
79 >7. The Main Configuration File</A
82 > Again, the main configuration file is named <TT
86 Linux/Unix/BSD and OS/2, and <TT
90 Configuration lines consist of an initial keyword followed by a list of
91 values, all separated by whitespace (any number of spaces or tabs). For
102 >confdir /etc/privoxy</I
109 > Assigns the value <TT
116 > and thus indicates that the configuration
117 directory is named <SPAN
119 >"/etc/privoxy/"</SPAN
122 > All options in the config file except for <TT
129 > are optional. Watch out in the below description
130 for what happens if you leave them unset.</P
132 > The main config file controls all aspects of <SPAN
136 operation that are not location dependent (i.e. they apply universally, no matter
137 where you may be surfing).</P
144 >7.1. Local Set-up Documentation</A
147 > If you intend to operate <SPAN
151 than just yourself, it might be a good idea to let them know how to reach
152 you, what you block and why you do that, your policies, etc.
160 >7.1.1. user-manual</A
171 > Location of the <SPAN
181 >A fully qualified URI</P
196 >Effect if unset:</DT
200 HREF="http://www.privoxy.org/user-manual/"
202 >http://www.privoxy.org/<TT
209 will be used, where <TT
224 > The User Manual URI is the single best source of information on
228 >, and is used for help links from some
229 of the internal CGI pages. The manual itself is normally packaged with the
230 binary distributions, so you probably want to set this to a locally
237 > The best all purpose solution is simply to put the full local
256 > user-manual /usr/share/doc/privoxy/user-manual</PRE
263 > The User Manual is then available to anyone with access to
267 >, by following the built-in URL:
270 >http://config.privoxy.org/user-manual/</TT
272 (or the shortcut: <TT
274 >http://p.p/user-manual/</TT
278 > If the documentation is not on the local system, it can be accessed
279 from a remote server, as:
290 > user-manual http://example.com/privoxy/user-manual/</PRE
315 > If set, this option should be <SPAN
319 >the first option in the config
322 >, because it is used while the config file is being read
338 NAME="TRUST-INFO-URL"
339 >7.1.2. trust-info-url</A
350 > A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
363 >Two example URLs are provided</P
366 >Effect if unset:</DT
369 > No links are displayed on the "untrusted" error page.
376 > The value of this option only matters if the experimental trust mechanism has been
378 HREF="config.html#TRUSTFILE"
389 > If you use the trust mechanism, it is a good idea to write up some on-line
390 documentation about your trust policy and to specify the URL(s) here.
391 Use multiple times for multiple URLs.
394 > The URL(s) should be added to the trustfile as well, so users don't end up
395 locked out from the information on why they were locked out in the first place!
407 >7.1.3. admin-address</A
418 > An email address to reach the <SPAN
443 >Effect if unset:</DT
446 > No email address is displayed on error pages and the CGI user interface.
460 are unset, the whole "Local Privoxy Support" box on all generated pages will
472 NAME="PROXY-INFO-URL"
473 >7.1.4. proxy-info-url</A
484 > A URL to documentation about the local <SPAN
488 configuration or policies.
510 >Effect if unset:</DT
513 > No link to local documentation is displayed on error pages and the CGI user interface.
527 are unset, the whole "Local Privoxy Support" box on all generated pages will
531 > This URL shouldn't be blocked ;-)
544 >7.2. Configuration and Log File Locations</A
550 > can (and normally does) use a number of
551 other files for additional configuration, help and logging.
552 This section of the configuration file tells <SPAN
556 where to find those other files. </P
558 > The user running <SPAN
562 permission for all configuration files, and write permission to any files
563 that would be modified, such as log files and actions files.</P
581 >The directory where the other configuration files are located.</P
593 >/etc/privoxy (Unix) <SPAN
602 > installation dir (Windows) </P
605 >Effect if unset:</DT
649 >An alternative directory where the templates are loaded from.</P
664 >Effect if unset:</DT
667 >The templates are assumed to be located in confdir/template.</P
676 > original templates are usually
677 overwritten with each update. Use this option to relocate customized
678 templates that should be kept. As template variables might change
679 between updates, you shouldn't expect templates to work with
683 > releases other than the one
684 they were part of, though.
707 > The directory where all logging takes place
728 >/var/log/privoxy (Unix) <SPAN
737 > installation dir (Windows) </P
740 >Effect if unset:</DT
773 >7.2.4. actionsfile</A
776 NAME="DEFAULT.ACTION"
779 NAME="STANDARD.ACTION"
794 HREF="actions-file.html"
803 >Complete file name, relative to <TT
819 CLASS="LITERALLAYOUT"
820 > standard.action # Internal purposes, no editing recommended</P
827 CLASS="LITERALLAYOUT"
828 > default.action # Main actions file</P
835 CLASS="LITERALLAYOUT"
836 > user.action # User customizations</P
846 >Effect if unset:</DT
849 > No actions are taken at all. More or less neutral proxying.
859 > lines are permitted, and are in fact recommended!
863 The default values include <TT
867 for internal purposes and should be loaded, <TT
874 > actions file maintained by the developers, and
878 >, where you can make your personal additions.
882 Actions files contain all the per site and per URL configuration for
883 ad blocking, cookie management, privacy considerations, etc.
884 There is no point in using <SPAN
888 least one actions file.
891 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
895 extension has to be specified. The syntax change was necessary to be consistent
896 with the other file options and to allow previously forbidden characters.
908 >7.2.5. filterfile</A
911 NAME="DEFAULT.FILTER"
923 HREF="filter-file.html"
932 >File name, relative to <TT
941 >default.filter (Unix) <SPAN
947 > default.filter.txt (Windows)</P
950 >Effect if unset:</DT
953 > No textual content filtering takes place, i.e. all
957 HREF="actions-file.html#FILTER"
966 actions in the actions files are turned neutral.
976 > lines are permitted.
980 HREF="filter-file.html"
982 > contain content modification
984 HREF="appendix.html#REGEX"
985 >regular expressions</A
986 >. These rules permit
987 powerful changes on the content of Web pages, and optionally the headers
988 as well, e.g., you could try to disable your favorite JavaScript annoyances,
989 re-write the actual displayed text, or just have some fun
990 playing buzzword bingo with web pages.
997 HREF="actions-file.html#FILTER"
1006 actions rely on the relevant filter (<TT
1012 to be defined in a filter file!
1015 > A pre-defined filter file called <TT
1019 a number of useful filters for common problems is included in the distribution.
1020 See the section on the <TT
1023 HREF="actions-file.html#FILTER"
1030 > It is recommended to place any locally adapted filters into a separate
1051 CLASS="VARIABLELIST"
1057 > The log file to use
1064 >File name, relative to <TT
1077 >Unset (commented out)</I
1079 >. When activated: logfile (Unix) <SPAN
1085 > privoxy.log (Windows).</P
1088 >Effect if unset:</DT
1091 > No logfile is written.
1098 > The logfile is where all logging and error messages are written. The level
1099 of detail and number of messages are set with the <TT
1103 option (see below). The logfile can be useful for tracking down a problem with
1107 > (e.g., it's not blocking an ad you
1108 think it should block) and it can help you to monitor what your browser
1112 > Depending on the debug options below, the logfile may be a privacy risk
1113 if third parties can get access to it. As most users will never look
1117 > 3.0.7 and later only log fatal
1121 > For most troubleshooting purposes, you will have to change that,
1122 please refer to the debugging section for details.
1125 > Your logfile will grow indefinitely, and you will probably want to
1126 periodically remove it. On Unix systems, you can do this with a cron job
1130 >). For Red Hat based Linux distributions, a
1134 > script has been included.
1137 > Any log files must be writable by whatever user <SPAN
1141 is being run as (on Unix, default user id is <SPAN
1161 CLASS="VARIABLELIST"
1167 > The file to store intercepted cookies in
1174 >File name, relative to <TT
1187 >Unset (commented out)</I
1189 >. When activated: jarfile (Unix) <SPAN
1195 > privoxy.jar (Windows).</P
1198 >Effect if unset:</DT
1201 > Intercepted cookies are not stored in a dedicated log file.
1208 > The jarfile may grow to ridiculous sizes over time.
1211 > If debug 8 (show header parsing) is enabled, cookies are
1212 also written to the logfile with the rest of the headers.
1213 Therefore this option isn't very useful and may be removed
1214 in future releases. Please report to the developers if you
1227 >7.2.8. trustfile</A
1232 CLASS="VARIABLELIST"
1238 > The name of the trust file to use
1245 >File name, relative to <TT
1258 >Unset (commented out)</I
1260 >. When activated: trust (Unix) <SPAN
1266 > trust.txt (Windows)</P
1269 >Effect if unset:</DT
1272 > The entire trust mechanism is disabled.
1279 > The trust mechanism is an experimental feature for building white-lists and should
1280 be used with care. It is <SPAN
1286 > recommended for the casual user.
1289 > If you specify a trust file, <SPAN
1293 access to sites that are specified in the trustfile. Sites can be listed
1300 > character limits access to this site
1301 only (and any sub-paths within this site), e.g.
1304 >~www.example.com</TT
1308 >~www.example.com/features/news.html</TT
1312 > Or, you can designate sites as <SPAN
1316 >trusted referrers</I
1319 prepending the name with a <TT
1322 > character. The effect is that
1323 access to untrusted sites will be granted -- but only if a link from this
1324 trusted referrer was used to get there. The link target will then be added
1328 > so that future, direct accesses will be
1329 granted. Sites added via this mechanism do not become trusted referrers
1330 themselves (i.e. they are added with a <TT
1334 There is a limit of 512 such entries, after which new entries will not be
1338 > If you use the <TT
1341 > operator in the trust file, it may grow
1342 considerably over time.
1345 > It is recommended that <SPAN
1351 >--disable-force</TT
1354 >--disable-toggle</TT
1358 > --disable-editor</TT
1359 > options, if this feature is to be
1363 > Possible applications include limiting Internet access for children.
1379 > These options are mainly useful when tracing a problem.
1380 Note that you might also want to invoke
1388 command line option when debugging.
1401 CLASS="VARIABLELIST"
1407 > Key values that determine what information gets logged.
1420 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1423 >Effect if unset:</DT
1426 > Default value is used (see above).
1433 > The available debug levels are:
1443 CLASS="PROGRAMLISTING"
1444 > debug 1 # log each request destination (and the crunch reason if <SPAN
1447 > intercepted the request)
1448 debug 2 # show each connection status
1449 debug 4 # show I/O status
1450 debug 8 # show header parsing
1451 debug 16 # log all data written to the network into the logfile
1452 debug 32 # debug force feature
1453 debug 64 # debug regular expression filters
1454 debug 128 # debug redirects
1455 debug 256 # debug GIF de-animation
1456 debug 512 # Common Log Format
1457 debug 1024 # debug kill pop-ups
1458 debug 2048 # CGI user interface
1459 debug 4096 # Startup banner and warnings.
1460 debug 8192 # Non-fatal errors</PRE
1467 > To select multiple debug levels, you can either add them or use
1474 > A debug level of 1 is informative because it will show you each request
1475 as it happens. <SPAN
1479 >1, 4096 and 8192 are recommended</I
1482 so that you will notice when things go wrong. The other levels are
1483 probably only of interest if you are hunting down a specific problem.
1484 They can produce a hell of an output (especially 16).
1491 > used to ship with the debug levels recommended above enabled by
1492 default, but due to privacy concerns 3.0.7 and later are configured to
1493 only log fatal errors.
1496 > If you are used to the more verbose settings, simply enable the debug lines
1500 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1510 > and not enable anything else.
1516 > has a hard-coded limit for the
1517 length of log messages. If it's reached, messages are logged truncated
1518 and marked with <SPAN
1520 >"... [too long, truncated]"</SPAN
1524 > Please don't file any support requests without trying to reproduce
1525 the problem with increased debug level first. Once you read the log
1526 messages, you may even be able to solve the problem on your own.
1537 NAME="SINGLE-THREADED"
1538 >7.3.2. single-threaded</A
1543 CLASS="VARIABLELIST"
1549 > Whether to run only one server thread.
1577 >Effect if unset:</DT
1580 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1581 serve multiple requests simultaneously.
1588 > This option is only there for debugging purposes.
1593 >It will drastically reduce performance.</I
1607 NAME="ACCESS-CONTROL"
1608 >7.4. Access Control and Security</A
1611 > This section of the config file controls the security-relevant aspects
1622 NAME="LISTEN-ADDRESS"
1623 >7.4.1. listen-address</A
1628 CLASS="VARIABLELIST"
1634 > The IP address and TCP port on which <SPAN
1638 listen for client requests.
1664 >Effect if unset:</DT
1667 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1668 home users who run <SPAN
1671 > on the same machine as
1679 > You will need to configure your browser(s) to this proxy address and port.
1682 > If you already have another service running on port 8118, or if you want to
1683 serve requests from other machines (e.g. on your local network) as well, you
1684 will need to override the default.
1687 > If you leave out the IP address, <SPAN
1691 bind to all interfaces (addresses) on your machine and may become reachable
1692 from the Internet. In that case, consider using <A
1693 HREF="config.html#ACLS"
1694 >access control lists</A
1695 > (ACL's, see below), and/or
1702 > to untrusted users, you will
1703 also want to make sure that the following actions are disabled: <TT
1706 HREF="config.html#ENABLE-EDIT-ACTIONS"
1707 >enable-edit-actions</A
1713 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1714 >enable-remote-toggle</A
1723 > Suppose you are running <SPAN
1727 a machine which has the address 192.168.0.1 on your local private network
1728 (192.168.0.0) and has another outside connection with a different address.
1729 You want it to serve requests from inside only:
1739 CLASS="PROGRAMLISTING"
1740 > listen-address 192.168.0.1:8118</PRE
1761 CLASS="VARIABLELIST"
1767 > Initial state of "toggle" status
1783 >Effect if unset:</DT
1786 > Act as if toggled on
1793 > If set to 0, <SPAN
1799 >"toggled off"</SPAN
1800 > mode, i.e. mostly behave like a normal,
1801 content-neutral proxy with both ad blocking and content filtering
1804 >enable-remote-toggle</TT
1808 > The windows version will only display the toggle icon in the system tray
1809 if this option is present.
1820 NAME="ENABLE-REMOTE-TOGGLE"
1821 >7.4.3. enable-remote-toggle</A
1826 CLASS="VARIABLELIST"
1832 > Whether or not the <A
1833 HREF="http://config.privoxy.org/toggle"
1853 >Effect if unset:</DT
1856 > The web-based toggle feature is disabled.
1863 > When toggled off, <SPAN
1866 > mostly acts like a normal,
1867 content-neutral proxy, i.e. doesn't block ads or filter content.
1870 > Access to the toggle feature can <SPAN
1877 controlled separately by <SPAN
1880 > or HTTP authentication,
1881 so that everybody who can access <SPAN
1892 toggle it for all users. So this option is <SPAN
1899 for multi-user environments with untrusted users.
1902 > Note that malicious client side code (e.g Java) is also
1903 capable of using this option.
1910 documentation, this feature is disabled by default.
1913 > Note that you must have compiled <SPAN
1917 support for this feature, otherwise this option has no effect.
1928 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1929 >7.4.4. enable-remote-http-toggle</A
1934 CLASS="VARIABLELIST"
1940 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1956 >Effect if unset:</DT
1959 > Privoxy ignores special HTTP headers.
1966 > When toggled on, the client can change <SPAN
1970 behaviour by setting special HTTP headers. Currently the only supported
1971 special header is <SPAN
1973 >"X-Filter: No"</SPAN
1974 >, to disable filtering for
1975 the ongoing request, even if it is enabled in one of the action files.
1978 > This feature is disabled by default. If you are using
1982 > in a environment with trusted clients,
1983 you may enable this feature at your discretion. Note that malicious client
1984 side code (e.g Java) is also capable of using this feature.
1987 > This option will be removed in future releases as it has been obsoleted
1988 by the more general header taggers.
1999 NAME="ENABLE-EDIT-ACTIONS"
2000 >7.4.5. enable-edit-actions</A
2005 CLASS="VARIABLELIST"
2011 > Whether or not the <A
2012 HREF="http://config.privoxy.org/show-status"
2032 >Effect if unset:</DT
2035 > The web-based actions file editor is disabled.
2042 > Access to the editor can <SPAN
2049 controlled separately by <SPAN
2052 > or HTTP authentication,
2053 so that everybody who can access <SPAN
2064 modify its configuration for all users.
2067 > This option is <SPAN
2074 with untrusted users and as a lot of <SPAN
2078 users don't read documentation, this feature is disabled by default.
2081 > Note that malicious client side code (e.g Java) is also
2082 capable of using the actions editor and you shouldn't enable
2083 this options unless you understand the consequences and are
2084 sure your browser is configured correctly.
2087 > Note that you must have compiled <SPAN
2091 support for this feature, otherwise this option has no effect.
2102 NAME="ENFORCE-BLOCKS"
2103 >7.4.6. enforce-blocks</A
2108 CLASS="VARIABLELIST"
2114 > Whether the user is allowed to ignore blocks and can <SPAN
2116 >"go there anyway"</SPAN
2145 >Effect if unset:</DT
2148 > Blocks are not enforced.
2158 > is mainly used to block and filter
2159 requests as a service to the user, for example to block ads and other
2160 junk that clogs the pipes. <SPAN
2164 isn't perfect and sometimes innocent pages are blocked. In this situation it
2165 makes sense to allow the user to enforce the request and have
2172 > In the default configuration <SPAN
2179 > page contains a <SPAN
2181 >"go there anyway"</SPAN
2183 link to adds a special string (the force prefix) to the request URL.
2184 If that link is used, <SPAN
2188 detect the force prefix, remove it again and let the request pass.
2194 > can also be used to enforce
2195 a network policy. In that case the user obviously should not be able to
2196 bypass any blocks, and that's what the <SPAN
2198 >"enforce-blocks"</SPAN
2200 option is for. If it's enabled, <SPAN
2206 >"go there anyway"</SPAN
2207 > link. If the user adds the force
2208 prefix by hand, it will not be accepted and the circumvention attempt
2228 >7.4.7. ACLs: permit-access and deny-access</A
2231 NAME="PERMIT-ACCESS"
2239 CLASS="VARIABLELIST"
2245 > Who can access what.
2287 > are IP addresses in dotted decimal notation or valid
2299 > are subnet masks in CIDR notation, i.e. integer
2300 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2301 destination part are optional.
2317 >Effect if unset:</DT
2320 > Don't restrict access further than implied by <TT
2330 > Access controls are included at the request of ISPs and systems
2331 administrators, and <SPAN
2335 >are not usually needed by individual users</I
2338 For a typical home user, it will normally suffice to ensure that
2342 > only listens on the localhost
2343 (127.0.0.1) or internal (home) network address by means of the
2345 HREF="config.html#LISTEN-ADDRESS"
2357 > Please see the warnings in the FAQ that <SPAN
2361 is not intended to be a substitute for a firewall or to encourage anyone
2362 to defer addressing basic security weaknesses.
2365 > Multiple ACL lines are OK.
2366 If any ACLs are specified, <SPAN
2370 to IP addresses that match at least one <TT
2374 and don't match any subsequent <TT
2377 > line. In other words, the
2378 last match wins, with the default being <TT
2387 > is using a forwarder (see <TT
2391 for a particular destination URL, the <TT
2397 that is examined is the address of the forwarder and <SPAN
2404 of the ultimate target. This is necessary because it may be impossible for the local
2408 > to determine the IP address of the
2409 ultimate target (that's often what gateways are used for).
2412 > You should prefer using IP addresses over DNS names, because the address lookups take
2413 time. All DNS names must resolve! You can <SPAN
2419 > use domain patterns
2423 > or partial domain names. If a DNS name resolves to multiple
2424 IP addresses, only the first one is used.
2427 > Denying access to particular sites by ACL may have undesired side effects
2428 if the site in question is hosted on a machine which also hosts other sites
2436 > Explicitly define the default behavior if no ACL and
2444 is OK. The absence of a <TT
2456 > destination addresses are OK:
2467 > permit-access localhost</PRE
2474 > Allow any host on the same class C subnet as www.privoxy.org access to
2475 nothing but www.example.com (or other domains hosted on the same system):
2486 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2493 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2494 with the exception that 192.168.45.73 may not access the IP address behind
2495 www.dirty-stuff.example.com:
2506 > permit-access 192.168.45.64/26
2507 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2523 >7.4.8. buffer-limit</A
2528 CLASS="VARIABLELIST"
2534 > Maximum size of the buffer for content filtering.
2550 >Effect if unset:</DT
2553 > Use a 4MB (4096 KB) limit.
2560 > For content filtering, i.e. the <TT
2567 > actions, it is necessary that
2571 > buffers the entire document body.
2572 This can be potentially dangerous, since a server could just keep sending
2573 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2577 > When a document buffer size reaches the <TT
2581 flushed to the client unfiltered and no further attempt to
2582 filter the rest of the document is made. Remember that there may be multiple threads
2583 running, which might require up to <TT
2593 >, unless you have enabled <SPAN
2595 >"single-threaded"</SPAN
2613 > This feature allows routing of HTTP requests through a chain of
2614 multiple proxies.</P
2616 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2617 up browsing. Using a parent proxy may also be necessary if the machine
2621 > runs on has no direct Internet access.</P
2623 > Note that parent proxies can severely decrease your privacy level.
2624 For example a parent proxy could add your IP address to the request
2625 headers and if it's a caching proxy it may add the <SPAN
2629 header to revalidation requests again, even though you configured Privoxy
2630 to remove it. It may also ignore Privoxy's header time randomization and use the
2631 original values which could be used by the server as cookie replacement
2632 to track your steps between visits.</P
2634 > Also specified here are SOCKS proxies. <SPAN
2638 supports the SOCKS 4 and SOCKS 4A protocols.</P
2650 CLASS="VARIABLELIST"
2656 > To which parent HTTP proxy specific requests should be routed.
2688 HREF="actions-file.html#AF-PATTERNS"
2691 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2710 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2711 optionally followed by its listening port (default: 8080).
2712 Use a single dot (<TT
2717 >"no forwarding"</SPAN
2734 >Effect if unset:</DT
2737 > Don't use parent HTTP proxies.
2752 >, then requests are not
2753 forwarded to another HTTP proxy but are made directly to the web servers.
2756 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2763 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2774 > forward / parent-proxy.example.org:8080
2782 > Everything goes to our example ISP's caching proxy, except for requests
2783 to that ISP's sites:
2794 > forward / caching-proxy.isp.example.net:8000
2795 forward .isp.example.net .</PRE
2811 >7.5.2. forward-socks4 and forward-socks4a</A
2814 NAME="FORWARD-SOCKS4"
2817 NAME="FORWARD-SOCKS4A"
2822 CLASS="VARIABLELIST"
2828 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2871 HREF="actions-file.html#AF-PATTERNS"
2874 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2893 are IP addresses in dotted decimal notation or valid DNS names (<TT
2904 >"no HTTP forwarding"</SPAN
2905 >), and the optional
2911 > parameters are TCP ports, i.e. integer values from 1 to 64535
2927 >Effect if unset:</DT
2930 > Don't use SOCKS proxies.
2937 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2940 > The difference between <TT
2945 >forward-socks4a</TT
2947 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2948 server, while in SOCKS 4 it happens locally.
2959 >, then requests are not
2960 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2968 > From the company example.com, direct connections are made to all
2972 > domains, but everything outbound goes through
2973 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2985 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2986 forward .example.com .</PRE
2993 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
3004 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3011 > To chain Privoxy and Tor, both running on the same system, you would use
3023 > forward-socks4a / 127.0.0.1:9050 .</PRE
3033 > network can't be used to
3034 reach your local network, if you need to access local servers you
3035 therefore might want to make some exceptions:
3046 > forward 192.168.*.*/ .
3048 forward 127.*.*.*/ .</PRE
3055 > Unencrypted connections to systems in these address ranges will
3056 be as (un)secure as the local network is, but the alternative is that you
3057 can't reach the local network through <SPAN
3061 at all. Of course this may actually be desired and there is no reason
3062 to make these exceptions if you aren't sure you need them.
3065 > If you also want to be able to reach servers in your local network by
3066 using their names, you will need additional exceptions that look like
3078 > forward localhost/ .</PRE
3093 NAME="ADVANCED-FORWARDING-EXAMPLES"
3094 >7.5.3. Advanced Forwarding Examples</A
3097 > If you have links to multiple ISPs that provide various special content
3098 only to their subscribers, you can configure multiple <SPAN
3102 which have connections to the respective ISPs to act as forwarders to each other, so that
3109 > users can see the internal content of all ISPs.</P
3111 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3112 isp-b.example.org. Both run <SPAN
3116 configuration can look like this:</P
3129 forward .isp-b.example.net host-b:8118</PRE
3146 forward .isp-a.example.org host-a:8118</PRE
3152 > Now, your users can set their browser's proxy to use either
3153 host-a or host-b and be able to browse the internal content
3154 of both isp-a and isp-b.</P
3156 > If you intend to chain <SPAN
3163 > locally, then chaining as
3166 >browser -> squid -> privoxy</TT
3167 > is the recommended way. </P
3169 > Assuming that <SPAN
3176 run on the same box, your <SPAN
3179 > configuration could then look like this:</P
3189 > # Define Privoxy as parent proxy (without ICP)
3190 cache_peer 127.0.0.1 parent 8118 7 no-query
3192 # Define ACL for protocol FTP
3195 # Do not forward FTP requests to Privoxy
3196 always_direct allow ftp
3198 # Forward all the rest to Privoxy
3199 never_direct allow all</PRE
3205 > You would then need to change your browser's proxy settings to <SPAN
3208 >'s address and port.
3209 Squid normally uses port 3128. If unsure consult <TT
3217 > You could just as well decide to only forward requests you suspect
3218 of leading to Windows executables through a virus-scanning parent proxy,
3221 >antivir.example.com</TT
3233 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3244 NAME="FORWARDED-CONNECT-RETRIES"
3245 >7.5.4. forwarded-connect-retries</A
3250 CLASS="VARIABLELIST"
3256 > How often Privoxy retries if a forwarded connection request fails.
3266 >Number of retries.</I
3284 >Effect if unset:</DT
3287 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3297 >forwarded-connect-retries</I
3299 > is mainly interesting
3300 for socks4a connections, where <SPAN
3303 > can't detect why the connections failed.
3304 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3305 but it might also have failed because the server doesn't exist or isn't reachable. In this
3306 case the retry will just delay the appearance of Privoxy's error message.
3309 > Note that in the context of this option, <SPAN
3311 >"forwarded connections"</SPAN
3312 > includes all connections
3313 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3316 > Only use this option, if you are getting lots of forwarding-related error messages
3317 that go away when you try again manually. Start with a small value and check Privoxy's
3318 logfile from time to time, to see how many retries are usually needed.
3325 > forwarded-connect-retries 1
3336 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3337 >7.5.5. accept-intercepted-requests</A
3342 CLASS="VARIABLELIST"
3348 > Whether intercepted requests should be treated as valid.
3376 >Effect if unset:</DT
3379 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3386 > If you don't trust your clients and want to force them
3391 option and configure your packet filter to redirect outgoing
3392 HTTP connections into <SPAN
3398 > Make sure that <SPAN
3402 aren't redirected as well. Additionally take care that
3406 > can't intentionally connect
3407 to itself, otherwise you could run into redirection loops if
3411 > listening port is reachable
3412 by the outside or an attacker has access to the pages you visit.
3419 > accept-intercepted-requests 1
3430 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3431 >7.5.6. allow-cgi-request-crunching</A
3436 CLASS="VARIABLELIST"
3442 > Whether requests to <SPAN
3445 > CGI pages can be blocked or redirected.
3473 >Effect if unset:</DT
3479 > ignores block and redirect actions for its CGI pages.
3489 > ignores block or redirect actions
3490 for its CGI pages. Intercepting these requests can be useful in multi-user
3491 setups to implement fine-grained access control, but it can also render the complete
3492 web interface useless and make debugging problems painful if done without care.
3495 > Don't enable this option unless you're sure that you really need it.
3502 > allow-cgi-request-crunching 1
3513 NAME="SPLIT-LARGE-FORMS"
3514 >7.5.7. split-large-forms</A
3519 CLASS="VARIABLELIST"
3525 > Whether the CGI interface should stay compatible with broken HTTP clients.
3553 >Effect if unset:</DT
3556 > The CGI form generate long GET URLs.
3566 > CGI forms can lead to
3567 rather long URLs. This isn't a problem as far as the HTTP
3568 standard is concerned, but it can confuse clients with arbitrary
3569 URL length limitations.
3572 > Enabling split-large-forms causes <SPAN
3576 to divide big forms into smaller ones to keep the URL length down.
3577 It makes editing a lot less convenient and you can no longer
3578 submit all changes at once, but at least it works around this
3582 > If you don't notice any editing problems, there is no reason
3583 to enable this option, but if one of the submit buttons appears
3584 to be broken, you should give it a try.
3591 > split-large-forms 1
3604 >7.6. Windows GUI Options</A
3610 > has a number of options specific to the
3611 Windows GUI interface:</P
3613 NAME="ACTIVITY-ANIMATION"
3618 >"activity-animation"</SPAN
3623 > icon will animate when
3627 > is active. To turn off, set to 0.</P
3632 CLASS="LITERALLAYOUT"
3637 >activity-animation 1</I
3640 </P
3650 >"log-messages"</SPAN
3655 > will log messages to the console
3661 CLASS="LITERALLAYOUT"
3669 </P
3674 NAME="LOG-BUFFER-SIZE"
3680 >"log-buffer-size"</SPAN
3681 > is set to 1, the size of the log buffer,
3682 i.e. the amount of memory used for the log messages displayed in the
3683 console window, will be limited to <SPAN
3685 >"log-max-lines"</SPAN
3688 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3689 eat up all your memory!</P
3694 CLASS="LITERALLAYOUT"
3699 >log-buffer-size 1</I
3702 </P
3707 NAME="LOG-MAX-LINES"
3712 >log-max-lines</SPAN
3713 > is the maximum number of lines held
3714 in the log buffer. See above.</P
3719 CLASS="LITERALLAYOUT"
3724 >log-max-lines 200</I
3727 </P
3732 NAME="LOG-HIGHLIGHT-MESSAGES"
3737 >"log-highlight-messages"</SPAN
3742 > will highlight portions of the log
3743 messages with a bold-faced font:</P
3748 CLASS="LITERALLAYOUT"
3753 >log-highlight-messages 1</I
3756 </P
3761 NAME="LOG-FONT-NAME"
3764 > The font used in the console window:</P
3769 CLASS="LITERALLAYOUT"
3774 >log-font-name Comic Sans MS</I
3777 </P
3782 NAME="LOG-FONT-SIZE"
3785 > Font size used in the console window:</P
3790 CLASS="LITERALLAYOUT"
3798 </P
3803 NAME="SHOW-ON-TASK-BAR"
3809 >"show-on-task-bar"</SPAN
3810 > controls whether or not
3814 > will appear as a button on the Task bar
3820 CLASS="LITERALLAYOUT"
3825 >show-on-task-bar 0</I
3828 </P
3833 NAME="CLOSE-BUTTON-MINIMIZES"
3838 >"close-button-minimizes"</SPAN
3839 > is set to 1, the Windows close
3840 button will minimize <SPAN
3843 > instead of closing
3844 the program (close with the exit option on the File menu).</P
3849 CLASS="LITERALLAYOUT"
3854 >close-button-minimizes 1</I
3857 </P
3867 >"hide-console"</SPAN
3868 > option is specific to the MS-Win console
3872 >. If this option is used,
3876 > will disconnect from and hide the
3882 CLASS="LITERALLAYOUT"
3890 </P
3901 SUMMARY="Footer navigation table"
3912 HREF="configuration.html"
3930 HREF="actions-file.html"
3940 >Privoxy Configuration</TD