1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
5 >The Main Configuration File</TITLE
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10 TITLE="Privoxy 3.0.8 User Manual"
11 HREF="index.html"><LINK
13 TITLE="Privoxy Configuration"
14 HREF="configuration.html"><LINK
17 HREF="actions-file.html"><LINK
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.8 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
731 >/var/log/privoxy (Unix) <SPAN
740 > installation dir (Windows) </P
743 >Effect if unset:</DT
776 >7.2.4. actionsfile</A
779 NAME="DEFAULT.ACTION"
782 NAME="STANDARD.ACTION"
797 HREF="actions-file.html"
806 >Complete file name, relative to <TT
822 CLASS="LITERALLAYOUT"
823 > standard.action # Internal purposes, no editing recommended</P
830 CLASS="LITERALLAYOUT"
831 > default.action # Main actions file</P
838 CLASS="LITERALLAYOUT"
839 > user.action # User customizations</P
849 >Effect if unset:</DT
852 > No actions are taken at all. More or less neutral proxying.
862 > lines are permitted, and are in fact recommended!
866 The default values include <TT
870 for internal purposes and should be loaded, <TT
877 > actions file maintained by the developers, and
881 >, where you can make your personal additions.
885 Actions files contain all the per site and per URL configuration for
886 ad blocking, cookie management, privacy considerations, etc.
887 There is no point in using <SPAN
891 least one actions file.
894 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
898 extension has to be specified. The syntax change was necessary to be consistent
899 with the other file options and to allow previously forbidden characters.
911 >7.2.5. filterfile</A
914 NAME="DEFAULT.FILTER"
926 HREF="filter-file.html"
935 >File name, relative to <TT
944 >default.filter (Unix) <SPAN
950 > default.filter.txt (Windows)</P
953 >Effect if unset:</DT
956 > No textual content filtering takes place, i.e. all
960 HREF="actions-file.html#FILTER"
969 actions in the actions files are turned neutral.
979 > lines are permitted.
983 HREF="filter-file.html"
985 > contain content modification
987 HREF="appendix.html#REGEX"
988 >regular expressions</A
989 >. These rules permit
990 powerful changes on the content of Web pages, and optionally the headers
991 as well, e.g., you could try to disable your favorite JavaScript annoyances,
992 re-write the actual displayed text, or just have some fun
993 playing buzzword bingo with web pages.
1000 HREF="actions-file.html#FILTER"
1009 actions rely on the relevant filter (<TT
1015 to be defined in a filter file!
1018 > A pre-defined filter file called <TT
1022 a number of useful filters for common problems is included in the distribution.
1023 See the section on the <TT
1026 HREF="actions-file.html#FILTER"
1033 > It is recommended to place any locally adapted filters into a separate
1054 CLASS="VARIABLELIST"
1060 > The log file to use
1067 >File name, relative to <TT
1080 >Unset (commented out)</I
1082 >. When activated: logfile (Unix) <SPAN
1088 > privoxy.log (Windows).</P
1091 >Effect if unset:</DT
1094 > No logfile is written.
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 > Depending on the debug options below, the logfile may be a privacy risk
1116 if third parties can get access to it. As most users will never look
1120 > 3.0.7 and later only log fatal
1124 > For most troubleshooting purposes, you will have to change that,
1125 please refer to the debugging section for details.
1128 > Your logfile will grow indefinitely, and you will probably want to
1129 periodically remove it. On Unix systems, you can do this with a cron job
1133 >). For Red Hat based Linux distributions, a
1137 > script has been included.
1140 > Any log files must be writable by whatever user <SPAN
1144 is being run as (on Unix, default user id is <SPAN
1164 CLASS="VARIABLELIST"
1170 > The file to store intercepted cookies in
1177 >File name, relative to <TT
1190 >Unset (commented out)</I
1192 >. When activated: jarfile (Unix) <SPAN
1198 > privoxy.jar (Windows).</P
1201 >Effect if unset:</DT
1204 > Intercepted cookies are not stored in a dedicated log file.
1211 > The jarfile may grow to ridiculous sizes over time.
1214 > If debug 8 (show header parsing) is enabled, cookies are
1215 also written to the logfile with the rest of the headers.
1216 Therefore this option isn't very useful and may be removed
1217 in future releases. Please report to the developers if you
1230 >7.2.8. trustfile</A
1235 CLASS="VARIABLELIST"
1241 > The name of the trust file to use
1248 >File name, relative to <TT
1261 >Unset (commented out)</I
1263 >. When activated: trust (Unix) <SPAN
1269 > trust.txt (Windows)</P
1272 >Effect if unset:</DT
1275 > The entire trust mechanism is disabled.
1282 > The trust mechanism is an experimental feature for building white-lists and should
1283 be used with care. It is <SPAN
1289 > recommended for the casual user.
1292 > If you specify a trust file, <SPAN
1296 access to sites that are specified in the trustfile. Sites can be listed
1303 > character limits access to this site
1304 only (and any sub-paths within this site), e.g.
1307 >~www.example.com</TT
1311 >~www.example.com/features/news.html</TT
1315 > Or, you can designate sites as <SPAN
1319 >trusted referrers</I
1322 prepending the name with a <TT
1325 > character. The effect is that
1326 access to untrusted sites will be granted -- but only if a link from this
1327 trusted referrer was used to get there. The link target will then be added
1331 > so that future, direct accesses will be
1332 granted. Sites added via this mechanism do not become trusted referrers
1333 themselves (i.e. they are added with a <TT
1337 There is a limit of 512 such entries, after which new entries will not be
1341 > If you use the <TT
1344 > operator in the trust file, it may grow
1345 considerably over time.
1348 > It is recommended that <SPAN
1354 >--disable-force</TT
1357 >--disable-toggle</TT
1361 > --disable-editor</TT
1362 > options, if this feature is to be
1366 > Possible applications include limiting Internet access for children.
1382 > These options are mainly useful when tracing a problem.
1383 Note that you might also want to invoke
1391 command line option when debugging.
1404 CLASS="VARIABLELIST"
1410 > Key values that determine what information gets logged.
1423 >0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</P
1426 >Effect if unset:</DT
1429 > Default value is used (see above).
1436 > The available debug levels are:
1446 CLASS="PROGRAMLISTING"
1447 > debug 1 # log each request destination (and the crunch reason if <SPAN
1450 > intercepted the request)
1451 debug 2 # show each connection status
1452 debug 4 # show I/O status
1453 debug 8 # show header parsing
1454 debug 16 # log all data written to the network into the logfile
1455 debug 32 # debug force feature
1456 debug 64 # debug regular expression filters
1457 debug 128 # debug redirects
1458 debug 256 # debug GIF de-animation
1459 debug 512 # Common Log Format
1460 debug 1024 # debug kill pop-ups
1461 debug 2048 # CGI user interface
1462 debug 4096 # Startup banner and warnings.
1463 debug 8192 # Non-fatal errors</PRE
1470 > To select multiple debug levels, you can either add them or use
1477 > A debug level of 1 is informative because it will show you each request
1478 as it happens. <SPAN
1482 >1, 4096 and 8192 are recommended</I
1485 so that you will notice when things go wrong. The other levels are
1486 probably only of interest if you are hunting down a specific problem.
1487 They can produce a hell of an output (especially 16).
1494 > used to ship with the debug levels recommended above enabled by
1495 default, but due to privacy concerns 3.0.7 and later are configured to
1496 only log fatal errors.
1499 > If you are used to the more verbose settings, simply enable the debug lines
1503 > If you want to use pure CLF (Common Log Format), you should set <SPAN
1513 > and not enable anything else.
1519 > has a hard-coded limit for the
1520 length of log messages. If it's reached, messages are logged truncated
1521 and marked with <SPAN
1523 >"... [too long, truncated]"</SPAN
1527 > Please don't file any support requests without trying to reproduce
1528 the problem with increased debug level first. Once you read the log
1529 messages, you may even be able to solve the problem on your own.
1540 NAME="SINGLE-THREADED"
1541 >7.3.2. single-threaded</A
1546 CLASS="VARIABLELIST"
1552 > Whether to run only one server thread.
1580 >Effect if unset:</DT
1583 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1584 serve multiple requests simultaneously.
1591 > This option is only there for debugging purposes.
1596 >It will drastically reduce performance.</I
1610 NAME="ACCESS-CONTROL"
1611 >7.4. Access Control and Security</A
1614 > This section of the config file controls the security-relevant aspects
1625 NAME="LISTEN-ADDRESS"
1626 >7.4.1. listen-address</A
1631 CLASS="VARIABLELIST"
1637 > The IP address and TCP port on which <SPAN
1641 listen for client requests.
1667 >Effect if unset:</DT
1670 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1671 home users who run <SPAN
1674 > on the same machine as
1682 > You will need to configure your browser(s) to this proxy address and port.
1685 > If you already have another service running on port 8118, or if you want to
1686 serve requests from other machines (e.g. on your local network) as well, you
1687 will need to override the default.
1690 > If you leave out the IP address, <SPAN
1694 bind to all interfaces (addresses) on your machine and may become reachable
1695 from the Internet. In that case, consider using <A
1696 HREF="config.html#ACLS"
1697 >access control lists</A
1698 > (ACL's, see below), and/or
1705 > to untrusted users, you will
1706 also want to make sure that the following actions are disabled: <TT
1709 HREF="config.html#ENABLE-EDIT-ACTIONS"
1710 >enable-edit-actions</A
1716 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1717 >enable-remote-toggle</A
1726 > Suppose you are running <SPAN
1730 a machine which has the address 192.168.0.1 on your local private network
1731 (192.168.0.0) and has another outside connection with a different address.
1732 You want it to serve requests from inside only:
1742 CLASS="PROGRAMLISTING"
1743 > listen-address 192.168.0.1:8118</PRE
1764 CLASS="VARIABLELIST"
1770 > Initial state of "toggle" status
1786 >Effect if unset:</DT
1789 > Act as if toggled on
1796 > If set to 0, <SPAN
1802 >"toggled off"</SPAN
1803 > mode, i.e. mostly behave like a normal,
1804 content-neutral proxy with both ad blocking and content filtering
1807 >enable-remote-toggle</TT
1811 > The windows version will only display the toggle icon in the system tray
1812 if this option is present.
1823 NAME="ENABLE-REMOTE-TOGGLE"
1824 >7.4.3. enable-remote-toggle</A
1829 CLASS="VARIABLELIST"
1835 > Whether or not the <A
1836 HREF="http://config.privoxy.org/toggle"
1856 >Effect if unset:</DT
1859 > The web-based toggle feature is disabled.
1866 > When toggled off, <SPAN
1869 > mostly acts like a normal,
1870 content-neutral proxy, i.e. doesn't block ads or filter content.
1873 > Access to the toggle feature can <SPAN
1880 controlled separately by <SPAN
1883 > or HTTP authentication,
1884 so that everybody who can access <SPAN
1895 toggle it for all users. So this option is <SPAN
1902 for multi-user environments with untrusted users.
1905 > Note that malicious client side code (e.g Java) is also
1906 capable of using this option.
1913 documentation, this feature is disabled by default.
1916 > Note that you must have compiled <SPAN
1920 support for this feature, otherwise this option has no effect.
1931 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1932 >7.4.4. enable-remote-http-toggle</A
1937 CLASS="VARIABLELIST"
1943 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1959 >Effect if unset:</DT
1962 > Privoxy ignores special HTTP headers.
1969 > When toggled on, the client can change <SPAN
1973 behaviour by setting special HTTP headers. Currently the only supported
1974 special header is <SPAN
1976 >"X-Filter: No"</SPAN
1977 >, to disable filtering for
1978 the ongoing request, even if it is enabled in one of the action files.
1981 > This feature is disabled by default. If you are using
1985 > in a environment with trusted clients,
1986 you may enable this feature at your discretion. Note that malicious client
1987 side code (e.g Java) is also capable of using this feature.
1990 > This option will be removed in future releases as it has been obsoleted
1991 by the more general header taggers.
2002 NAME="ENABLE-EDIT-ACTIONS"
2003 >7.4.5. enable-edit-actions</A
2008 CLASS="VARIABLELIST"
2014 > Whether or not the <A
2015 HREF="http://config.privoxy.org/show-status"
2035 >Effect if unset:</DT
2038 > The web-based actions file editor is disabled.
2045 > Access to the editor can <SPAN
2052 controlled separately by <SPAN
2055 > or HTTP authentication,
2056 so that everybody who can access <SPAN
2067 modify its configuration for all users.
2070 > This option is <SPAN
2077 with untrusted users and as a lot of <SPAN
2081 users don't read documentation, this feature is disabled by default.
2084 > Note that malicious client side code (e.g Java) is also
2085 capable of using the actions editor and you shouldn't enable
2086 this options unless you understand the consequences and are
2087 sure your browser is configured correctly.
2090 > Note that you must have compiled <SPAN
2094 support for this feature, otherwise this option has no effect.
2105 NAME="ENFORCE-BLOCKS"
2106 >7.4.6. enforce-blocks</A
2111 CLASS="VARIABLELIST"
2117 > Whether the user is allowed to ignore blocks and can <SPAN
2119 >"go there anyway"</SPAN
2148 >Effect if unset:</DT
2151 > Blocks are not enforced.
2161 > is mainly used to block and filter
2162 requests as a service to the user, for example to block ads and other
2163 junk that clogs the pipes. <SPAN
2167 isn't perfect and sometimes innocent pages are blocked. In this situation it
2168 makes sense to allow the user to enforce the request and have
2175 > In the default configuration <SPAN
2182 > page contains a <SPAN
2184 >"go there anyway"</SPAN
2186 link to adds a special string (the force prefix) to the request URL.
2187 If that link is used, <SPAN
2191 detect the force prefix, remove it again and let the request pass.
2197 > can also be used to enforce
2198 a network policy. In that case the user obviously should not be able to
2199 bypass any blocks, and that's what the <SPAN
2201 >"enforce-blocks"</SPAN
2203 option is for. If it's enabled, <SPAN
2209 >"go there anyway"</SPAN
2210 > link. If the user adds the force
2211 prefix by hand, it will not be accepted and the circumvention attempt
2231 >7.4.7. ACLs: permit-access and deny-access</A
2234 NAME="PERMIT-ACCESS"
2242 CLASS="VARIABLELIST"
2248 > Who can access what.
2290 > are IP addresses in dotted decimal notation or valid
2302 > are subnet masks in CIDR notation, i.e. integer
2303 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2304 destination part are optional.
2320 >Effect if unset:</DT
2323 > Don't restrict access further than implied by <TT
2333 > Access controls are included at the request of ISPs and systems
2334 administrators, and <SPAN
2338 >are not usually needed by individual users</I
2341 For a typical home user, it will normally suffice to ensure that
2345 > only listens on the localhost
2346 (127.0.0.1) or internal (home) network address by means of the
2348 HREF="config.html#LISTEN-ADDRESS"
2360 > Please see the warnings in the FAQ that <SPAN
2364 is not intended to be a substitute for a firewall or to encourage anyone
2365 to defer addressing basic security weaknesses.
2368 > Multiple ACL lines are OK.
2369 If any ACLs are specified, <SPAN
2373 to IP addresses that match at least one <TT
2377 and don't match any subsequent <TT
2380 > line. In other words, the
2381 last match wins, with the default being <TT
2390 > is using a forwarder (see <TT
2394 for a particular destination URL, the <TT
2400 that is examined is the address of the forwarder and <SPAN
2407 of the ultimate target. This is necessary because it may be impossible for the local
2411 > to determine the IP address of the
2412 ultimate target (that's often what gateways are used for).
2415 > You should prefer using IP addresses over DNS names, because the address lookups take
2416 time. All DNS names must resolve! You can <SPAN
2422 > use domain patterns
2426 > or partial domain names. If a DNS name resolves to multiple
2427 IP addresses, only the first one is used.
2430 > Denying access to particular sites by ACL may have undesired side effects
2431 if the site in question is hosted on a machine which also hosts other sites
2439 > Explicitly define the default behavior if no ACL and
2447 is OK. The absence of a <TT
2459 > destination addresses are OK:
2470 > permit-access localhost</PRE
2477 > Allow any host on the same class C subnet as www.privoxy.org access to
2478 nothing but www.example.com (or other domains hosted on the same system):
2489 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2496 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2497 with the exception that 192.168.45.73 may not access the IP address behind
2498 www.dirty-stuff.example.com:
2509 > permit-access 192.168.45.64/26
2510 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2526 >7.4.8. buffer-limit</A
2531 CLASS="VARIABLELIST"
2537 > Maximum size of the buffer for content filtering.
2553 >Effect if unset:</DT
2556 > Use a 4MB (4096 KB) limit.
2563 > For content filtering, i.e. the <TT
2570 > actions, it is necessary that
2574 > buffers the entire document body.
2575 This can be potentially dangerous, since a server could just keep sending
2576 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2580 > When a document buffer size reaches the <TT
2584 flushed to the client unfiltered and no further attempt to
2585 filter the rest of the document is made. Remember that there may be multiple threads
2586 running, which might require up to <TT
2596 >, unless you have enabled <SPAN
2598 >"single-threaded"</SPAN
2616 > This feature allows routing of HTTP requests through a chain of
2617 multiple proxies.</P
2619 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2620 up browsing. Using a parent proxy may also be necessary if the machine
2624 > runs on has no direct Internet access.</P
2626 > Note that parent proxies can severely decrease your privacy level.
2627 For example a parent proxy could add your IP address to the request
2628 headers and if it's a caching proxy it may add the <SPAN
2632 header to revalidation requests again, even though you configured Privoxy
2633 to remove it. It may also ignore Privoxy's header time randomization and use the
2634 original values which could be used by the server as cookie replacement
2635 to track your steps between visits.</P
2637 > Also specified here are SOCKS proxies. <SPAN
2641 supports the SOCKS 4 and SOCKS 4A protocols.</P
2653 CLASS="VARIABLELIST"
2659 > To which parent HTTP proxy specific requests should be routed.
2691 HREF="actions-file.html#AF-PATTERNS"
2694 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2713 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2714 optionally followed by its listening port (default: 8080).
2715 Use a single dot (<TT
2720 >"no forwarding"</SPAN
2737 >Effect if unset:</DT
2740 > Don't use parent HTTP proxies.
2755 >, then requests are not
2756 forwarded to another HTTP proxy but are made directly to the web servers.
2759 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2766 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2777 > forward / parent-proxy.example.org:8080
2785 > Everything goes to our example ISP's caching proxy, except for requests
2786 to that ISP's sites:
2797 > forward / caching-proxy.isp.example.net:8000
2798 forward .isp.example.net .</PRE
2814 >7.5.2. forward-socks4 and forward-socks4a</A
2817 NAME="FORWARD-SOCKS4"
2820 NAME="FORWARD-SOCKS4A"
2825 CLASS="VARIABLELIST"
2831 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2874 HREF="actions-file.html#AF-PATTERNS"
2877 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2896 are IP addresses in dotted decimal notation or valid DNS names (<TT
2907 >"no HTTP forwarding"</SPAN
2908 >), and the optional
2914 > parameters are TCP ports, i.e. integer values from 1 to 64535
2930 >Effect if unset:</DT
2933 > Don't use SOCKS proxies.
2940 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2943 > The difference between <TT
2948 >forward-socks4a</TT
2950 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2951 server, while in SOCKS 4 it happens locally.
2962 >, then requests are not
2963 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2971 > From the company example.com, direct connections are made to all
2975 > domains, but everything outbound goes through
2976 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2988 > forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
2989 forward .example.com .</PRE
2996 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
3007 > forward-socks4 / socks-gw.example.com:1080 .</PRE
3014 > To chain Privoxy and Tor, both running on the same system, you would use
3026 > forward-socks4a / 127.0.0.1:9050 .</PRE
3036 > network can't be used to
3037 reach your local network, if you need to access local servers you
3038 therefore might want to make some exceptions:
3049 > forward 192.168.*.*/ .
3051 forward 127.*.*.*/ .</PRE
3058 > Unencrypted connections to systems in these address ranges will
3059 be as (un)secure as the local network is, but the alternative is that you
3060 can't reach the local network through <SPAN
3064 at all. Of course this may actually be desired and there is no reason
3065 to make these exceptions if you aren't sure you need them.
3068 > If you also want to be able to reach servers in your local network by
3069 using their names, you will need additional exceptions that look like
3081 > forward localhost/ .</PRE
3096 NAME="ADVANCED-FORWARDING-EXAMPLES"
3097 >7.5.3. Advanced Forwarding Examples</A
3100 > If you have links to multiple ISPs that provide various special content
3101 only to their subscribers, you can configure multiple <SPAN
3105 which have connections to the respective ISPs to act as forwarders to each other, so that
3112 > users can see the internal content of all ISPs.</P
3114 > Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
3115 isp-b.example.org. Both run <SPAN
3119 configuration can look like this:</P
3132 forward .isp-b.example.net host-b:8118</PRE
3149 forward .isp-a.example.org host-a:8118</PRE
3155 > Now, your users can set their browser's proxy to use either
3156 host-a or host-b and be able to browse the internal content
3157 of both isp-a and isp-b.</P
3159 > If you intend to chain <SPAN
3166 > locally, then chaining as
3169 >browser -> squid -> privoxy</TT
3170 > is the recommended way. </P
3172 > Assuming that <SPAN
3179 run on the same box, your <SPAN
3182 > configuration could then look like this:</P
3192 > # Define Privoxy as parent proxy (without ICP)
3193 cache_peer 127.0.0.1 parent 8118 7 no-query
3195 # Define ACL for protocol FTP
3198 # Do not forward FTP requests to Privoxy
3199 always_direct allow ftp
3201 # Forward all the rest to Privoxy
3202 never_direct allow all</PRE
3208 > You would then need to change your browser's proxy settings to <SPAN
3211 >'s address and port.
3212 Squid normally uses port 3128. If unsure consult <TT
3220 > You could just as well decide to only forward requests you suspect
3221 of leading to Windows executables through a virus-scanning parent proxy,
3224 >antivir.example.com</TT
3236 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3247 NAME="FORWARDED-CONNECT-RETRIES"
3248 >7.5.4. forwarded-connect-retries</A
3253 CLASS="VARIABLELIST"
3259 > How often Privoxy retries if a forwarded connection request fails.
3269 >Number of retries.</I
3287 >Effect if unset:</DT
3290 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3300 >forwarded-connect-retries</I
3302 > is mainly interesting
3303 for socks4a connections, where <SPAN
3306 > can't detect why the connections failed.
3307 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3308 but it might also have failed because the server doesn't exist or isn't reachable. In this
3309 case the retry will just delay the appearance of Privoxy's error message.
3312 > Note that in the context of this option, <SPAN
3314 >"forwarded connections"</SPAN
3315 > includes all connections
3316 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3319 > Only use this option, if you are getting lots of forwarding-related error messages
3320 that go away when you try again manually. Start with a small value and check Privoxy's
3321 logfile from time to time, to see how many retries are usually needed.
3328 > forwarded-connect-retries 1
3339 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3340 >7.5.5. accept-intercepted-requests</A
3345 CLASS="VARIABLELIST"
3351 > Whether intercepted requests should be treated as valid.
3379 >Effect if unset:</DT
3382 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3389 > If you don't trust your clients and want to force them
3394 option and configure your packet filter to redirect outgoing
3395 HTTP connections into <SPAN
3401 > Make sure that <SPAN
3405 aren't redirected as well. Additionally take care that
3409 > can't intentionally connect
3410 to itself, otherwise you could run into redirection loops if
3414 > listening port is reachable
3415 by the outside or an attacker has access to the pages you visit.
3422 > accept-intercepted-requests 1
3433 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3434 >7.5.6. allow-cgi-request-crunching</A
3439 CLASS="VARIABLELIST"
3445 > Whether requests to <SPAN
3448 > CGI pages can be blocked or redirected.
3476 >Effect if unset:</DT
3482 > ignores block and redirect actions for its CGI pages.
3492 > ignores block or redirect actions
3493 for its CGI pages. Intercepting these requests can be useful in multi-user
3494 setups to implement fine-grained access control, but it can also render the complete
3495 web interface useless and make debugging problems painful if done without care.
3498 > Don't enable this option unless you're sure that you really need it.
3505 > allow-cgi-request-crunching 1
3516 NAME="SPLIT-LARGE-FORMS"
3517 >7.5.7. split-large-forms</A
3522 CLASS="VARIABLELIST"
3528 > Whether the CGI interface should stay compatible with broken HTTP clients.
3556 >Effect if unset:</DT
3559 > The CGI form generate long GET URLs.
3569 > CGI forms can lead to
3570 rather long URLs. This isn't a problem as far as the HTTP
3571 standard is concerned, but it can confuse clients with arbitrary
3572 URL length limitations.
3575 > Enabling split-large-forms causes <SPAN
3579 to divide big forms into smaller ones to keep the URL length down.
3580 It makes editing a lot less convenient and you can no longer
3581 submit all changes at once, but at least it works around this
3585 > If you don't notice any editing problems, there is no reason
3586 to enable this option, but if one of the submit buttons appears
3587 to be broken, you should give it a try.
3594 > split-large-forms 1
3607 >7.6. Windows GUI Options</A
3613 > has a number of options specific to the
3614 Windows GUI interface:</P
3616 NAME="ACTIVITY-ANIMATION"
3621 >"activity-animation"</SPAN
3626 > icon will animate when
3630 > is active. To turn off, set to 0.</P
3635 CLASS="LITERALLAYOUT"
3640 >activity-animation 1</I
3643 </P
3653 >"log-messages"</SPAN
3658 > will log messages to the console
3664 CLASS="LITERALLAYOUT"
3672 </P
3677 NAME="LOG-BUFFER-SIZE"
3683 >"log-buffer-size"</SPAN
3684 > is set to 1, the size of the log buffer,
3685 i.e. the amount of memory used for the log messages displayed in the
3686 console window, will be limited to <SPAN
3688 >"log-max-lines"</SPAN
3691 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3692 eat up all your memory!</P
3697 CLASS="LITERALLAYOUT"
3702 >log-buffer-size 1</I
3705 </P
3710 NAME="LOG-MAX-LINES"
3715 >log-max-lines</SPAN
3716 > is the maximum number of lines held
3717 in the log buffer. See above.</P
3722 CLASS="LITERALLAYOUT"
3727 >log-max-lines 200</I
3730 </P
3735 NAME="LOG-HIGHLIGHT-MESSAGES"
3740 >"log-highlight-messages"</SPAN
3745 > will highlight portions of the log
3746 messages with a bold-faced font:</P
3751 CLASS="LITERALLAYOUT"
3756 >log-highlight-messages 1</I
3759 </P
3764 NAME="LOG-FONT-NAME"
3767 > The font used in the console window:</P
3772 CLASS="LITERALLAYOUT"
3777 >log-font-name Comic Sans MS</I
3780 </P
3785 NAME="LOG-FONT-SIZE"
3788 > Font size used in the console window:</P
3793 CLASS="LITERALLAYOUT"
3801 </P
3806 NAME="SHOW-ON-TASK-BAR"
3812 >"show-on-task-bar"</SPAN
3813 > controls whether or not
3817 > will appear as a button on the Task bar
3823 CLASS="LITERALLAYOUT"
3828 >show-on-task-bar 0</I
3831 </P
3836 NAME="CLOSE-BUTTON-MINIMIZES"
3841 >"close-button-minimizes"</SPAN
3842 > is set to 1, the Windows close
3843 button will minimize <SPAN
3846 > instead of closing
3847 the program (close with the exit option on the File menu).</P
3852 CLASS="LITERALLAYOUT"
3857 >close-button-minimizes 1</I
3860 </P
3870 >"hide-console"</SPAN
3871 > option is specific to the MS-Win console
3875 >. If this option is used,
3879 > will disconnect from and hide the
3885 CLASS="LITERALLAYOUT"
3893 </P
3904 SUMMARY="Footer navigation table"
3915 HREF="configuration.html"
3933 HREF="actions-file.html"
3943 >Privoxy Configuration</TD