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 > standard.action # Internal purposes, no editing recommended</P
826 CLASS="LITERALLAYOUT"
827 > default.action # Main actions file</P
834 CLASS="LITERALLAYOUT"
835 > user.action # User customizations</P
845 >Effect if unset:</DT
848 > No actions are taken at all. More or less neutral proxying.
858 > lines are permitted, and are in fact recommended!
862 The default values include <TT
866 for internal purposes and should be loaded, <TT
873 > actions file maintained by the developers, and
877 >, where you can make your personal additions.
881 Actions files contain all the per site and per URL configuration for
882 ad blocking, cookie management, privacy considerations, etc.
883 There is no point in using <SPAN
887 least one actions file.
890 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
894 extension has to be specified. The syntax change was necessary to be consistent
895 with the other file options and to allow previously forbidden characters.
907 >7.2.5. filterfile</A
910 NAME="DEFAULT.FILTER"
922 HREF="filter-file.html"
931 >File name, relative to <TT
940 >default.filter (Unix) <SPAN
946 > default.filter.txt (Windows)</P
949 >Effect if unset:</DT
952 > No textual content filtering takes place, i.e. all
956 HREF="actions-file.html#FILTER"
965 actions in the actions files are turned neutral.
975 > lines are permitted.
979 HREF="filter-file.html"
981 > contain content modification
983 HREF="appendix.html#REGEX"
984 >regular expressions</A
985 >. These rules permit
986 powerful changes on the content of Web pages, and optionally the headers
987 as well, e.g., you could try to disable your favorite JavaScript annoyances,
988 re-write the actual displayed text, or just have some fun
989 playing buzzword bingo with web pages.
996 HREF="actions-file.html#FILTER"
1005 actions rely on the relevant filter (<TT
1011 to be defined in a filter file!
1014 > A pre-defined filter file called <TT
1018 a number of useful filters for common problems is included in the distribution.
1019 See the section on the <TT
1022 HREF="actions-file.html#FILTER"
1029 > It is recommended to place any locally adapted filters into a separate
1050 CLASS="VARIABLELIST"
1056 > The log file to use
1063 >File name, relative to <TT
1076 >Unset (commented out)</I
1078 >. When activated: logfile (Unix) <SPAN
1084 > privoxy.log (Windows).</P
1087 >Effect if unset:</DT
1090 > No logfile is written.
1097 > The logfile is where all logging and error messages are written. The level
1098 of detail and number of messages are set with the <TT
1102 option (see below). The logfile can be useful for tracking down a problem with
1106 > (e.g., it's not blocking an ad you
1107 think it should block) and it can help you to monitor what your browser
1111 > Depending on the debug options below, the logfile may be a privacy risk
1112 if third parties can get access to it. As most users will never look
1116 > 3.0.7 and later only log fatal
1120 > For most troubleshooting purposes, you will have to change that,
1121 please refer to the debugging section for details.
1124 > Your logfile will grow indefinitely, and you will probably want to
1125 periodically remove it. On Unix systems, you can do this with a cron job
1129 >). For Red Hat based Linux distributions, a
1133 > script has been included.
1136 > Any log files must be writable by whatever user <SPAN
1140 is being run as (on Unix, default user id is <SPAN
1155 >7.2.7. trustfile</A
1160 CLASS="VARIABLELIST"
1166 > The name of the trust file to use
1173 >File name, relative to <TT
1186 >Unset (commented out)</I
1188 >. When activated: trust (Unix) <SPAN
1194 > trust.txt (Windows)</P
1197 >Effect if unset:</DT
1200 > The entire trust mechanism is disabled.
1207 > The trust mechanism is an experimental feature for building white-lists and should
1208 be used with care. It is <SPAN
1214 > recommended for the casual user.
1217 > If you specify a trust file, <SPAN
1221 access to sites that are specified in the trustfile. Sites can be listed
1228 > character limits access to this site
1229 only (and any sub-paths within this site), e.g.
1232 >~www.example.com</TT
1236 >~www.example.com/features/news.html</TT
1240 > Or, you can designate sites as <SPAN
1244 >trusted referrers</I
1247 prepending the name with a <TT
1250 > character. The effect is that
1251 access to untrusted sites will be granted -- but only if a link from this
1252 trusted referrer was used to get there. The link target will then be added
1256 > so that future, direct accesses will be
1257 granted. Sites added via this mechanism do not become trusted referrers
1258 themselves (i.e. they are added with a <TT
1262 There is a limit of 512 such entries, after which new entries will not be
1266 > If you use the <TT
1269 > operator in the trust file, it may grow
1270 considerably over time.
1273 > It is recommended that <SPAN
1279 >--disable-force</TT
1282 >--disable-toggle</TT
1286 > --disable-editor</TT
1287 > options, if this feature is to be
1291 > Possible applications include limiting Internet access for children.
1307 > These options are mainly useful when tracing a problem.
1308 Note that you might also want to invoke
1316 command line option when debugging.
1329 CLASS="VARIABLELIST"
1335 > Key values that determine what information gets logged.
1348 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1351 >Effect if unset:</DT
1354 > Default value is used (see above).
1361 > The available debug levels are:
1371 CLASS="PROGRAMLISTING"
1372 > debug 1 # log each request destination (and the crunch reason if <SPAN
1375 > intercepted the request)
1376 debug 2 # show each connection status
1377 debug 4 # show I/O status
1378 debug 8 # show header parsing
1379 debug 16 # log all data written to the network into the logfile
1380 debug 32 # debug force feature
1381 debug 64 # debug regular expression filters
1382 debug 128 # debug redirects
1383 debug 256 # debug GIF de-animation
1384 debug 512 # Common Log Format
1385 debug 2048 # CGI user interface
1386 debug 4096 # Startup banner and warnings.
1387 debug 8192 # Non-fatal errors</PRE
1394 > To select multiple debug levels, you can either add them or use
1401 > A debug level of 1 is informative because it will show you each request
1402 as it happens. <SPAN
1406 >1, 4096 and 8192 are recommended</I
1409 so that you will notice when things go wrong. The other levels are
1410 probably only of interest if you are hunting down a specific problem.
1411 They can produce a hell of an output (especially 16).
1418 > used to ship with the debug levels recommended above enabled by
1419 default, but due to privacy concerns 3.0.7 and later are configured to
1420 only log fatal errors.
1423 > If you are used to the more verbose settings, simply enable the debug lines
1427 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1437 > and not enable anything else.
1443 > has a hard-coded limit for the
1444 length of log messages. If it's reached, messages are logged truncated
1445 and marked with <SPAN
1447 >"... [too long, truncated]"</SPAN
1451 > Please don't file any support requests without trying to reproduce
1452 the problem with increased debug level first. Once you read the log
1453 messages, you may even be able to solve the problem on your own.
1464 NAME="SINGLE-THREADED"
1465 >7.3.2. single-threaded</A
1470 CLASS="VARIABLELIST"
1476 > Whether to run only one server thread.
1504 >Effect if unset:</DT
1507 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1508 serve multiple requests simultaneously.
1515 > This option is only there for debugging purposes.
1520 >It will drastically reduce performance.</I
1539 CLASS="VARIABLELIST"
1545 > The hostname shown on the CGI pages.
1567 >Effect if unset:</DT
1570 > The hostname provided by the operating system is used.
1577 > On some misconfigured systems resolving the hostname fails or
1578 takes too much time and slows Privoxy down. Setting a fixed hostname
1579 works around the problem.
1582 > In other circumstances it might be desirable to show a hostname
1583 other than the one returned by the operating system. For example
1584 if the system has several different hostnames and you don't want
1585 to use the first one.
1588 > Note that Privoxy does not validate the specified hostname value.
1600 NAME="ACCESS-CONTROL"
1601 >7.4. Access Control and Security</A
1604 > This section of the config file controls the security-relevant aspects
1615 NAME="LISTEN-ADDRESS"
1616 >7.4.1. listen-address</A
1621 CLASS="VARIABLELIST"
1627 > The IP address and TCP port on which <SPAN
1631 listen for client requests.
1657 >Effect if unset:</DT
1660 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1661 home users who run <SPAN
1664 > on the same machine as
1672 > You will need to configure your browser(s) to this proxy address and port.
1675 > If you already have another service running on port 8118, or if you want to
1676 serve requests from other machines (e.g. on your local network) as well, you
1677 will need to override the default.
1680 > If you leave out the IP address, <SPAN
1684 bind to all interfaces (addresses) on your machine and may become reachable
1685 from the Internet. In that case, consider using <A
1686 HREF="config.html#ACLS"
1687 >access control lists</A
1688 > (ACL's, see below), and/or
1695 > to untrusted users, you will
1696 also want to make sure that the following actions are disabled: <TT
1699 HREF="config.html#ENABLE-EDIT-ACTIONS"
1700 >enable-edit-actions</A
1706 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1707 >enable-remote-toggle</A
1716 > Suppose you are running <SPAN
1720 a machine which has the address 192.168.0.1 on your local private network
1721 (192.168.0.0) and has another outside connection with a different address.
1722 You want it to serve requests from inside only:
1732 CLASS="PROGRAMLISTING"
1733 > listen-address 192.168.0.1:8118</PRE
1754 CLASS="VARIABLELIST"
1760 > Initial state of "toggle" status
1776 >Effect if unset:</DT
1779 > Act as if toggled on
1786 > If set to 0, <SPAN
1792 >"toggled off"</SPAN
1793 > mode, i.e. mostly behave like a normal,
1794 content-neutral proxy with both ad blocking and content filtering
1797 >enable-remote-toggle</TT
1801 > The windows version will only display the toggle icon in the system tray
1802 if this option is present.
1813 NAME="ENABLE-REMOTE-TOGGLE"
1814 >7.4.3. enable-remote-toggle</A
1819 CLASS="VARIABLELIST"
1825 > Whether or not the <A
1826 HREF="http://config.privoxy.org/toggle"
1846 >Effect if unset:</DT
1849 > The web-based toggle feature is disabled.
1856 > When toggled off, <SPAN
1859 > mostly acts like a normal,
1860 content-neutral proxy, i.e. doesn't block ads or filter content.
1863 > Access to the toggle feature can <SPAN
1870 controlled separately by <SPAN
1873 > or HTTP authentication,
1874 so that everybody who can access <SPAN
1885 toggle it for all users. So this option is <SPAN
1892 for multi-user environments with untrusted users.
1895 > Note that malicious client side code (e.g Java) is also
1896 capable of using this option.
1903 documentation, this feature is disabled by default.
1906 > Note that you must have compiled <SPAN
1910 support for this feature, otherwise this option has no effect.
1921 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1922 >7.4.4. enable-remote-http-toggle</A
1927 CLASS="VARIABLELIST"
1933 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1949 >Effect if unset:</DT
1952 > Privoxy ignores special HTTP headers.
1959 > When toggled on, the client can change <SPAN
1963 behaviour by setting special HTTP headers. Currently the only supported
1964 special header is <SPAN
1966 >"X-Filter: No"</SPAN
1967 >, to disable filtering for
1968 the ongoing request, even if it is enabled in one of the action files.
1971 > This feature is disabled by default. If you are using
1975 > in a environment with trusted clients,
1976 you may enable this feature at your discretion. Note that malicious client
1977 side code (e.g Java) is also capable of using this feature.
1980 > This option will be removed in future releases as it has been obsoleted
1981 by the more general header taggers.
1992 NAME="ENABLE-EDIT-ACTIONS"
1993 >7.4.5. enable-edit-actions</A
1998 CLASS="VARIABLELIST"
2004 > Whether or not the <A
2005 HREF="http://config.privoxy.org/show-status"
2025 >Effect if unset:</DT
2028 > The web-based actions file editor is disabled.
2035 > Access to the editor can <SPAN
2042 controlled separately by <SPAN
2045 > or HTTP authentication,
2046 so that everybody who can access <SPAN
2057 modify its configuration for all users.
2060 > This option is <SPAN
2067 with untrusted users and as a lot of <SPAN
2071 users don't read documentation, this feature is disabled by default.
2074 > Note that malicious client side code (e.g Java) is also
2075 capable of using the actions editor and you shouldn't enable
2076 this options unless you understand the consequences and are
2077 sure your browser is configured correctly.
2080 > Note that you must have compiled <SPAN
2084 support for this feature, otherwise this option has no effect.
2095 NAME="ENFORCE-BLOCKS"
2096 >7.4.6. enforce-blocks</A
2101 CLASS="VARIABLELIST"
2107 > Whether the user is allowed to ignore blocks and can <SPAN
2109 >"go there anyway"</SPAN
2138 >Effect if unset:</DT
2141 > Blocks are not enforced.
2151 > is mainly used to block and filter
2152 requests as a service to the user, for example to block ads and other
2153 junk that clogs the pipes. <SPAN
2157 isn't perfect and sometimes innocent pages are blocked. In this situation it
2158 makes sense to allow the user to enforce the request and have
2165 > In the default configuration <SPAN
2172 > page contains a <SPAN
2174 >"go there anyway"</SPAN
2176 link to adds a special string (the force prefix) to the request URL.
2177 If that link is used, <SPAN
2181 detect the force prefix, remove it again and let the request pass.
2187 > can also be used to enforce
2188 a network policy. In that case the user obviously should not be able to
2189 bypass any blocks, and that's what the <SPAN
2191 >"enforce-blocks"</SPAN
2193 option is for. If it's enabled, <SPAN
2199 >"go there anyway"</SPAN
2200 > link. If the user adds the force
2201 prefix by hand, it will not be accepted and the circumvention attempt
2221 >7.4.7. ACLs: permit-access and deny-access</A
2224 NAME="PERMIT-ACCESS"
2232 CLASS="VARIABLELIST"
2238 > Who can access what.
2280 > are IP addresses in dotted decimal notation or valid
2292 > are subnet masks in CIDR notation, i.e. integer
2293 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2294 destination part are optional.
2310 >Effect if unset:</DT
2313 > Don't restrict access further than implied by <TT
2323 > Access controls are included at the request of ISPs and systems
2324 administrators, and <SPAN
2328 >are not usually needed by individual users</I
2331 For a typical home user, it will normally suffice to ensure that
2335 > only listens on the localhost
2336 (127.0.0.1) or internal (home) network address by means of the
2338 HREF="config.html#LISTEN-ADDRESS"
2350 > Please see the warnings in the FAQ that <SPAN
2354 is not intended to be a substitute for a firewall or to encourage anyone
2355 to defer addressing basic security weaknesses.
2358 > Multiple ACL lines are OK.
2359 If any ACLs are specified, <SPAN
2363 to IP addresses that match at least one <TT
2367 and don't match any subsequent <TT
2370 > line. In other words, the
2371 last match wins, with the default being <TT
2380 > is using a forwarder (see <TT
2384 for a particular destination URL, the <TT
2390 that is examined is the address of the forwarder and <SPAN
2397 of the ultimate target. This is necessary because it may be impossible for the local
2401 > to determine the IP address of the
2402 ultimate target (that's often what gateways are used for).
2405 > You should prefer using IP addresses over DNS names, because the address lookups take
2406 time. All DNS names must resolve! You can <SPAN
2412 > use domain patterns
2416 > or partial domain names. If a DNS name resolves to multiple
2417 IP addresses, only the first one is used.
2420 > Denying access to particular sites by ACL may have undesired side effects
2421 if the site in question is hosted on a machine which also hosts other sites
2429 > Explicitly define the default behavior if no ACL and
2437 is OK. The absence of a <TT
2449 > destination addresses are OK:
2460 > permit-access localhost</PRE
2467 > Allow any host on the same class C subnet as www.privoxy.org access to
2468 nothing but www.example.com (or other domains hosted on the same system):
2479 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2486 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2487 with the exception that 192.168.45.73 may not access the IP address behind
2488 www.dirty-stuff.example.com:
2499 > permit-access 192.168.45.64/26
2500 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2516 >7.4.8. buffer-limit</A
2521 CLASS="VARIABLELIST"
2527 > Maximum size of the buffer for content filtering.
2543 >Effect if unset:</DT
2546 > Use a 4MB (4096 KB) limit.
2553 > For content filtering, i.e. the <TT
2560 > actions, it is necessary that
2564 > buffers the entire document body.
2565 This can be potentially dangerous, since a server could just keep sending
2566 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2570 > When a document buffer size reaches the <TT
2574 flushed to the client unfiltered and no further attempt to
2575 filter the rest of the document is made. Remember that there may be multiple threads
2576 running, which might require up to <TT
2586 >, unless you have enabled <SPAN
2588 >"single-threaded"</SPAN
2606 > This feature allows routing of HTTP requests through a chain of
2607 multiple proxies.</P
2609 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2610 up browsing. Using a parent proxy may also be necessary if the machine
2614 > runs on has no direct Internet access.</P
2616 > Note that parent proxies can severely decrease your privacy level.
2617 For example a parent proxy could add your IP address to the request
2618 headers and if it's a caching proxy it may add the <SPAN
2622 header to revalidation requests again, even though you configured Privoxy
2623 to remove it. It may also ignore Privoxy's header time randomization and use the
2624 original values which could be used by the server as cookie replacement
2625 to track your steps between visits.</P
2627 > Also specified here are SOCKS proxies. <SPAN
2631 supports the SOCKS 4 and SOCKS 4A protocols.</P
2643 CLASS="VARIABLELIST"
2649 > To which parent HTTP proxy specific requests should be routed.
2681 HREF="actions-file.html#AF-PATTERNS"
2684 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2703 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2704 optionally followed by its listening port (default: 8080).
2705 Use a single dot (<TT
2710 >"no forwarding"</SPAN
2727 >Effect if unset:</DT
2730 > Don't use parent HTTP proxies.
2745 >, then requests are not
2746 forwarded to another HTTP proxy but are made directly to the web servers.
2749 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2756 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2767 > forward / parent-proxy.example.org:8080
2775 > Everything goes to our example ISP's caching proxy, except for requests
2776 to that ISP's sites:
2787 > forward / caching-proxy.isp.example.net:8000
2788 forward .isp.example.net .</PRE
2804 >7.5.2. forward-socks4, forward-socks4a and forward-socks5</A
2807 NAME="FORWARD-SOCKS4"
2810 NAME="FORWARD-SOCKS4A"
2815 CLASS="VARIABLELIST"
2821 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2865 HREF="actions-file.html#AF-PATTERNS"
2867 > that specifies to which
2868 requests (i.e. URLs) this forward rule shall apply. Use <TT
2887 are IP addresses in dotted decimal notation or valid DNS names
2899 >"no HTTP forwarding"</SPAN
2900 >), and the optional
2906 > parameters are TCP ports,
2907 i.e. integer values from 1 to 65535
2923 >Effect if unset:</DT
2926 > Don't use SOCKS proxies.
2933 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2936 > The difference between <TT
2941 >forward-socks4a</TT
2943 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2944 server, while in SOCKS 4 it happens locally.
2950 > the DNS resolution will happen on the remote server as well.
2961 >, then requests are not
2962 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2970 > From the company example.com, direct connections are made to all
2974 > domains, but everything outbound goes through
2975 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2987 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2988 forward .example.com .</PRE
2995 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
3006 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3013 > To chain Privoxy and Tor, both running on the same system, you would use
3025 > forward-socks4a / 127.0.0.1:9050 .</PRE
3035 > network can't be used to
3036 reach your local network, if you need to access local servers you
3037 therefore might want to make some exceptions:
3048 > forward 192.168.*.*/ .
3050 forward 127.*.*.*/ .</PRE
3057 > Unencrypted connections to systems in these address ranges will
3058 be as (un)secure as the local network is, but the alternative is that you
3059 can't reach the local network through <SPAN
3063 at all. Of course this may actually be desired and there is no reason
3064 to make these exceptions if you aren't sure you need them.
3067 > If you also want to be able to reach servers in your local network by
3068 using their names, you will need additional exceptions that look like
3080 > forward localhost/ .</PRE
3095 NAME="ADVANCED-FORWARDING-EXAMPLES"
3096 >7.5.3. Advanced Forwarding Examples</A
3099 > If you have links to multiple ISPs that provide various special content
3100 only to their subscribers, you can configure multiple <SPAN
3104 which have connections to the respective ISPs to act as forwarders to each other, so that
3111 > users can see the internal content of all ISPs.</P
3113 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3114 isp-b.example.org. Both run <SPAN
3118 configuration can look like this:</P
3131 forward .isp-b.example.net host-b:8118</PRE
3148 forward .isp-a.example.org host-a:8118</PRE
3154 > Now, your users can set their browser's proxy to use either
3155 host-a or host-b and be able to browse the internal content
3156 of both isp-a and isp-b.</P
3158 > If you intend to chain <SPAN
3165 > locally, then chaining as
3168 >browser -> squid -> privoxy</TT
3169 > is the recommended way. </P
3171 > Assuming that <SPAN
3178 run on the same box, your <SPAN
3181 > configuration could then look like this:</P
3191 > # Define Privoxy as parent proxy (without ICP)
3192 cache_peer 127.0.0.1 parent 8118 7 no-query
3194 # Define ACL for protocol FTP
3197 # Do not forward FTP requests to Privoxy
3198 always_direct allow ftp
3200 # Forward all the rest to Privoxy
3201 never_direct allow all</PRE
3207 > You would then need to change your browser's proxy settings to <SPAN
3210 >'s address and port.
3211 Squid normally uses port 3128. If unsure consult <TT
3219 > You could just as well decide to only forward requests you suspect
3220 of leading to Windows executables through a virus-scanning parent proxy,
3223 >antivir.example.com</TT
3235 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3246 NAME="FORWARDED-CONNECT-RETRIES"
3247 >7.5.4. forwarded-connect-retries</A
3252 CLASS="VARIABLELIST"
3258 > How often Privoxy retries if a forwarded connection request fails.
3268 >Number of retries.</I
3286 >Effect if unset:</DT
3289 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3299 >forwarded-connect-retries</I
3301 > is mainly interesting
3302 for socks4a connections, where <SPAN
3305 > can't detect why the connections failed.
3306 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3307 but it might also have failed because the server doesn't exist or isn't reachable. In this
3308 case the retry will just delay the appearance of Privoxy's error message.
3311 > Note that in the context of this option, <SPAN
3313 >"forwarded connections"</SPAN
3314 > includes all connections
3315 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3318 > Only use this option, if you are getting lots of forwarding-related error messages
3319 that go away when you try again manually. Start with a small value and check Privoxy's
3320 logfile from time to time, to see how many retries are usually needed.
3327 > forwarded-connect-retries 1
3338 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3339 >7.5.5. accept-intercepted-requests</A
3344 CLASS="VARIABLELIST"
3350 > Whether intercepted requests should be treated as valid.
3378 >Effect if unset:</DT
3381 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3388 > If you don't trust your clients and want to force them
3393 option and configure your packet filter to redirect outgoing
3394 HTTP connections into <SPAN
3400 > Make sure that <SPAN
3404 aren't redirected as well. Additionally take care that
3408 > can't intentionally connect
3409 to itself, otherwise you could run into redirection loops if
3413 > listening port is reachable
3414 by the outside or an attacker has access to the pages you visit.
3421 > accept-intercepted-requests 1
3432 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3433 >7.5.6. allow-cgi-request-crunching</A
3438 CLASS="VARIABLELIST"
3444 > Whether requests to <SPAN
3447 > CGI pages can be blocked or redirected.
3475 >Effect if unset:</DT
3481 > ignores block and redirect actions for its CGI pages.
3491 > ignores block or redirect actions
3492 for its CGI pages. Intercepting these requests can be useful in multi-user
3493 setups to implement fine-grained access control, but it can also render the complete
3494 web interface useless and make debugging problems painful if done without care.
3497 > Don't enable this option unless you're sure that you really need it.
3504 > allow-cgi-request-crunching 1
3515 NAME="SPLIT-LARGE-FORMS"
3516 >7.5.7. split-large-forms</A
3521 CLASS="VARIABLELIST"
3527 > Whether the CGI interface should stay compatible with broken HTTP clients.
3555 >Effect if unset:</DT
3558 > The CGI form generate long GET URLs.
3568 > CGI forms can lead to
3569 rather long URLs. This isn't a problem as far as the HTTP
3570 standard is concerned, but it can confuse clients with arbitrary
3571 URL length limitations.
3574 > Enabling split-large-forms causes <SPAN
3578 to divide big forms into smaller ones to keep the URL length down.
3579 It makes editing a lot less convenient and you can no longer
3580 submit all changes at once, but at least it works around this
3584 > If you don't notice any editing problems, there is no reason
3585 to enable this option, but if one of the submit buttons appears
3586 to be broken, you should give it a try.
3593 > split-large-forms 1
3606 >7.6. Windows GUI Options</A
3612 > has a number of options specific to the
3613 Windows GUI interface:</P
3615 NAME="ACTIVITY-ANIMATION"
3620 >"activity-animation"</SPAN
3625 > icon will animate when
3629 > is active. To turn off, set to 0.</P
3634 CLASS="LITERALLAYOUT"
3639 >activity-animation 1</I
3642 </P
3652 >"log-messages"</SPAN
3657 > will log messages to the console
3663 CLASS="LITERALLAYOUT"
3671 </P
3676 NAME="LOG-BUFFER-SIZE"
3682 >"log-buffer-size"</SPAN
3683 > is set to 1, the size of the log buffer,
3684 i.e. the amount of memory used for the log messages displayed in the
3685 console window, will be limited to <SPAN
3687 >"log-max-lines"</SPAN
3690 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3691 eat up all your memory!</P
3696 CLASS="LITERALLAYOUT"
3701 >log-buffer-size 1</I
3704 </P
3709 NAME="LOG-MAX-LINES"
3714 >log-max-lines</SPAN
3715 > is the maximum number of lines held
3716 in the log buffer. See above.</P
3721 CLASS="LITERALLAYOUT"
3726 >log-max-lines 200</I
3729 </P
3734 NAME="LOG-HIGHLIGHT-MESSAGES"
3739 >"log-highlight-messages"</SPAN
3744 > will highlight portions of the log
3745 messages with a bold-faced font:</P
3750 CLASS="LITERALLAYOUT"
3755 >log-highlight-messages 1</I
3758 </P
3763 NAME="LOG-FONT-NAME"
3766 > The font used in the console window:</P
3771 CLASS="LITERALLAYOUT"
3776 >log-font-name Comic Sans MS</I
3779 </P
3784 NAME="LOG-FONT-SIZE"
3787 > Font size used in the console window:</P
3792 CLASS="LITERALLAYOUT"
3800 </P
3805 NAME="SHOW-ON-TASK-BAR"
3811 >"show-on-task-bar"</SPAN
3812 > controls whether or not
3816 > will appear as a button on the Task bar
3822 CLASS="LITERALLAYOUT"
3827 >show-on-task-bar 0</I
3830 </P
3835 NAME="CLOSE-BUTTON-MINIMIZES"
3840 >"close-button-minimizes"</SPAN
3841 > is set to 1, the Windows close
3842 button will minimize <SPAN
3845 > instead of closing
3846 the program (close with the exit option on the File menu).</P
3851 CLASS="LITERALLAYOUT"
3856 >close-button-minimizes 1</I
3859 </P
3869 >"hide-console"</SPAN
3870 > option is specific to the MS-Win console
3874 >. If this option is used,
3878 > will disconnect from and hide the
3884 CLASS="LITERALLAYOUT"
3892 </P
3903 SUMMARY="Footer navigation table"
3914 HREF="configuration.html"
3932 HREF="actions-file.html"
3942 >Privoxy Configuration</TD