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.
375 >Effect if unset:</DT
378 > No links are displayed on the "untrusted" error page.
385 > The value of this option only matters if the experimental trust mechanism has been
387 HREF="config.html#TRUSTFILE"
398 > If you use the trust mechanism, it is a good idea to write up some on-line
399 documentation about your trust policy and to specify the URL(s) here.
400 Use multiple times for multiple URLs.
403 > The URL(s) should be added to the trustfile as well, so users don't end up
404 locked out from the information on why they were locked out in the first place!
416 >7.1.3. admin-address</A
427 > An email address to reach the <SPAN
452 >Effect if unset:</DT
455 > No email address is displayed on error pages and the CGI user interface.
469 are unset, the whole "Local Privoxy Support" box on all generated pages will
481 NAME="PROXY-INFO-URL"
482 >7.1.4. proxy-info-url</A
493 > A URL to documentation about the local <SPAN
497 configuration or policies.
519 >Effect if unset:</DT
522 > No link to local documentation is displayed on error pages and the CGI user interface.
536 are unset, the whole "Local Privoxy Support" box on all generated pages will
540 > This URL shouldn't be blocked ;-)
553 >7.2. Configuration and Log File Locations</A
559 > can (and normally does) use a number of
560 other files for additional configuration, help and logging.
561 This section of the configuration file tells <SPAN
565 where to find those other files. </P
567 > The user running <SPAN
571 permission for all configuration files, and write permission to any files
572 that would be modified, such as log files and actions files.</P
590 >The directory where the other configuration files are located.</P
602 >/etc/privoxy (Unix) <SPAN
611 > installation dir (Windows) </P
614 >Effect if unset:</DT
658 >An alternative directory where the templates are loaded from.</P
673 >Effect if unset:</DT
676 >The templates are assumed to be located in confdir/template.</P
685 > original templates are usually
686 overwritten with each update. Use this option to relocate customized
687 templates that should be kept. As template variables might change
688 between updates, you shouldn't expect templates to work with
692 > releases other than the one
693 they were part of, though.
716 > The directory where all logging takes place
733 >/var/log/privoxy (Unix) <SPAN
742 > installation dir (Windows) </P
745 >Effect if unset:</DT
778 >7.2.4. actionsfile</A
781 NAME="DEFAULT.ACTION"
784 NAME="STANDARD.ACTION"
799 HREF="actions-file.html"
808 >Complete file name, relative to <TT
824 CLASS="LITERALLAYOUT"
825 > match-all.action # Actions that are applied to all sites and maybe overruled later on.</P
832 CLASS="LITERALLAYOUT"
833 > default.action # Main actions file</P
840 CLASS="LITERALLAYOUT"
841 > user.action # User customizations</P
851 >Effect if unset:</DT
854 > No actions are taken at all. More or less neutral proxying.
864 > lines are permitted, and are in fact recommended!
868 The default values are <TT
875 > actions file maintained by the developers, and
879 >, where you can make your personal additions.
883 Actions files contain all the per site and per URL configuration for
884 ad blocking, cookie management, privacy considerations, etc.
885 There is no point in using <SPAN
889 least one actions file.
892 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
896 extension has to be specified. The syntax change was necessary to be consistent
897 with the other file options and to allow previously forbidden characters.
909 >7.2.5. filterfile</A
912 NAME="DEFAULT.FILTER"
924 HREF="filter-file.html"
933 >File name, relative to <TT
942 >default.filter (Unix) <SPAN
948 > default.filter.txt (Windows)</P
951 >Effect if unset:</DT
954 > No textual content filtering takes place, i.e. all
958 HREF="actions-file.html#FILTER"
967 actions in the actions files are turned neutral.
977 > lines are permitted.
981 HREF="filter-file.html"
983 > contain content modification
985 HREF="appendix.html#REGEX"
986 >regular expressions</A
987 >. These rules permit
988 powerful changes on the content of Web pages, and optionally the headers
989 as well, e.g., you could try to disable your favorite JavaScript annoyances,
990 re-write the actual displayed text, or just have some fun
991 playing buzzword bingo with web pages.
998 HREF="actions-file.html#FILTER"
1007 actions rely on the relevant filter (<TT
1013 to be defined in a filter file!
1016 > A pre-defined filter file called <TT
1020 a number of useful filters for common problems is included in the distribution.
1021 See the section on the <TT
1024 HREF="actions-file.html#FILTER"
1031 > It is recommended to place any locally adapted filters into a separate
1052 CLASS="VARIABLELIST"
1058 > The log file to use
1065 >File name, relative to <TT
1078 >Unset (commented out)</I
1080 >. When activated: logfile (Unix) <SPAN
1086 > privoxy.log (Windows).</P
1089 >Effect if unset:</DT
1092 > No logfile is written.
1099 > The logfile is where all logging and error messages are written. The level
1100 of detail and number of messages are set with the <TT
1104 option (see below). The logfile can be useful for tracking down a problem with
1108 > (e.g., it's not blocking an ad you
1109 think it should block) and it can help you to monitor what your browser
1113 > Depending on the debug options below, the logfile may be a privacy risk
1114 if third parties can get access to it. As most users will never look
1118 > 3.0.7 and later only log fatal
1122 > For most troubleshooting purposes, you will have to change that,
1123 please refer to the debugging section for details.
1126 > Your logfile will grow indefinitely, and you will probably want to
1127 periodically remove it. On Unix systems, you can do this with a cron job
1131 >). For Red Hat based Linux distributions, a
1135 > script has been included.
1138 > Any log files must be writable by whatever user <SPAN
1142 is being run as (on Unix, default user id is <SPAN
1157 >7.2.7. trustfile</A
1162 CLASS="VARIABLELIST"
1168 > The name of the trust file to use
1175 >File name, relative to <TT
1188 >Unset (commented out)</I
1190 >. When activated: trust (Unix) <SPAN
1196 > trust.txt (Windows)</P
1199 >Effect if unset:</DT
1202 > The entire trust mechanism is disabled.
1209 > The trust mechanism is an experimental feature for building white-lists and should
1210 be used with care. It is <SPAN
1216 > recommended for the casual user.
1219 > If you specify a trust file, <SPAN
1223 access to sites that are specified in the trustfile. Sites can be listed
1230 > character limits access to this site
1231 only (and any sub-paths within this site), e.g.
1234 >~www.example.com</TT
1238 >~www.example.com/features/news.html</TT
1242 > Or, you can designate sites as <SPAN
1246 >trusted referrers</I
1249 prepending the name with a <TT
1252 > character. The effect is that
1253 access to untrusted sites will be granted -- but only if a link from this
1254 trusted referrer was used to get there. The link target will then be added
1258 > so that future, direct accesses will be
1259 granted. Sites added via this mechanism do not become trusted referrers
1260 themselves (i.e. they are added with a <TT
1264 There is a limit of 512 such entries, after which new entries will not be
1268 > If you use the <TT
1271 > operator in the trust file, it may grow
1272 considerably over time.
1275 > It is recommended that <SPAN
1281 >--disable-force</TT
1284 >--disable-toggle</TT
1288 > --disable-editor</TT
1289 > options, if this feature is to be
1293 > Possible applications include limiting Internet access for children.
1309 > These options are mainly useful when tracing a problem.
1310 Note that you might also want to invoke
1318 command line option when debugging.
1331 CLASS="VARIABLELIST"
1337 > Key values that determine what information gets logged.
1350 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1353 >Effect if unset:</DT
1356 > Default value is used (see above).
1363 > The available debug levels are:
1373 CLASS="PROGRAMLISTING"
1374 > debug 1 # Log the destination for each request <SPAN
1377 > let through. See also debug 1024.
1378 debug 2 # show each connection status
1379 debug 4 # show I/O status
1380 debug 8 # show header parsing
1381 debug 16 # log all data written to the network into the logfile
1382 debug 32 # debug force feature
1383 debug 64 # debug regular expression filters
1384 debug 128 # debug redirects
1385 debug 256 # debug GIF de-animation
1386 debug 512 # Common Log Format
1387 debug 1024 # Log the destination for requests <SPAN
1390 > didn't let through, and the reason why.
1391 debug 2048 # CGI user interface
1392 debug 4096 # Startup banner and warnings.
1393 debug 8192 # Non-fatal errors</PRE
1400 > To select multiple debug levels, you can either add them or use
1407 > A debug level of 1 is informative because it will show you each request
1408 as it happens. <SPAN
1412 >1, 4096 and 8192 are recommended</I
1415 so that you will notice when things go wrong. The other levels are
1416 probably only of interest if you are hunting down a specific problem.
1417 They can produce a hell of an output (especially 16).
1424 > used to ship with the debug levels recommended above enabled by
1425 default, but due to privacy concerns 3.0.7 and later are configured to
1426 only log fatal errors.
1429 > If you are used to the more verbose settings, simply enable the debug lines
1433 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1443 > and not enable anything else.
1449 > has a hard-coded limit for the
1450 length of log messages. If it's reached, messages are logged truncated
1451 and marked with <SPAN
1453 >"... [too long, truncated]"</SPAN
1457 > Please don't file any support requests without trying to reproduce
1458 the problem with increased debug level first. Once you read the log
1459 messages, you may even be able to solve the problem on your own.
1470 NAME="SINGLE-THREADED"
1471 >7.3.2. single-threaded</A
1476 CLASS="VARIABLELIST"
1482 > Whether to run only one server thread.
1510 >Effect if unset:</DT
1513 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1514 serve multiple requests simultaneously.
1521 > This option is only there for debugging purposes.
1526 >It will drastically reduce performance.</I
1545 CLASS="VARIABLELIST"
1551 > The hostname shown on the CGI pages.
1573 >Effect if unset:</DT
1576 > The hostname provided by the operating system is used.
1583 > On some misconfigured systems resolving the hostname fails or
1584 takes too much time and slows Privoxy down. Setting a fixed hostname
1585 works around the problem.
1588 > In other circumstances it might be desirable to show a hostname
1589 other than the one returned by the operating system. For example
1590 if the system has several different hostnames and you don't want
1591 to use the first one.
1594 > Note that Privoxy does not validate the specified hostname value.
1606 NAME="ACCESS-CONTROL"
1607 >7.4. Access Control and Security</A
1610 > This section of the config file controls the security-relevant aspects
1621 NAME="LISTEN-ADDRESS"
1622 >7.4.1. listen-address</A
1627 CLASS="VARIABLELIST"
1633 > The IP address and TCP port on which <SPAN
1637 listen for client requests.
1663 >Effect if unset:</DT
1666 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1667 home users who run <SPAN
1670 > on the same machine as
1678 > You will need to configure your browser(s) to this proxy address and port.
1681 > If you already have another service running on port 8118, or if you want to
1682 serve requests from other machines (e.g. on your local network) as well, you
1683 will need to override the default.
1686 > If you leave out the IP address, <SPAN
1690 bind to all interfaces (addresses) on your machine and may become reachable
1691 from the Internet. In that case, consider using <A
1692 HREF="config.html#ACLS"
1693 >access control lists</A
1694 > (ACL's, see below), and/or
1701 > to untrusted users, you will
1702 also want to make sure that the following actions are disabled: <TT
1705 HREF="config.html#ENABLE-EDIT-ACTIONS"
1706 >enable-edit-actions</A
1712 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1713 >enable-remote-toggle</A
1722 > Suppose you are running <SPAN
1726 a machine which has the address 192.168.0.1 on your local private network
1727 (192.168.0.0) and has another outside connection with a different address.
1728 You want it to serve requests from inside only:
1738 CLASS="PROGRAMLISTING"
1739 > listen-address 192.168.0.1:8118</PRE
1760 CLASS="VARIABLELIST"
1766 > Initial state of "toggle" status
1782 >Effect if unset:</DT
1785 > Act as if toggled on
1792 > If set to 0, <SPAN
1798 >"toggled off"</SPAN
1799 > mode, i.e. mostly behave like a normal,
1800 content-neutral proxy with both ad blocking and content filtering
1803 >enable-remote-toggle</TT
1807 > The windows version will only display the toggle icon in the system tray
1808 if this option is present.
1819 NAME="ENABLE-REMOTE-TOGGLE"
1820 >7.4.3. enable-remote-toggle</A
1825 CLASS="VARIABLELIST"
1831 > Whether or not the <A
1832 HREF="http://config.privoxy.org/toggle"
1852 >Effect if unset:</DT
1855 > The web-based toggle feature is disabled.
1862 > When toggled off, <SPAN
1865 > mostly acts like a normal,
1866 content-neutral proxy, i.e. doesn't block ads or filter content.
1869 > Access to the toggle feature can <SPAN
1876 controlled separately by <SPAN
1879 > or HTTP authentication,
1880 so that everybody who can access <SPAN
1891 toggle it for all users. So this option is <SPAN
1898 for multi-user environments with untrusted users.
1901 > Note that malicious client side code (e.g Java) is also
1902 capable of using this option.
1909 documentation, this feature is disabled by default.
1912 > Note that you must have compiled <SPAN
1916 support for this feature, otherwise this option has no effect.
1927 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1928 >7.4.4. enable-remote-http-toggle</A
1933 CLASS="VARIABLELIST"
1939 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1955 >Effect if unset:</DT
1958 > Privoxy ignores special HTTP headers.
1965 > When toggled on, the client can change <SPAN
1969 behaviour by setting special HTTP headers. Currently the only supported
1970 special header is <SPAN
1972 >"X-Filter: No"</SPAN
1973 >, to disable filtering for
1974 the ongoing request, even if it is enabled in one of the action files.
1977 > This feature is disabled by default. If you are using
1981 > in a environment with trusted clients,
1982 you may enable this feature at your discretion. Note that malicious client
1983 side code (e.g Java) is also capable of using this feature.
1986 > This option will be removed in future releases as it has been obsoleted
1987 by the more general header taggers.
1998 NAME="ENABLE-EDIT-ACTIONS"
1999 >7.4.5. enable-edit-actions</A
2004 CLASS="VARIABLELIST"
2010 > Whether or not the <A
2011 HREF="http://config.privoxy.org/show-status"
2031 >Effect if unset:</DT
2034 > The web-based actions file editor is disabled.
2041 > Access to the editor can <SPAN
2048 controlled separately by <SPAN
2051 > or HTTP authentication,
2052 so that everybody who can access <SPAN
2063 modify its configuration for all users.
2066 > This option is <SPAN
2073 with untrusted users and as a lot of <SPAN
2077 users don't read documentation, this feature is disabled by default.
2080 > Note that malicious client side code (e.g Java) is also
2081 capable of using the actions editor and you shouldn't enable
2082 this options unless you understand the consequences and are
2083 sure your browser is configured correctly.
2086 > Note that you must have compiled <SPAN
2090 support for this feature, otherwise this option has no effect.
2101 NAME="ENFORCE-BLOCKS"
2102 >7.4.6. enforce-blocks</A
2107 CLASS="VARIABLELIST"
2113 > Whether the user is allowed to ignore blocks and can <SPAN
2115 >"go there anyway"</SPAN
2144 >Effect if unset:</DT
2147 > Blocks are not enforced.
2157 > is mainly used to block and filter
2158 requests as a service to the user, for example to block ads and other
2159 junk that clogs the pipes. <SPAN
2163 isn't perfect and sometimes innocent pages are blocked. In this situation it
2164 makes sense to allow the user to enforce the request and have
2171 > In the default configuration <SPAN
2178 > page contains a <SPAN
2180 >"go there anyway"</SPAN
2182 link to adds a special string (the force prefix) to the request URL.
2183 If that link is used, <SPAN
2187 detect the force prefix, remove it again and let the request pass.
2193 > can also be used to enforce
2194 a network policy. In that case the user obviously should not be able to
2195 bypass any blocks, and that's what the <SPAN
2197 >"enforce-blocks"</SPAN
2199 option is for. If it's enabled, <SPAN
2205 >"go there anyway"</SPAN
2206 > link. If the user adds the force
2207 prefix by hand, it will not be accepted and the circumvention attempt
2227 >7.4.7. ACLs: permit-access and deny-access</A
2230 NAME="PERMIT-ACCESS"
2238 CLASS="VARIABLELIST"
2244 > Who can access what.
2286 > are IP addresses in dotted decimal notation or valid
2298 > are subnet masks in CIDR notation, i.e. integer
2299 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2300 destination part are optional.
2316 >Effect if unset:</DT
2319 > Don't restrict access further than implied by <TT
2329 > Access controls are included at the request of ISPs and systems
2330 administrators, and <SPAN
2334 >are not usually needed by individual users</I
2337 For a typical home user, it will normally suffice to ensure that
2341 > only listens on the localhost
2342 (127.0.0.1) or internal (home) network address by means of the
2344 HREF="config.html#LISTEN-ADDRESS"
2356 > Please see the warnings in the FAQ that <SPAN
2360 is not intended to be a substitute for a firewall or to encourage anyone
2361 to defer addressing basic security weaknesses.
2364 > Multiple ACL lines are OK.
2365 If any ACLs are specified, <SPAN
2369 to IP addresses that match at least one <TT
2373 and don't match any subsequent <TT
2376 > line. In other words, the
2377 last match wins, with the default being <TT
2386 > is using a forwarder (see <TT
2390 for a particular destination URL, the <TT
2396 that is examined is the address of the forwarder and <SPAN
2403 of the ultimate target. This is necessary because it may be impossible for the local
2407 > to determine the IP address of the
2408 ultimate target (that's often what gateways are used for).
2411 > You should prefer using IP addresses over DNS names, because the address lookups take
2412 time. All DNS names must resolve! You can <SPAN
2418 > use domain patterns
2422 > or partial domain names. If a DNS name resolves to multiple
2423 IP addresses, only the first one is used.
2426 > Denying access to particular sites by ACL may have undesired side effects
2427 if the site in question is hosted on a machine which also hosts other sites
2435 > Explicitly define the default behavior if no ACL and
2443 is OK. The absence of a <TT
2455 > destination addresses are OK:
2466 > permit-access localhost</PRE
2473 > Allow any host on the same class C subnet as www.privoxy.org access to
2474 nothing but www.example.com (or other domains hosted on the same system):
2485 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2492 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2493 with the exception that 192.168.45.73 may not access the IP address behind
2494 www.dirty-stuff.example.com:
2505 > permit-access 192.168.45.64/26
2506 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2522 >7.4.8. buffer-limit</A
2527 CLASS="VARIABLELIST"
2533 > Maximum size of the buffer for content filtering.
2549 >Effect if unset:</DT
2552 > Use a 4MB (4096 KB) limit.
2559 > For content filtering, i.e. the <TT
2566 > actions, it is necessary that
2570 > buffers the entire document body.
2571 This can be potentially dangerous, since a server could just keep sending
2572 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2576 > When a document buffer size reaches the <TT
2580 flushed to the client unfiltered and no further attempt to
2581 filter the rest of the document is made. Remember that there may be multiple threads
2582 running, which might require up to <TT
2592 >, unless you have enabled <SPAN
2594 >"single-threaded"</SPAN
2612 > This feature allows routing of HTTP requests through a chain of
2613 multiple proxies.</P
2615 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2616 up browsing. Using a parent proxy may also be necessary if the machine
2620 > runs on has no direct Internet access.</P
2622 > Note that parent proxies can severely decrease your privacy level.
2623 For example a parent proxy could add your IP address to the request
2624 headers and if it's a caching proxy it may add the <SPAN
2628 header to revalidation requests again, even though you configured Privoxy
2629 to remove it. It may also ignore Privoxy's header time randomization and use the
2630 original values which could be used by the server as cookie replacement
2631 to track your steps between visits.</P
2633 > Also specified here are SOCKS proxies. <SPAN
2637 supports the SOCKS 4 and SOCKS 4A protocols.</P
2649 CLASS="VARIABLELIST"
2655 > To which parent HTTP proxy specific requests should be routed.
2687 HREF="actions-file.html#AF-PATTERNS"
2690 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2709 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2710 optionally followed by its listening port (default: 8080).
2711 Use a single dot (<TT
2716 >"no forwarding"</SPAN
2733 >Effect if unset:</DT
2736 > Don't use parent HTTP proxies.
2751 >, then requests are not
2752 forwarded to another HTTP proxy but are made directly to the web servers.
2755 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2762 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2773 > forward / parent-proxy.example.org:8080
2781 > Everything goes to our example ISP's caching proxy, except for requests
2782 to that ISP's sites:
2793 > forward / caching-proxy.isp.example.net:8000
2794 forward .isp.example.net .</PRE
2810 >7.5.2. forward-socks4, forward-socks4a and forward-socks5</A
2813 NAME="FORWARD-SOCKS4"
2816 NAME="FORWARD-SOCKS4A"
2821 CLASS="VARIABLELIST"
2827 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2871 HREF="actions-file.html#AF-PATTERNS"
2873 > that specifies to which
2874 requests (i.e. URLs) this forward rule shall apply. Use <TT
2893 are IP addresses in dotted decimal notation or valid DNS names
2905 >"no HTTP forwarding"</SPAN
2906 >), and the optional
2912 > parameters are TCP ports,
2913 i.e. integer values from 1 to 65535
2929 >Effect if unset:</DT
2932 > Don't use SOCKS proxies.
2939 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2942 > The difference between <TT
2947 >forward-socks4a</TT
2949 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2950 server, while in SOCKS 4 it happens locally.
2956 > the DNS resolution will happen on the remote server as well.
2967 >, then requests are not
2968 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2976 > From the company example.com, direct connections are made to all
2980 > domains, but everything outbound goes through
2981 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2993 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2994 forward .example.com .</PRE
3001 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
3012 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3019 > To chain Privoxy and Tor, both running on the same system, you would use
3031 > forward-socks4a / 127.0.0.1:9050 .</PRE
3041 > network can't be used to
3042 reach your local network, if you need to access local servers you
3043 therefore might want to make some exceptions:
3054 > forward 192.168.*.*/ .
3056 forward 127.*.*.*/ .</PRE
3063 > Unencrypted connections to systems in these address ranges will
3064 be as (un)secure as the local network is, but the alternative is that you
3065 can't reach the local network through <SPAN
3069 at all. Of course this may actually be desired and there is no reason
3070 to make these exceptions if you aren't sure you need them.
3073 > If you also want to be able to reach servers in your local network by
3074 using their names, you will need additional exceptions that look like
3086 > forward localhost/ .</PRE
3101 NAME="ADVANCED-FORWARDING-EXAMPLES"
3102 >7.5.3. Advanced Forwarding Examples</A
3105 > If you have links to multiple ISPs that provide various special content
3106 only to their subscribers, you can configure multiple <SPAN
3110 which have connections to the respective ISPs to act as forwarders to each other, so that
3117 > users can see the internal content of all ISPs.</P
3119 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3120 isp-b.example.org. Both run <SPAN
3124 configuration can look like this:</P
3137 forward .isp-b.example.net host-b:8118</PRE
3154 forward .isp-a.example.org host-a:8118</PRE
3160 > Now, your users can set their browser's proxy to use either
3161 host-a or host-b and be able to browse the internal content
3162 of both isp-a and isp-b.</P
3164 > If you intend to chain <SPAN
3171 > locally, then chaining as
3174 >browser -> squid -> privoxy</TT
3175 > is the recommended way. </P
3177 > Assuming that <SPAN
3184 run on the same box, your <SPAN
3187 > configuration could then look like this:</P
3197 > # Define Privoxy as parent proxy (without ICP)
3198 cache_peer 127.0.0.1 parent 8118 7 no-query
3200 # Define ACL for protocol FTP
3203 # Do not forward FTP requests to Privoxy
3204 always_direct allow ftp
3206 # Forward all the rest to Privoxy
3207 never_direct allow all</PRE
3213 > You would then need to change your browser's proxy settings to <SPAN
3216 >'s address and port.
3217 Squid normally uses port 3128. If unsure consult <TT
3225 > You could just as well decide to only forward requests you suspect
3226 of leading to Windows executables through a virus-scanning parent proxy,
3229 >antivir.example.com</TT
3241 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3252 NAME="FORWARDED-CONNECT-RETRIES"
3253 >7.5.4. forwarded-connect-retries</A
3258 CLASS="VARIABLELIST"
3264 > How often Privoxy retries if a forwarded connection request fails.
3274 >Number of retries.</I
3292 >Effect if unset:</DT
3295 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3305 >forwarded-connect-retries</I
3307 > is mainly interesting
3308 for socks4a connections, where <SPAN
3311 > can't detect why the connections failed.
3312 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3313 but it might also have failed because the server doesn't exist or isn't reachable. In this
3314 case the retry will just delay the appearance of Privoxy's error message.
3317 > Note that in the context of this option, <SPAN
3319 >"forwarded connections"</SPAN
3320 > includes all connections
3321 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3324 > Only use this option, if you are getting lots of forwarding-related error messages
3325 that go away when you try again manually. Start with a small value and check Privoxy's
3326 logfile from time to time, to see how many retries are usually needed.
3333 > forwarded-connect-retries 1
3344 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3345 >7.5.5. accept-intercepted-requests</A
3350 CLASS="VARIABLELIST"
3356 > Whether intercepted requests should be treated as valid.
3384 >Effect if unset:</DT
3387 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3394 > If you don't trust your clients and want to force them
3399 option and configure your packet filter to redirect outgoing
3400 HTTP connections into <SPAN
3406 > Make sure that <SPAN
3410 aren't redirected as well. Additionally take care that
3414 > can't intentionally connect
3415 to itself, otherwise you could run into redirection loops if
3419 > listening port is reachable
3420 by the outside or an attacker has access to the pages you visit.
3427 > accept-intercepted-requests 1
3438 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3439 >7.5.6. allow-cgi-request-crunching</A
3444 CLASS="VARIABLELIST"
3450 > Whether requests to <SPAN
3453 > CGI pages can be blocked or redirected.
3481 >Effect if unset:</DT
3487 > ignores block and redirect actions for its CGI pages.
3497 > ignores block or redirect actions
3498 for its CGI pages. Intercepting these requests can be useful in multi-user
3499 setups to implement fine-grained access control, but it can also render the complete
3500 web interface useless and make debugging problems painful if done without care.
3503 > Don't enable this option unless you're sure that you really need it.
3510 > allow-cgi-request-crunching 1
3521 NAME="SPLIT-LARGE-FORMS"
3522 >7.5.7. split-large-forms</A
3527 CLASS="VARIABLELIST"
3533 > Whether the CGI interface should stay compatible with broken HTTP clients.
3561 >Effect if unset:</DT
3564 > The CGI form generate long GET URLs.
3574 > CGI forms can lead to
3575 rather long URLs. This isn't a problem as far as the HTTP
3576 standard is concerned, but it can confuse clients with arbitrary
3577 URL length limitations.
3580 > Enabling split-large-forms causes <SPAN
3584 to divide big forms into smaller ones to keep the URL length down.
3585 It makes editing a lot less convenient and you can no longer
3586 submit all changes at once, but at least it works around this
3590 > If you don't notice any editing problems, there is no reason
3591 to enable this option, but if one of the submit buttons appears
3592 to be broken, you should give it a try.
3599 > split-large-forms 1
3610 NAME="KEEP-ALIVE-TIMEOUT"
3611 >7.5.8. keep-alive-timeout</A
3616 CLASS="VARIABLELIST"
3622 > Number of seconds after which an open connection will no longer be reused.
3632 >Time in seconds.</I
3644 >Effect if unset:</DT
3647 > Connections are not reused.
3654 > This option has no effect if <SPAN
3658 has been compiled without keep-alive support.
3665 > keep-alive-timeout 300
3676 NAME="SOCKET-TIMEOUT"
3677 >7.5.9. socket-timeout</A
3682 CLASS="VARIABLELIST"
3688 > Number of seconds after which a socket times out if
3689 no data is received.
3699 >Time in seconds.</I
3711 >Effect if unset:</DT
3714 > A default value of 300 seconds is used.
3721 > For SOCKS requests the timeout currently doesn't start until
3722 the SOCKS server accepted the request. This will be fixed in
3730 > socket-timeout 300
3743 >7.6. Windows GUI Options</A
3749 > has a number of options specific to the
3750 Windows GUI interface:</P
3752 NAME="ACTIVITY-ANIMATION"
3757 >"activity-animation"</SPAN
3762 > icon will animate when
3766 > is active. To turn off, set to 0.</P
3771 CLASS="LITERALLAYOUT"
3776 >activity-animation 1</I
3779 </P
3789 >"log-messages"</SPAN
3794 > will log messages to the console
3800 CLASS="LITERALLAYOUT"
3808 </P
3813 NAME="LOG-BUFFER-SIZE"
3819 >"log-buffer-size"</SPAN
3820 > is set to 1, the size of the log buffer,
3821 i.e. the amount of memory used for the log messages displayed in the
3822 console window, will be limited to <SPAN
3824 >"log-max-lines"</SPAN
3827 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3828 eat up all your memory!</P
3833 CLASS="LITERALLAYOUT"
3838 >log-buffer-size 1</I
3841 </P
3846 NAME="LOG-MAX-LINES"
3851 >log-max-lines</SPAN
3852 > is the maximum number of lines held
3853 in the log buffer. See above.</P
3858 CLASS="LITERALLAYOUT"
3863 >log-max-lines 200</I
3866 </P
3871 NAME="LOG-HIGHLIGHT-MESSAGES"
3876 >"log-highlight-messages"</SPAN
3881 > will highlight portions of the log
3882 messages with a bold-faced font:</P
3887 CLASS="LITERALLAYOUT"
3892 >log-highlight-messages 1</I
3895 </P
3900 NAME="LOG-FONT-NAME"
3903 > The font used in the console window:</P
3908 CLASS="LITERALLAYOUT"
3913 >log-font-name Comic Sans MS</I
3916 </P
3921 NAME="LOG-FONT-SIZE"
3924 > Font size used in the console window:</P
3929 CLASS="LITERALLAYOUT"
3937 </P
3942 NAME="SHOW-ON-TASK-BAR"
3948 >"show-on-task-bar"</SPAN
3949 > controls whether or not
3953 > will appear as a button on the Task bar
3959 CLASS="LITERALLAYOUT"
3964 >show-on-task-bar 0</I
3967 </P
3972 NAME="CLOSE-BUTTON-MINIMIZES"
3977 >"close-button-minimizes"</SPAN
3978 > is set to 1, the Windows close
3979 button will minimize <SPAN
3982 > instead of closing
3983 the program (close with the exit option on the File menu).</P
3988 CLASS="LITERALLAYOUT"
3993 >close-button-minimizes 1</I
3996 </P
4006 >"hide-console"</SPAN
4007 > option is specific to the MS-Win console
4011 >. If this option is used,
4015 > will disconnect from and hide the
4021 CLASS="LITERALLAYOUT"
4029 </P
4040 SUMMARY="Footer navigation table"
4051 HREF="configuration.html"
4069 HREF="actions-file.html"
4079 >Privoxy Configuration</TD