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 the proxy, by
264 following the built-in URL: <TT
266 >http://config.privoxy.org/user-manual/</TT
268 (or the shortcut: <TT
270 >http://p.p/user-manual/</TT
274 > If the documentation is not on the local system, it can be accessed
275 from a remote server, as:
286 >  user-manual  http://example.com/privoxy/user-manual/</PRE
311 > If set, this option should be <SPAN
315 >the first option in the config
318 >, because it is used while the config file is being read
334 NAME="TRUST-INFO-URL"
335 >7.1.2. trust-info-url</A
346 > A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
359 >Two example URLs are provided</P
362 >Effect if unset:</DT
365 > No links are displayed on the "untrusted" error page.
372 > The value of this option only matters if the experimental trust mechanism has been
374 HREF="config.html#TRUSTFILE"
385 > If you use the trust mechanism, it is a good idea to write up some on-line
386 documentation about your trust policy and to specify the URL(s) here.
387 Use multiple times for multiple URLs.
390 > The URL(s) should be added to the trustfile as well, so users don't end up
391 locked out from the information on why they were locked out in the first place!
403 >7.1.3. admin-address</A
414 > An email address to reach the proxy administrator.
436 >Effect if unset:</DT
439 > No email address is displayed on error pages and the CGI user interface.
453 are unset, the whole "Local Privoxy Support" box on all generated pages will
465 NAME="PROXY-INFO-URL"
466 >7.1.4. proxy-info-url</A
477 > A URL to documentation about the local <SPAN
481 configuration or policies.
503 >Effect if unset:</DT
506 > No link to local documentation is displayed on error pages and the CGI user interface.
520 are unset, the whole "Local Privoxy Support" box on all generated pages will
524 > This URL shouldn't be blocked ;-)
537 >7.2. Configuration and Log File Locations</A
543 > can (and normally does) use a number of
544 other files for additional configuration, help and logging.
545 This section of the configuration file tells <SPAN
549 where to find those other files. </P
551 > The user running <SPAN
555 permission for all configuration files, and write permission to any files
556 that would be modified, such as log files and actions files.</P
574 >The directory where the other configuration files are located</P
586 >/etc/privoxy (Unix) <SPAN
595 > installation dir (Windows) </P
598 >Effect if unset:</DT
642 >An alternative directory where the templates are loaded from</P
657 >Effect if unset:</DT
660 >The templates are assumed to be located in confdir/template.</P
666 > Privoxy's original templates are usually overwritten
667 with each update. Use this option to relocate customized templates
668 that should be kept. Note that you might be missing new features
669 if you use outdated templates.
692 > The directory where all logging takes place (i.e. where <TT
712 >/var/log/privoxy (Unix) <SPAN
721 > installation dir (Windows) </P
724 >Effect if unset:</DT
757 >7.2.4. actionsfile</A
760 NAME="DEFAULT.ACTION"
763 NAME="STANDARD.ACTION"
778 HREF="actions-file.html"
787 >Complete file name, relative to <TT
803 CLASS="LITERALLAYOUT"
804 > standard.action # Internal purposes, no editing recommended</P
811 CLASS="LITERALLAYOUT"
812 > default.action # Main actions file</P
819 CLASS="LITERALLAYOUT"
820 > user.action # User customizations</P
830 >Effect if unset:</DT
833 > No actions are taken at all. More or less neutral proxying.
843 > lines are permitted, and are in fact recommended!
847 The default values include standard.action, which is used for internal
848 purposes and should be loaded, default.action, which is the
852 > actions file maintained by the developers, and
856 >, where you can make your personal additions.
860 Actions files are where all the per site and per URL configuration is done for
861 ad blocking, cookie management, privacy considerations, etc.
862 There is no point in using <SPAN
866 least one actions file.
869 > Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
873 extension has to be specified. The syntax change was necessary to be consistent
874 with the other file options and to allow previously forbidden characters.
886 >7.2.5. filterfile</A
889 NAME="DEFAULT.FILTER"
901 HREF="filter-file.html"
910 >File name, relative to <TT
919 >default.filter (Unix) <SPAN
925 > default.filter.txt (Windows)</P
928 >Effect if unset:</DT
931 > No textual content filtering takes place, i.e. all
935 HREF="actions-file.html#FILTER"
944 actions in the actions files are turned neutral.
954 > lines are permitted.
958 HREF="filter-file.html"
960 > contain content modification
962 HREF="appendix.html#REGEX"
963 >regular expressions</A
964 >. These rules permit
965 powerful changes on the content of Web pages, and optionally the headers
966 as well, e.g., you could disable your favorite JavaScript annoyances,
967 re-write the actual displayed text, or just have some fun
968 playing buzzword bingo with web pages.
975 HREF="actions-file.html#FILTER"
984 actions rely on the relevant filter (<TT
990 to be defined in a filter file!
993 > A pre-defined filter file called <TT
997 a number of useful filters for common problems is included in the distribution.
998 See the section on the <TT
1001 HREF="actions-file.html#FILTER"
1008 > It is recommended to place any locally adapted filters into a separate
1029 CLASS="VARIABLELIST"
1035 > The log file to use
1042 >File name, relative to <TT
1055 >Unset (commented out)</I
1057 >. When activated: logfile (Unix) <SPAN
1063 > privoxy.log (Windows)</P
1066 >Effect if unset:</DT
1069 > No log file is used, all log messages go to the console (<TT
1079 > The logfile is where all logging and error messages are written. The level
1080 of detail and number of messages are set with the <TT
1084 option (see below). The logfile can be useful for tracking down a problem with
1088 > (e.g., it's not blocking an ad you
1089 think it should block) but in most cases you probably will never look at
1090 it. For this reason, it is disabled by default. For troubleshooting
1091 purposes, you will have to explicitly enable it.
1094 > Your logfile will grow indefinitely, and you will probably want to
1095 periodically remove it. On Unix systems, you can do this with a cron job
1099 >). For Red Hat based Linux distributions, a
1103 > script has been included.
1106 > On SuSE Linux systems, you can place a line like <SPAN
1108 >"/var/log/privoxy.*
1109 +1024k 644 nobody.nogroup"</SPAN
1114 the effect that cron.daily will automatically archive, gzip, and empty the
1115 log, when it exceeds 1M size.
1118 > Any log files must be writable by whatever user <SPAN
1122 is being run as (default on UNIX, user id is <SPAN
1142 CLASS="VARIABLELIST"
1148 > The file to store intercepted cookies in
1155 >File name, relative to <TT
1168 >Unset (commented out)</I
1170 >. When activated: jarfile (Unix) <SPAN
1176 > privoxy.jar (Windows)</P
1179 >Effect if unset:</DT
1182 > Intercepted cookies are not stored in a dedicated log file.
1189 > The jarfile may grow to ridiculous sizes over time.
1192 > If debug 8 (show header parsing) is enabled, cookies are
1193 written to the logfile with the rest of the headers.
1205 >7.2.8. trustfile</A
1210 CLASS="VARIABLELIST"
1216 > The name of the trust file to use
1223 >File name, relative to <TT
1236 >Unset (commented out)</I
1238 >. When activated: trust (Unix) <SPAN
1244 > trust.txt (Windows)</P
1247 >Effect if unset:</DT
1250 > The entire trust mechanism is disabled.
1257 > The trust mechanism is an experimental feature for building white-lists and should
1258 be used with care. It is <SPAN
1264 > recommended for the casual user.
1267 > If you specify a trust file, <SPAN
1271 access to sites that are specified in the trustfile. Sites can be listed
1278 > character limits access to this site
1279 only (and any sub-paths within this site), e.g.
1282 >~www.example.com</TT
1286 >~www.example.com/features/news.html</TT
1290 > Or, you can designate sites as <SPAN
1294 >trusted referrers</I
1297 prepending the name with a <TT
1300 > character. The effect is that
1301 access to untrusted sites will be granted -- but only if a link from this
1302 trusted referrer was used to get there. The link target will then be added
1306 > so that future, direct accesses will be
1307 granted. Sites added via this mechanism do not become trusted referrers
1308 themselves (i.e. they are added with a <TT
1312 There is a limit of 512 such entries, after which new entries will not be
1316 > If you use the <TT
1319 > operator in the trust file, it may grow
1320 considerably over time.
1323 > It is recommended that <SPAN
1329 >--disable-force</TT
1332 >--disable-toggle</TT
1336 > --disable-editor</TT
1337 > options, if this feature is to be
1341 > Possible applications include limiting Internet access for children.
1357 > These options are mainly useful when tracing a problem.
1358 Note that you might also want to invoke
1366 command line option when debugging.
1379 CLASS="VARIABLELIST"
1385 > Key values that determine what information gets logged to the
1387 HREF="config.html#LOGFILE"
1408 >12289 (i.e.: URLs plus informational and warning messages)</P
1411 >Effect if unset:</DT
1414 > Nothing gets logged.
1421 > The available debug levels are:
1431 CLASS="PROGRAMLISTING"
1432 > debug 1 # show each GET/POST/CONNECT request
1433 debug 2 # show each connection status
1434 debug 4 # show I/O status
1435 debug 8 # show header parsing
1436 debug 16 # log all data written to the network into the logfile
1437 debug 32 # debug force feature
1438 debug 64 # debug regular expression filters
1439 debug 128 # debug redirects
1440 debug 256 # debug GIF de-animation
1441 debug 512 # Common Log Format
1442 debug 1024 # debug kill pop-ups
1443 debug 2048 # CGI user interface
1444 debug 4096 # Startup banner and warnings.
1445 debug 8192 # Non-fatal errors</PRE
1452 > To select multiple debug levels, you can either add them or use
1459 > A debug level of 1 is informative because it will show you each request
1460 as it happens. <SPAN
1464 >1, 4096 and 8192 are highly recommended</I
1467 so that you will notice when things go wrong. The other levels are probably
1468 only of interest if you are hunting down a specific problem. They can produce
1469 a hell of an output (especially 16).
1473 > The reporting of <SPAN
1479 > errors (i.e. ones which causes
1483 > to exit) is always on and cannot be disabled.
1486 > If you want to use CLF (Common Log Format), you should set <SPAN
1496 > and not enable anything else.
1502 > has a hard-coded limit for the
1503 length of log messages. If it's reached, messages are logged truncated
1504 and marked with <SPAN
1506 >"... [too long, truncated]"</SPAN
1518 NAME="SINGLE-THREADED"
1519 >7.3.2. single-threaded</A
1524 CLASS="VARIABLELIST"
1530 > Whether to run only one server thread
1558 >Effect if unset:</DT
1561 > Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1562 serve multiple requests simultaneously.
1569 > This option is only there for debug purposes and you should never
1570 need to use it. <SPAN
1574 >It will drastically reduce performance.</I
1588 NAME="ACCESS-CONTROL"
1589 >7.4. Access Control and Security</A
1592 > This section of the config file controls the security-relevant aspects
1603 NAME="LISTEN-ADDRESS"
1604 >7.4.1. listen-address</A
1609 CLASS="VARIABLELIST"
1615 > The IP address and TCP port on which <SPAN
1619 listen for client requests.
1645 >Effect if unset:</DT
1648 > Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1649 home users who run <SPAN
1652 > on the same machine as
1660 > You will need to configure your browser(s) to this proxy address and port.
1663 > If you already have another service running on port 8118, or if you want to
1664 serve requests from other machines (e.g. on your local network) as well, you
1665 will need to override the default.
1668 > If you leave out the IP address, <SPAN
1672 bind to all interfaces (addresses) on your machine and may become reachable
1673 from the Internet. In that case, consider using <A
1674 HREF="config.html#ACLS"
1675 >access control lists</A
1676 > (ACL's, see below), and/or
1683 > to untrusted users, you will
1684 also want to turn off the <TT
1687 HREF="config.html#ENABLE-EDIT-ACTIONS"
1688 >enable-edit-actions</A
1694 HREF="config.html#ENABLE-REMOTE-TOGGLE"
1695 >enable-remote-toggle</A
1705 > Suppose you are running <SPAN
1709 a machine which has the address 192.168.0.1 on your local private network
1710 (192.168.0.0) and has another outside connection with a different address.
1711 You want it to serve requests from inside only:
1721 CLASS="PROGRAMLISTING"
1722 > listen-address 192.168.0.1:8118</PRE
1743 CLASS="VARIABLELIST"
1749 > Initial state of "toggle" status
1765 >Effect if unset:</DT
1768 > Act as if toggled on
1775 > If set to 0, <SPAN
1781 >"toggled off"</SPAN
1782 > mode, i.e. mostly behave like a normal,
1783 content-neutral proxy where all ad blocking, filtering, etc are disabled. See
1786 >enable-remote-toggle</TT
1787 > below. This is not really useful
1788 anymore, since toggling is much easier via <A
1789 HREF="http://config.privoxy.org/toggle"
1791 >the web interface</A
1799 > The windows version will only display the toggle icon in the system tray
1800 if this option is present.
1811 NAME="ENABLE-REMOTE-TOGGLE"
1812 >7.4.3. enable-remote-toggle</A
1817 CLASS="VARIABLELIST"
1823 > Whether or not the <A
1824 HREF="http://config.privoxy.org/toggle"
1844 >Effect if unset:</DT
1847 > The web-based toggle feature is disabled.
1854 > When toggled off, <SPAN
1857 > mostly acts like a normal,
1858 content-neutral proxy, i.e. it acts as if none of the actions applied to
1862 > Access to the toggle feature can <SPAN
1869 controlled separately by <SPAN
1872 > or HTTP authentication,
1873 so that everybody who can access <SPAN
1884 toggle it for all users. So this option is <SPAN
1891 for multi-user environments with untrusted users. Because of
1892 the obvious security implications, this feature is off by default.
1893 Note that malicious client side code (e.g JavaScript) is also potentially
1894 capable of changing <SPAN
1901 > Note that you must have compiled <SPAN
1905 support for this feature, otherwise this option has no effect.
1916 NAME="ENABLE-REMOTE-HTTP-TOGGLE"
1917 >7.4.4. enable-remote-http-toggle</A
1922 CLASS="VARIABLELIST"
1928 > Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1944 >Effect if unset:</DT
1947 > Privoxy ignores special HTTP headers.
1954 > When toggled on, the client can change <SPAN
1958 behaviour by setting special HTTP headers. Currently the only supported
1959 special header is <SPAN
1961 >"X-Filter: No"</SPAN
1962 >, to disable filtering for
1963 the ongoing request, even if it is enabled in one of the action files.
1966 > This feature is disabled by default. If you are using
1970 > in a environment with trusted clients,
1971 you may enable this feature at your discretion. Note that malicious client
1972 side code (e.g JavaScript) is also potentially capable of changing
1976 > intended behavior.
1987 NAME="ENABLE-EDIT-ACTIONS"
1988 >7.4.5. enable-edit-actions</A
1993 CLASS="VARIABLELIST"
1999 > Whether or not the <A
2000 HREF="http://config.privoxy.org/show-status"
2020 >Effect if unset:</DT
2023 > The web-based actions file editor is disabled.
2030 > Access to the editor can <SPAN
2037 controlled separately by <SPAN
2040 > or HTTP authentication,
2041 so that everybody who can access <SPAN
2052 modify its configuration for all users. This option is <SPAN
2059 > for multi-user environments with untrusted users
2060 and is therefore disabled by default. Note that malicious client side code
2061 (e.g JavaScript) is also potentially capable of changing
2065 > intended behavior.
2068 > Note that you must have compiled <SPAN
2072 support for this feature, otherwise this option has no effect.
2083 NAME="ENFORCE-BLOCKS"
2084 >7.4.6. enforce-blocks</A
2089 CLASS="VARIABLELIST"
2095 > Whether the user is allowed to ignore blocks and can <SPAN
2097 >"go there anyway"</SPAN
2126 >Effect if unset:</DT
2129 > Blocks are not enforced.
2139 > is mainly used to block and filter
2140 requests as a service to the user, for example to block ads and other
2141 junk that clogs the pipes. <SPAN
2145 isn't perfect and sometimes innocent pages are blocked. In this situation it
2146 makes sense to allow the user to enforce the request and have
2153 > In the default configuration <SPAN
2160 > page contains a <SPAN
2162 >"go there anyway"</SPAN
2164 link to adds a special string (the force prefix) to the request URL.
2165 If that link is used, <SPAN
2169 detect the force prefix, remove it again and let the request pass.
2175 > can also be used to enforce
2176 a network policy. In that case the user obviously should not be able to
2177 bypass any blocks, and that's what the <SPAN
2179 >"enforce-blocks"</SPAN
2181 option is for. If it's enabled, <SPAN
2187 >"go there anyway"</SPAN
2188 > link. If the user adds the force
2189 prefix by hand, it will not be accepted and the circumvention attempt
2209 >7.4.7. ACLs: permit-access and deny-access</A
2212 NAME="PERMIT-ACCESS"
2220 CLASS="VARIABLELIST"
2226 > Who can access what.
2268 > are IP addresses in dotted decimal notation or valid
2280 > are subnet masks in CIDR notation, i.e. integer
2281 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2282 destination part are optional.
2298 >Effect if unset:</DT
2301 > Don't restrict access further than implied by <TT
2311 > Access controls are included at the request of ISPs and systems
2312 administrators, and <SPAN
2316 >are not usually needed by individual users</I
2319 For a typical home user, it will normally suffice to ensure that
2323 > only listens on the localhost
2324 (127.0.0.1) or internal (home) network address by means of the
2326 HREF="config.html#LISTEN-ADDRESS"
2338 > Please see the warnings in the FAQ that this proxy is not intended to be a substitute
2339 for a firewall or to encourage anyone to defer addressing basic security
2343 > Multiple ACL lines are OK.
2344 If any ACLs are specified, <SPAN
2348 to IP addresses that match at least one <TT
2352 and don't match any subsequent <TT
2355 > line. In other words, the
2356 last match wins, with the default being <TT
2365 > is using a forwarder (see <TT
2369 for a particular destination URL, the <TT
2375 that is examined is the address of the forwarder and <SPAN
2382 of the ultimate target. This is necessary because it may be impossible for the local
2386 > to determine the IP address of the
2387 ultimate target (that's often what gateways are used for).
2390 > You should prefer using IP addresses over DNS names, because the address lookups take
2391 time. All DNS names must resolve! You can <SPAN
2397 > use domain patterns
2401 > or partial domain names. If a DNS name resolves to multiple
2402 IP addresses, only the first one is used.
2405 > Denying access to particular sites by ACL may have undesired side effects
2406 if the site in question is hosted on a machine which also hosts other sites
2414 > Explicitly define the default behavior if no ACL and
2422 is OK. The absence of a <TT
2434 > destination addresses are OK:
2445 > permit-access localhost</PRE
2452 > Allow any host on the same class C subnet as www.privoxy.org access to
2453 nothing but www.example.com (or other domains hosted on the same system):
2464 > permit-access www.privoxy.org/24 www.example.com/32</PRE
2471 > Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2472 with the exception that 192.168.45.73 may not access the IP address behind
2473 www.dirty-stuff.example.com:
2484 > permit-access 192.168.45.64/26
2485 deny-access 192.168.45.73 www.dirty-stuff.example.com</PRE
2501 >7.4.8. buffer-limit</A
2506 CLASS="VARIABLELIST"
2512 > Maximum size of the buffer for content filtering.
2528 >Effect if unset:</DT
2531 > Use a 4MB (4096 KB) limit.
2538 > For content filtering, i.e. the <TT
2545 > actions, it is necessary that
2549 > buffers the entire document body.
2550 This can be potentially dangerous, since a server could just keep sending
2551 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2555 > When a document buffer size reaches the <TT
2559 flushed to the client unfiltered and no further attempt to
2560 filter the rest of the document is made. Remember that there may be multiple threads
2561 running, which might require up to <TT
2571 >, unless you have enabled <SPAN
2573 >"single-threaded"</SPAN
2591 > This feature allows routing of HTTP requests through a chain of
2592 multiple proxies.</P
2594 > Forwarding can be used to chain Privoxy with a caching proxy to speed
2595 up browsing. Using a parent proxy may also be necessary if the machine
2599 > runs on has no direct Internet access.</P
2601 > Note that parent proxies can severely decrease your privacy level.
2602 For example a parent proxy could add your IP address to the request
2603 headers and if it's a caching proxy it may add the <SPAN
2607 header to revalidation requests again, even though you configured Privoxy
2608 to remove it. It may also ignore Privoxy's header time randomization and use the
2609 original values which could be used by the server as cookie replacement
2610 to track your steps between visits.</P
2612 > Also specified here are SOCKS proxies. <SPAN
2616 supports the SOCKS 4 and SOCKS 4A protocols.</P
2628 CLASS="VARIABLELIST"
2634 > To which parent HTTP proxy specific requests should be routed.
2666 HREF="actions-file.html#AF-PATTERNS"
2669 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2688 is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
2689 optionally followed by its listening port (default: 8080).
2690 Use a single dot (<TT
2695 >"no forwarding"</SPAN
2712 >Effect if unset:</DT
2715 > Don't use parent HTTP proxies.
2730 >, then requests are not
2731 forwarded to another HTTP proxy but are made directly to the web servers.
2734 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2741 > Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
2752 > forward / parent-proxy.example.org:8080
2760 > Everything goes to our example ISP's caching proxy, except for requests
2761 to that ISP's sites:
2772 > forward / caching-proxy.example-isp.net:8000
2773 forward .example-isp.net .</PRE
2789 >7.5.2. forward-socks4 and forward-socks4a</A
2792 NAME="FORWARD-SOCKS4"
2795 NAME="FORWARD-SOCKS4A"
2800 CLASS="VARIABLELIST"
2806 > Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2849 HREF="actions-file.html#AF-PATTERNS"
2852 that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
2871 are IP addresses in dotted decimal notation or valid DNS names (<TT
2882 >"no HTTP forwarding"</SPAN
2883 >), and the optional
2889 > parameters are TCP ports, i.e. integer values from 1 to 64535
2905 >Effect if unset:</DT
2908 > Don't use SOCKS proxies.
2915 > Multiple lines are OK, they are checked in sequence, and the last match wins.
2918 > The difference between <TT
2923 >forward-socks4a</TT
2925 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2926 server, while in SOCKS 4 it happens locally.
2937 >, then requests are not
2938 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2946 > From the company example.com, direct connections are made to all
2950 > domains, but everything outbound goes through
2951 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2963 > forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
2964 forward .example.com .</PRE
2971 > A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2982 > forward-socks4 / socks-gw.example.com:1080 .</PRE
2989 > To chain Privoxy and Tor, both running on the same system, you should use
3001 > forward-socks4 / 127.0.0.1:9050 .</PRE
3011 > network can't be used to reach your local network,
3012 therefore it's a good idea to make some exceptions:
3023 > forward 192.168.*.*/ .
3025 forward 127.*.*.*/ .</PRE
3032 > Unencrypted connections to systems in these address ranges will
3033 be as (un)secure as the local network is, but the alternative is that you
3034 can't reach the network at all.
3037 > If you also want to be able to reach servers in your local network by
3038 using their names, you will need additional exceptions that look like
3050 > forward localhost/ .</PRE
3065 NAME="ADVANCED-FORWARDING-EXAMPLES"
3066 >7.5.3. Advanced Forwarding Examples</A
3069 > If you have links to multiple ISPs that provide various special content
3070 only to their subscribers, you can configure multiple <SPAN
3074 which have connections to the respective ISPs to act as forwarders to each other, so that
3081 > users can see the internal content of all ISPs.</P
3083 > Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
3084 isp-b.net. Both run <SPAN
3088 configuration can look like this:</P
3101 forward .isp-b.net host-b:8118</PRE
3118 forward .isp-a.net host-a:8118</PRE
3124 > Now, your users can set their browser's proxy to use either
3125 host-a or host-b and be able to browse the internal content
3126 of both isp-a and isp-b.</P
3128 > If you intend to chain <SPAN
3135 > locally, then chain as
3138 >browser -> squid -> privoxy</TT
3139 > is the recommended way. </P
3141 > Assuming that <SPAN
3148 run on the same box, your <SPAN
3151 > configuration could then look like this:</P
3161 > # Define Privoxy as parent proxy (without ICP)
3162 cache_peer 127.0.0.1 parent 8118 7 no-query
3164 # Define ACL for protocol FTP
3167 # Do not forward FTP requests to Privoxy
3168 always_direct allow ftp
3170 # Forward all the rest to Privoxy
3171 never_direct allow all</PRE
3177 > You would then need to change your browser's proxy settings to <SPAN
3180 >'s address and port.
3181 Squid normally uses port 3128. If unsure consult <TT
3189 > You could just as well decide to only forward requests for Windows executables through
3190 a virus-scanning parent proxy, say, on <TT
3192 >antivir.example.com</TT
3204 forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</PRE
3215 NAME="FORWARDED-CONNECT-RETRIES"
3216 >7.5.4. forwarded-connect-retries</A
3221 CLASS="VARIABLELIST"
3227 > How often Privoxy retries if a forwarded connection request fails.
3237 >Number of retries.</I
3255 >Effect if unset:</DT
3258 > Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
3268 >forwarded-connect-retries</I
3270 > is mainly interesting
3271 for socks4a connections, where <SPAN
3274 > can't detect why the connections failed.
3275 The connection might have failed because of a DNS timeout in which case a retry makes sense,
3276 but it might also have failed because the server doesn't exist or isn't reachable. In this
3277 case the retry will just delay the appearance of Privoxy's error message.
3280 > Note that in the context of this option, <SPAN
3282 >"forwarded connections"</SPAN
3283 > includes all connections
3284 that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
3287 > Only use this option, if you are getting many forwarding related error messages,
3288 that go away when you try again manually. Start with a small value and check Privoxy's
3289 logfile from time to time, to see how many retries are usually needed.
3296 > forwarded-connect-retries 1
3307 NAME="ACCEPT-INTERCEPTED-REQUESTS"
3308 >7.5.5. accept-intercepted-requests</A
3313 CLASS="VARIABLELIST"
3319 > Whether intercepted requests should be treated as valid.
3347 >Effect if unset:</DT
3350 > Only proxy requests are accepted, intercepted requests are treated as invalid.
3357 > If you don't trust your clients and want to force them
3362 option and configure your packet filter to redirect outgoing
3363 HTTP connections into <SPAN
3369 > Make sure that <SPAN
3373 aren't redirected as well. Additionally take care that
3377 > can't intentionally connect
3378 to itself, otherwise you could run into redirection loops if
3382 > listening port is reachable
3383 by the outside or an attacker has access to the pages you visit.
3390 > accept-intercepted-requests 1
3401 NAME="ALLOW-CGI-REQUEST-CRUNCHING"
3402 >7.5.6. allow-cgi-request-crunching</A
3407 CLASS="VARIABLELIST"
3413 > Whether requests to <SPAN
3416 > CGI pages can be blocked or redirected.
3444 >Effect if unset:</DT
3450 > ignores block and redirect actions for its CGI pages.
3460 > ignores block or redirect actions
3461 for its CGI pages. Intercepting these requests can be useful in multi-user
3462 setups to implement fine-grained access control, but it can also render the complete
3463 web interface useless and make debugging problems painful if done without care.
3466 > Don't enable this option unless you're sure that you really need it.
3473 > allow-cgi-request-crunching 1
3484 NAME="SPLIT-LARGE-FORMS"
3485 >7.5.7. split-large-forms</A
3490 CLASS="VARIABLELIST"
3496 > Whether the CGI interface should stay compatible with broken HTTP clients.
3524 >Effect if unset:</DT
3527 > The CGI form generate long GET URLs.
3537 > CGI forms can lead to
3538 rather long URLs. This isn't a problem as far as the HTTP
3539 standard is concerned, but it can confuse clients with arbitrary
3540 URL lenght limitations.
3543 > Enabling split-large-forms causes <SPAN
3547 to devide big forms into smaller ones to keep the URL length down.
3548 It makes editing a lot less convenient and you can no longer
3549 submit all changes at once, but at least it works around this
3553 > If you don't notice any editing problems, there is no reason
3554 to enable this option, but if one of the submit buttons appears
3555 to be broken, you should give it a try.
3562 > split-large-forms 1
3575 >7.6. Windows GUI Options</A
3581 > has a number of options specific to the
3582 Windows GUI interface:</P
3584 NAME="ACTIVITY-ANIMATION"
3589 >"activity-animation"</SPAN
3594 > icon will animate when
3598 > is active. To turn off, set to 0.</P
3603 CLASS="LITERALLAYOUT"
3608 >activity-animation 1</I
3611 </P
3621 >"log-messages"</SPAN
3626 > will log messages to the console
3632 CLASS="LITERALLAYOUT"
3640 </P
3645 NAME="LOG-BUFFER-SIZE"
3651 >"log-buffer-size"</SPAN
3652 > is set to 1, the size of the log buffer,
3653 i.e. the amount of memory used for the log messages displayed in the
3654 console window, will be limited to <SPAN
3656 >"log-max-lines"</SPAN
3659 > Warning: Setting this to 0 will result in the buffer to grow infinitely and
3660 eat up all your memory!</P
3665 CLASS="LITERALLAYOUT"
3670 >log-buffer-size 1</I
3673 </P
3678 NAME="LOG-MAX-LINES"
3683 >log-max-lines</SPAN
3684 > is the maximum number of lines held
3685 in the log buffer. See above.</P
3690 CLASS="LITERALLAYOUT"
3695 >log-max-lines 200</I
3698 </P
3703 NAME="LOG-HIGHLIGHT-MESSAGES"
3708 >"log-highlight-messages"</SPAN
3713 > will highlight portions of the log
3714 messages with a bold-faced font:</P
3719 CLASS="LITERALLAYOUT"
3724 >log-highlight-messages 1</I
3727 </P
3732 NAME="LOG-FONT-NAME"
3735 > The font used in the console window:</P
3740 CLASS="LITERALLAYOUT"
3745 >log-font-name Comic Sans MS</I
3748 </P
3753 NAME="LOG-FONT-SIZE"
3756 > Font size used in the console window:</P
3761 CLASS="LITERALLAYOUT"
3769 </P
3774 NAME="SHOW-ON-TASK-BAR"
3780 >"show-on-task-bar"</SPAN
3781 > controls whether or not
3785 > will appear as a button on the Task bar
3791 CLASS="LITERALLAYOUT"
3796 >show-on-task-bar 0</I
3799 </P
3804 NAME="CLOSE-BUTTON-MINIMIZES"
3809 >"close-button-minimizes"</SPAN
3810 > is set to 1, the Windows close
3811 button will minimize <SPAN
3814 > instead of closing
3815 the program (close with the exit option on the File menu).</P
3820 CLASS="LITERALLAYOUT"
3825 >close-button-minimizes 1</I
3828 </P
3838 >"hide-console"</SPAN
3839 > option is specific to the MS-Win console
3843 >. If this option is used,
3847 > will disconnect from and hide the
3853 CLASS="LITERALLAYOUT"
3861 </P
3872 SUMMARY="Footer navigation table"
3883 HREF="configuration.html"
3901 HREF="actions-file.html"
3911 >Privoxy Configuration</TD