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.7 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.7 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 > Logging is disabled unless <TT
1101 > The logfile is where all logging and error messages are written. The level
1102 of detail and number of messages are set with the <TT
1106 option (see below). The logfile can be useful for tracking down a problem with
1110 > (e.g., it's not blocking an ad you
1111 think it should block) and it can help you to monitor what your browser
1115 > Many users will never look at it, however, and it's a privacy risk
1116 if third parties can get access to it. It is therefore disabled by
1123 > For troubleshooting purposes, you will have to explicitly enable it.
1124 Please don't file any support requests without trying to reproduce
1125 the problem with logging enabled first. Once you read the log messages,
1126 you may even be able to solve the problem on your own.
1129 > Your logfile will grow indefinitely, and you will probably want to
1130 periodically remove it. On Unix systems, you can do this with a cron job
1134 >). For Red Hat based Linux distributions, a
1138 > script has been included.
1141 > Any log files must be writable by whatever user <SPAN
1145 is being run as (on Unix, default user id is <SPAN
1165 CLASS="VARIABLELIST"
1171 > The file to store intercepted cookies in
1178 >File name, relative to <TT
1191 >Unset (commented out)</I
1193 >. When activated: jarfile (Unix) <SPAN
1199 > privoxy.jar (Windows).</P
1202 >Effect if unset:</DT
1205 > Intercepted cookies are not stored in a dedicated log file.
1212 > The jarfile may grow to ridiculous sizes over time.
1215 > If debug 8 (show header parsing) is enabled, cookies are
1216 also written to the logfile with the rest of the headers.
1217 Therefore this option isn't very useful and may be removed
1218 in future releases. Please report to the developers if you
1231 >7.2.8. trustfile</A
1236 CLASS="VARIABLELIST"
1242 > The name of the trust file to use
1249 >File name, relative to <TT
1262 >Unset (commented out)</I
1264 >. When activated: trust (Unix) <SPAN
1270 > trust.txt (Windows)</P
1273 >Effect if unset:</DT
1276 > The entire trust mechanism is disabled.
1283 > The trust mechanism is an experimental feature for building white-lists and should
1284 be used with care. It is <SPAN
1290 > recommended for the casual user.
1293 > If you specify a trust file, <SPAN
1297 access to sites that are specified in the trustfile. Sites can be listed
1304 > character limits access to this site
1305 only (and any sub-paths within this site), e.g.
1308 >~www.example.com</TT
1312 >~www.example.com/features/news.html</TT
1316 > Or, you can designate sites as <SPAN
1320 >trusted referrers</I
1323 prepending the name with a <TT
1326 > character. The effect is that
1327 access to untrusted sites will be granted -- but only if a link from this
1328 trusted referrer was used to get there. The link target will then be added
1332 > so that future, direct accesses will be
1333 granted. Sites added via this mechanism do not become trusted referrers
1334 themselves (i.e. they are added with a <TT
1338 There is a limit of 512 such entries, after which new entries will not be
1342 > If you use the <TT
1345 > operator in the trust file, it may grow
1346 considerably over time.
1349 > It is recommended that <SPAN
1355 >--disable-force</TT
1358 >--disable-toggle</TT
1362 > --disable-editor</TT
1363 > options, if this feature is to be
1367 > Possible applications include limiting Internet access for children.
1383 > These options are mainly useful when tracing a problem.
1384 Note that you might also want to invoke
1392 command line option when debugging.
1405 CLASS="VARIABLELIST"
1411 > Key values that determine what information gets logged to the
1413 HREF="config.html#LOGFILE"
1434 >12289 (i.e.: URLs plus informational and warning messages)</P
1437 >Effect if unset:</DT
1440 > Nothing gets logged.
1447 > The available debug levels are:
1457 CLASS="PROGRAMLISTING"
1458 > debug 1 # show each GET/POST/CONNECT request
1459 debug 2 # show each connection status
1460 debug 4 # show I/O status
1461 debug 8 # show header parsing
1462 debug 16 # log all data written to the network into the logfile
1463 debug 32 # debug force feature
1464 debug 64 # debug regular expression filters
1465 debug 128 # debug redirects
1466 debug 256 # debug GIF de-animation
1467 debug 512 # Common Log Format
1468 debug 1024 # debug kill pop-ups
1469 debug 2048 # CGI user interface
1470 debug 4096 # Startup banner and warnings.
1471 debug 8192 # Non-fatal errors</PRE
1478 > To select multiple debug levels, you can either add them or use
1485 > A debug level of 1 is informative because it will show you each request
1486 as it happens. <SPAN
1490 >1, 4096 and 8192 are highly recommended</I
1493 so that you will notice when things go wrong. The other levels are probably
1494 only of interest if you are hunting down a specific problem. They can produce
1495 a hell of an output (especially 16).
1499 > If you want to use CLF (Common Log Format), you should set <SPAN
1509 > and not enable anything else.
1515 > has a hard-coded limit for the
1516 length of log messages. If it's reached, messages are logged truncated
1517 and marked with <SPAN
1519 >"... [too long, truncated]"</SPAN
1531 NAME="SINGLE-THREADED"
1532 >7.3.2. single-threaded</A
1537 CLASS="VARIABLELIST"
1543 > Whether to run only one server thread.
1571 >Effect if unset:</DT
1574 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1575 serve multiple requests simultaneously.
1582 > This option is only there for debugging purposes.
1587 >It will drastically reduce performance.</I
1601 NAME="ACCESS-CONTROL"
1602 >7.4. Access Control and Security</A
1605 > This section of the config file controls the security-relevant aspects
1616 NAME="LISTEN-ADDRESS"
1617 >7.4.1. listen-address</A
1622 CLASS="VARIABLELIST"
1628 > The IP address and TCP port on which <SPAN
1632 listen for client requests.
1658 >Effect if unset:</DT
1661 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1662 home users who run <SPAN
1665 > on the same machine as
1673 > You will need to configure your browser(s) to this proxy address and port.
1676 > If you already have another service running on port 8118, or if you want to
1677 serve requests from other machines (e.g. on your local network) as well, you
1678 will need to override the default.
1681 > If you leave out the IP address, <SPAN
1685 bind to all interfaces (addresses) on your machine and may become reachable
1686 from the Internet. In that case, consider using <A
1687 HREF="config.html#ACLS"
1688 >access control lists</A
1689 > (ACL's, see below), and/or
1696 > to untrusted users, you will
1697 also want to make sure that the following actions are disabled: <TT
1700 HREF="config.html#ENABLE-EDIT-ACTIONS"
1701 >enable-edit-actions</A
1707 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1708 >enable-remote-toggle</A
1717 > Suppose you are running <SPAN
1721 a machine which has the address 192.168.0.1 on your local private network
1722 (192.168.0.0) and has another outside connection with a different address.
1723 You want it to serve requests from inside only:
1733 CLASS="PROGRAMLISTING"
1734 > listen-address 192.168.0.1:8118</PRE
1755 CLASS="VARIABLELIST"
1761 > Initial state of "toggle" status
1777 >Effect if unset:</DT
1780 > Act as if toggled on
1787 > If set to 0, <SPAN
1793 >"toggled off"</SPAN
1794 > mode, i.e. mostly behave like a normal,
1795 content-neutral proxy with both ad blocking and content filtering
1798 >enable-remote-toggle</TT
1802 > The windows version will only display the toggle icon in the system tray
1803 if this option is present.
1814 NAME="ENABLE-REMOTE-TOGGLE"
1815 >7.4.3. enable-remote-toggle</A
1820 CLASS="VARIABLELIST"
1826 > Whether or not the <A
1827 HREF="http://config.privoxy.org/toggle"
1847 >Effect if unset:</DT
1850 > The web-based toggle feature is disabled.
1857 > When toggled off, <SPAN
1860 > mostly acts like a normal,
1861 content-neutral proxy, i.e. doesn't block ads or filter content.
1864 > Access to the toggle feature can <SPAN
1871 controlled separately by <SPAN
1874 > or HTTP authentication,
1875 so that everybody who can access <SPAN
1886 toggle it for all users. So this option is <SPAN
1893 for multi-user environments with untrusted users.
1896 > Note that malicious client side code (e.g Java) is also
1897 capable of using this option.
1904 documentation, this feature is disabled by default.
1907 > Note that you must have compiled <SPAN
1911 support for this feature, otherwise this option has no effect.
1922 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1923 >7.4.4. enable-remote-http-toggle</A
1928 CLASS="VARIABLELIST"
1934 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1950 >Effect if unset:</DT
1953 > Privoxy ignores special HTTP headers.
1960 > When toggled on, the client can change <SPAN
1964 behaviour by setting special HTTP headers. Currently the only supported
1965 special header is <SPAN
1967 >"X-Filter: No"</SPAN
1968 >, to disable filtering for
1969 the ongoing request, even if it is enabled in one of the action files.
1972 > This feature is disabled by default. If you are using
1976 > in a environment with trusted clients,
1977 you may enable this feature at your discretion. Note that malicious client
1978 side code (e.g Java) is also capable of using this feature.
1981 > This option will be removed in future releases as it has been obsoleted
1982 by the more general header taggers.
1993 NAME="ENABLE-EDIT-ACTIONS"
1994 >7.4.5. enable-edit-actions</A
1999 CLASS="VARIABLELIST"
2005 > Whether or not the <A
2006 HREF="http://config.privoxy.org/show-status"
2026 >Effect if unset:</DT
2029 > The web-based actions file editor is disabled.
2036 > Access to the editor can <SPAN
2043 controlled separately by <SPAN
2046 > or HTTP authentication,
2047 so that everybody who can access <SPAN
2058 modify its configuration for all users.
2061 > This option is <SPAN
2068 with untrusted users and as a lot of <SPAN
2072 users don't read documentation, this feature is disabled by default.
2075 > Note that malicious client side code (e.g Java) is also
2076 capable of using the actions editor and you shouldn't enable
2077 this options unless you understand the consequences and are
2078 sure your browser is configured correctly.
2081 > Note that you must have compiled <SPAN
2085 support for this feature, otherwise this option has no effect.
2096 NAME="ENFORCE-BLOCKS"
2097 >7.4.6. enforce-blocks</A
2102 CLASS="VARIABLELIST"
2108 > Whether the user is allowed to ignore blocks and can <SPAN
2110 >"go there anyway"</SPAN
2139 >Effect if unset:</DT
2142 > Blocks are not enforced.
2152 > is mainly used to block and filter
2153 requests as a service to the user, for example to block ads and other
2154 junk that clogs the pipes. <SPAN
2158 isn't perfect and sometimes innocent pages are blocked. In this situation it
2159 makes sense to allow the user to enforce the request and have
2166 > In the default configuration <SPAN
2173 > page contains a <SPAN
2175 >"go there anyway"</SPAN
2177 link to adds a special string (the force prefix) to the request URL.
2178 If that link is used, <SPAN
2182 detect the force prefix, remove it again and let the request pass.
2188 > can also be used to enforce
2189 a network policy. In that case the user obviously should not be able to
2190 bypass any blocks, and that's what the <SPAN
2192 >"enforce-blocks"</SPAN
2194 option is for. If it's enabled, <SPAN
2200 >"go there anyway"</SPAN
2201 > link. If the user adds the force
2202 prefix by hand, it will not be accepted and the circumvention attempt
2222 >7.4.7. ACLs: permit-access and deny-access</A
2225 NAME="PERMIT-ACCESS"
2233 CLASS="VARIABLELIST"
2239 > Who can access what.
2281 > are IP addresses in dotted decimal notation or valid
2293 > are subnet masks in CIDR notation, i.e. integer
2294 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2295 destination part are optional.
2311 >Effect if unset:</DT
2314 > Don't restrict access further than implied by <TT
2324 > Access controls are included at the request of ISPs and systems
2325 administrators, and <SPAN
2329 >are not usually needed by individual users</I
2332 For a typical home user, it will normally suffice to ensure that
2336 > only listens on the localhost
2337 (127.0.0.1) or internal (home) network address by means of the
2339 HREF="config.html#LISTEN-ADDRESS"
2351 > Please see the warnings in the FAQ that <SPAN
2355 is not intended to be a substitute for a firewall or to encourage anyone
2356 to defer addressing basic security weaknesses.
2359 > Multiple ACL lines are OK.
2360 If any ACLs are specified, <SPAN
2364 to IP addresses that match at least one <TT
2368 and don't match any subsequent <TT
2371 > line. In other words, the
2372 last match wins, with the default being <TT
2381 > is using a forwarder (see <TT
2385 for a particular destination URL, the <TT
2391 that is examined is the address of the forwarder and <SPAN
2398 of the ultimate target. This is necessary because it may be impossible for the local
2402 > to determine the IP address of the
2403 ultimate target (that's often what gateways are used for).
2406 > You should prefer using IP addresses over DNS names, because the address lookups take
2407 time. All DNS names must resolve! You can <SPAN
2413 > use domain patterns
2417 > or partial domain names. If a DNS name resolves to multiple
2418 IP addresses, only the first one is used.
2421 > Denying access to particular sites by ACL may have undesired side effects
2422 if the site in question is hosted on a machine which also hosts other sites
2430 > Explicitly define the default behavior if no ACL and
2438 is OK. The absence of a <TT
2450 > destination addresses are OK:
2461 > permit-access localhost</PRE
2468 > Allow any host on the same class C subnet as www.privoxy.org access to
2469 nothing but www.example.com (or other domains hosted on the same system):
2480 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2487 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2488 with the exception that 192.168.45.73 may not access the IP address behind
2489 www.dirty-stuff.example.com:
2500 > permit-access 192.168.45.64/26
2501 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2517 >7.4.8. buffer-limit</A
2522 CLASS="VARIABLELIST"
2528 > Maximum size of the buffer for content filtering.
2544 >Effect if unset:</DT
2547 > Use a 4MB (4096 KB) limit.
2554 > For content filtering, i.e. the <TT
2561 > actions, it is necessary that
2565 > buffers the entire document body.
2566 This can be potentially dangerous, since a server could just keep sending
2567 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2571 > When a document buffer size reaches the <TT
2575 flushed to the client unfiltered and no further attempt to
2576 filter the rest of the document is made. Remember that there may be multiple threads
2577 running, which might require up to <TT
2587 >, unless you have enabled <SPAN
2589 >"single-threaded"</SPAN
2607 > This feature allows routing of HTTP requests through a chain of
2608 multiple proxies.</P
2610 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2611 up browsing. Using a parent proxy may also be necessary if the machine
2615 > runs on has no direct Internet access.</P
2617 > Note that parent proxies can severely decrease your privacy level.
2618 For example a parent proxy could add your IP address to the request
2619 headers and if it's a caching proxy it may add the <SPAN
2623 header to revalidation requests again, even though you configured Privoxy
2624 to remove it. It may also ignore Privoxy's header time randomization and use the
2625 original values which could be used by the server as cookie replacement
2626 to track your steps between visits.</P
2628 > Also specified here are SOCKS proxies. <SPAN
2632 supports the SOCKS 4 and SOCKS 4A protocols.</P
2644 CLASS="VARIABLELIST"
2650 > To which parent HTTP proxy specific requests should be routed.
2682 HREF="actions-file.html#AF-PATTERNS"
2685 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2704 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2705 optionally followed by its listening port (default: 8080).
2706 Use a single dot (<TT
2711 >"no forwarding"</SPAN
2728 >Effect if unset:</DT
2731 > Don't use parent HTTP proxies.
2746 >, then requests are not
2747 forwarded to another HTTP proxy but are made directly to the web servers.
2750 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2757 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2768 > forward / parent-proxy.example.org:8080
2776 > Everything goes to our example ISP's caching proxy, except for requests
2777 to that ISP's sites:
2788 > forward / caching-proxy.isp.example.net:8000
2789 forward .isp.example.net .</PRE
2805 >7.5.2. forward-socks4 and forward-socks4a</A
2808 NAME="FORWARD-SOCKS4"
2811 NAME="FORWARD-SOCKS4A"
2816 CLASS="VARIABLELIST"
2822 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2865 HREF="actions-file.html#AF-PATTERNS"
2868 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2887 are IP addresses in dotted decimal notation or valid DNS names (<TT
2898 >"no HTTP forwarding"</SPAN
2899 >), and the optional
2905 > parameters are TCP ports, i.e. integer values from 1 to 64535
2921 >Effect if unset:</DT
2924 > Don't use SOCKS proxies.
2931 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2934 > The difference between <TT
2939 >forward-socks4a</TT
2941 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2942 server, while in SOCKS 4 it happens locally.
2953 >, then requests are not
2954 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2962 > From the company example.com, direct connections are made to all
2966 > domains, but everything outbound goes through
2967 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2979 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2980 forward .example.com .</PRE
2987 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2998 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3005 > To chain Privoxy and Tor, both running on the same system, you would use
3017 > forward-socks4a / 127.0.0.1:9050 .</PRE
3027 > network can't be used to
3028 reach your local network, if you need to access local servers you
3029 therefore might want to make some exceptions:
3040 > forward 192.168.*.*/ .
3042 forward 127.*.*.*/ .</PRE
3049 > Unencrypted connections to systems in these address ranges will
3050 be as (un)secure as the local network is, but the alternative is that you
3051 can't reach the local network through <SPAN
3055 at all. Of course this may actually be desired and there is no reason
3056 to make these exceptions if you aren't sure you need them.
3059 > If you also want to be able to reach servers in your local network by
3060 using their names, you will need additional exceptions that look like
3072 > forward localhost/ .</PRE
3087 NAME="ADVANCED-FORWARDING-EXAMPLES"
3088 >7.5.3. Advanced Forwarding Examples</A
3091 > If you have links to multiple ISPs that provide various special content
3092 only to their subscribers, you can configure multiple <SPAN
3096 which have connections to the respective ISPs to act as forwarders to each other, so that
3103 > users can see the internal content of all ISPs.</P
3105 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3106 isp-b.example.org. Both run <SPAN
3110 configuration can look like this:</P
3123 forward .isp-b.example.net host-b:8118</PRE
3140 forward .isp-a.example.org host-a:8118</PRE
3146 > Now, your users can set their browser's proxy to use either
3147 host-a or host-b and be able to browse the internal content
3148 of both isp-a and isp-b.</P
3150 > If you intend to chain <SPAN
3157 > locally, then chaining as
3160 >browser -> squid -> privoxy</TT
3161 > is the recommended way. </P
3163 > Assuming that <SPAN
3170 run on the same box, your <SPAN
3173 > configuration could then look like this:</P
3183 > # Define Privoxy as parent proxy (without ICP)
3184 cache_peer 127.0.0.1 parent 8118 7 no-query
3186 # Define ACL for protocol FTP
3189 # Do not forward FTP requests to Privoxy
3190 always_direct allow ftp
3192 # Forward all the rest to Privoxy
3193 never_direct allow all</PRE
3199 > You would then need to change your browser's proxy settings to <SPAN
3202 >'s address and port.
3203 Squid normally uses port 3128. If unsure consult <TT
3211 > You could just as well decide to only forward requests you suspect
3212 of leading to Windows executables through a virus-scanning parent proxy,
3215 >antivir.example.com</TT
3227 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3238 NAME="FORWARDED-CONNECT-RETRIES"
3239 >7.5.4. forwarded-connect-retries</A
3244 CLASS="VARIABLELIST"
3250 > How often Privoxy retries if a forwarded connection request fails.
3260 >Number of retries.</I
3278 >Effect if unset:</DT
3281 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3291 >forwarded-connect-retries</I
3293 > is mainly interesting
3294 for socks4a connections, where <SPAN
3297 > can't detect why the connections failed.
3298 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3299 but it might also have failed because the server doesn't exist or isn't reachable. In this
3300 case the retry will just delay the appearance of Privoxy's error message.
3303 > Note that in the context of this option, <SPAN
3305 >"forwarded connections"</SPAN
3306 > includes all connections
3307 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3310 > Only use this option, if you are getting lots of forwarding-related error messages
3311 that go away when you try again manually. Start with a small value and check Privoxy's
3312 logfile from time to time, to see how many retries are usually needed.
3319 > forwarded-connect-retries 1
3330 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3331 >7.5.5. accept-intercepted-requests</A
3336 CLASS="VARIABLELIST"
3342 > Whether intercepted requests should be treated as valid.
3370 >Effect if unset:</DT
3373 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3380 > If you don't trust your clients and want to force them
3385 option and configure your packet filter to redirect outgoing
3386 HTTP connections into <SPAN
3392 > Make sure that <SPAN
3396 aren't redirected as well. Additionally take care that
3400 > can't intentionally connect
3401 to itself, otherwise you could run into redirection loops if
3405 > listening port is reachable
3406 by the outside or an attacker has access to the pages you visit.
3413 > accept-intercepted-requests 1
3424 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3425 >7.5.6. allow-cgi-request-crunching</A
3430 CLASS="VARIABLELIST"
3436 > Whether requests to <SPAN
3439 > CGI pages can be blocked or redirected.
3467 >Effect if unset:</DT
3473 > ignores block and redirect actions for its CGI pages.
3483 > ignores block or redirect actions
3484 for its CGI pages. Intercepting these requests can be useful in multi-user
3485 setups to implement fine-grained access control, but it can also render the complete
3486 web interface useless and make debugging problems painful if done without care.
3489 > Don't enable this option unless you're sure that you really need it.
3496 > allow-cgi-request-crunching 1
3507 NAME="SPLIT-LARGE-FORMS"
3508 >7.5.7. split-large-forms</A
3513 CLASS="VARIABLELIST"
3519 > Whether the CGI interface should stay compatible with broken HTTP clients.
3547 >Effect if unset:</DT
3550 > The CGI form generate long GET URLs.
3560 > CGI forms can lead to
3561 rather long URLs. This isn't a problem as far as the HTTP
3562 standard is concerned, but it can confuse clients with arbitrary
3563 URL lenght limitations.
3566 > Enabling split-large-forms causes <SPAN
3570 to devide big forms into smaller ones to keep the URL length down.
3571 It makes editing a lot less convenient and you can no longer
3572 submit all changes at once, but at least it works around this
3576 > If you don't notice any editing problems, there is no reason
3577 to enable this option, but if one of the submit buttons appears
3578 to be broken, you should give it a try.
3585 > split-large-forms 1
3598 >7.6. Windows GUI Options</A
3604 > has a number of options specific to the
3605 Windows GUI interface:</P
3607 NAME="ACTIVITY-ANIMATION"
3612 >"activity-animation"</SPAN
3617 > icon will animate when
3621 > is active. To turn off, set to 0.</P
3626 CLASS="LITERALLAYOUT"
3631 >activity-animation 1</I
3634 </P
3644 >"log-messages"</SPAN
3649 > will log messages to the console
3655 CLASS="LITERALLAYOUT"
3663 </P
3668 NAME="LOG-BUFFER-SIZE"
3674 >"log-buffer-size"</SPAN
3675 > is set to 1, the size of the log buffer,
3676 i.e. the amount of memory used for the log messages displayed in the
3677 console window, will be limited to <SPAN
3679 >"log-max-lines"</SPAN
3682 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3683 eat up all your memory!</P
3688 CLASS="LITERALLAYOUT"
3693 >log-buffer-size 1</I
3696 </P
3701 NAME="LOG-MAX-LINES"
3706 >log-max-lines</SPAN
3707 > is the maximum number of lines held
3708 in the log buffer. See above.</P
3713 CLASS="LITERALLAYOUT"
3718 >log-max-lines 200</I
3721 </P
3726 NAME="LOG-HIGHLIGHT-MESSAGES"
3731 >"log-highlight-messages"</SPAN
3736 > will highlight portions of the log
3737 messages with a bold-faced font:</P
3742 CLASS="LITERALLAYOUT"
3747 >log-highlight-messages 1</I
3750 </P
3755 NAME="LOG-FONT-NAME"
3758 > The font used in the console window:</P
3763 CLASS="LITERALLAYOUT"
3768 >log-font-name Comic Sans MS</I
3771 </P
3776 NAME="LOG-FONT-SIZE"
3779 > Font size used in the console window:</P
3784 CLASS="LITERALLAYOUT"
3792 </P
3797 NAME="SHOW-ON-TASK-BAR"
3803 >"show-on-task-bar"</SPAN
3804 > controls whether or not
3808 > will appear as a button on the Task bar
3814 CLASS="LITERALLAYOUT"
3819 >show-on-task-bar 0</I
3822 </P
3827 NAME="CLOSE-BUTTON-MINIMIZES"
3832 >"close-button-minimizes"</SPAN
3833 > is set to 1, the Windows close
3834 button will minimize <SPAN
3837 > instead of closing
3838 the program (close with the exit option on the File menu).</P
3843 CLASS="LITERALLAYOUT"
3848 >close-button-minimizes 1</I
3851 </P
3861 >"hide-console"</SPAN
3862 > option is specific to the MS-Win console
3866 >. If this option is used,
3870 > will disconnect from and hide the
3876 CLASS="LITERALLAYOUT"
3884 </P
3895 SUMMARY="Footer navigation table"
3906 HREF="configuration.html"
3924 HREF="actions-file.html"
3934 >Privoxy Configuration</TD