NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
-TITLE="Privoxy 3.0.17 User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Privoxy Configuration"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 3.0.17 User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
></TR
><TR
><TD
>7. The Main Configuration File</A
></H1
><P
-> Again, the main configuration file is named <TT
+> By default, the main configuration file is named <TT
CLASS="FILENAME"
>config</TT
-> on
- Linux/Unix/BSD and OS/2, and <TT
+>,
+ with the exception of Windows, where it is named <TT
CLASS="FILENAME"
>config.txt</TT
-> on Windows.
+>.
Configuration lines consist of an initial keyword followed by a list of
values, all separated by whitespace (any number of spaces or tabs). For
example:</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
>confdir /etc/privoxy</I
></SPAN
></P
->
- </TT
-> </P
><P
> Assigns the value <TT
CLASS="LITERAL"
><DD
><P
> <A
-HREF="http://www.privoxy.org/user-manual/"
+HREF="https://www.privoxy.org/user-manual/"
TARGET="_top"
->http://www.privoxy.org/<TT
+>https://www.privoxy.org/<TT
CLASS="REPLACEABLE"
><I
>version</I
>Notes:</DT
><DD
><P
-> The User Manual URI is the single best source of information on
+> The User Manual URI is the single best source of information on
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>, and is used for help links from some
of the internal CGI pages. The manual itself is normally packaged with the
binary distributions, so you probably want to set this to a locally
- installed copy.
+ installed copy.
</P
><P
> Examples:
> is
located:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TD
><PRE
CLASS="SCREEN"
-> user-manual /usr/share/doc/privoxy/user-manual</PRE
+> user-manual /usr/share/doc/privoxy/user-manual</PRE
></TD
></TR
></TABLE
->
- </P
><P
> The User Manual is then available to anyone with access to
<SPAN
>).
</P
><P
-> If the documentation is not on the local system, it can be accessed
+> If the documentation is not on the local system, it can be accessed
from a remote server, as:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TD
><PRE
CLASS="SCREEN"
-> user-manual http://example.com/privoxy/user-manual/</PRE
+> user-manual http://example.com/privoxy/user-manual/</PRE
></TD
></TR
></TABLE
->
- </P
><DIV
CLASS="WARNING"
><P
>Specifies:</DT
><DD
><P
-> A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
+> A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
</P
></DD
><DT
CLASS="APPLICATION"
>Privoxy</SPAN
>
- where to find those other files. </P
+ where to find those other files.</P
><P
> The user running <SPAN
CLASS="APPLICATION"
><H4
CLASS="SECT3"
><A
+NAME="TEMPORARY-DIRECTORY"
+>7.2.3. temporary-directory</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+>A directory where Privoxy can create temporary files.</P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+>Path name</P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>unset</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+>No temporary files are created, external filters don't work.</P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> To execute <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#EXTERNAL-FILTER"
+TARGET="_top"
+>external filters</A
+></TT
+>,
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> has to create temporary files.
+ This directive specifies the directory the temporary files should
+ be written to.
+ </P
+><P
+> It should be a directory only <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ (and trusted users) can access.
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
NAME="LOGDIR"
->7.2.3. logdir</A
+>7.2.4. logdir</A
></H4
><P
></P
CLASS="SECT3"
><A
NAME="ACTIONSFILE"
->7.2.4. actionsfile</A
+>7.2.5. actionsfile</A
></H4
><A
NAME="DEFAULT.ACTION"
>Effect if unset:</DT
><DD
><P
-> No actions are taken at all. More or less neutral proxying.
+> No actions are taken at all. More or less neutral proxying.
</P
></DD
><DT
> lines are permitted, and are in fact recommended!
</P
><P
->
- The default values are <TT
+> The default values are <TT
CLASS="FILENAME"
>default.action</TT
>, which is the
>, where you can make your personal additions.
</P
><P
->
- Actions files contain all the per site and per URL configuration for
+> Actions files contain all the per site and per URL configuration for
ad blocking, cookie management, privacy considerations, etc.
- There is no point in using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> without at
- least one actions file.
- </P
-><P
-> Note that since Privoxy 3.0.7, the complete filename, including the <SPAN
-CLASS="QUOTE"
->".action"</SPAN
->
- extension has to be specified. The syntax change was necessary to be consistent
- with the other file options and to allow previously forbidden characters.
</P
></DD
></DL
CLASS="SECT3"
><A
NAME="FILTERFILE"
->7.2.5. filterfile</A
+>7.2.6. filterfile</A
></H4
><A
NAME="DEFAULT.FILTER"
>. These rules permit
powerful changes on the content of Web pages, and optionally the headers
as well, e.g., you could try to disable your favorite JavaScript annoyances,
- re-write the actual displayed text, or just have some fun
+ re-write the actual displayed text, or just have some fun
playing buzzword bingo with web pages.
</P
><P
CLASS="SECT3"
><A
NAME="LOGFILE"
->7.2.6. logfile</A
+>7.2.7. logfile</A
></H4
><P
></P
at it, <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> 3.0.7 and later only log fatal
- errors by default.
+> only logs fatal errors by default.
</P
><P
> For most troubleshooting purposes, you will have to change that,
please refer to the debugging section for details.
</P
><P
-> Your logfile will grow indefinitely, and you will probably want to
- periodically remove it. On Unix systems, you can do this with a cron job
- (see <SPAN
-CLASS="QUOTE"
->"man cron"</SPAN
->). For Red Hat based Linux distributions, a
- <B
-CLASS="COMMAND"
->logrotate</B
-> script has been included.
- </P
-><P
> Any log files must be writable by whatever user <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
>"privoxy"</SPAN
>).
</P
+><P
+> To prevent the logfile from growing indefinitely, it is recommended to
+ periodically rotate or shorten it. Many operating systems support log
+ rotation out of the box, some require additional software to do it.
+ For details, please refer to the documentation for your operating system.
+ </P
></DD
></DL
></DIV
CLASS="SECT3"
><A
NAME="TRUSTFILE"
->7.2.7. trustfile</A
+>7.2.8. trustfile</A
></H4
><P
></P
CLASS="APPLICATION"
>Privoxy</SPAN
> will only allow
- access to sites that are specified in the trustfile. Sites can be listed
+ access to sites that are specified in the trustfile. Sites can be listed
in one of two ways:
</P
><P
> Prepending a <TT
CLASS="LITERAL"
>~</TT
-> character limits access to this site
- only (and any sub-paths within this site), e.g.
+> character limits access to this site
+ only (and any sub-paths within this site), e.g.
<TT
CLASS="LITERAL"
>~www.example.com</TT
<TT
CLASS="LITERAL"
>~www.example.com/features/news.html</TT
->, etc.
+>, etc.
</P
><P
> Or, you can designate sites as <SPAN
> If you use the <TT
CLASS="LITERAL"
>+</TT
-> operator in the trust file, it may grow
+> operator in the trust file, it may grow
considerably over time.
</P
><P
><P
> The available debug levels are:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
debug 2048 # CGI user interface
debug 4096 # Startup banner and warnings.
debug 8192 # Non-fatal errors
- debug 32768 # log all data read from the network</PRE
+ debug 32768 # log all data read from the network
+ debug 65536 # Log the applying actions</PRE
></TD
></TR
></TABLE
->
- </P
><P
> To select multiple debug levels, you can either add them or use
multiple <TT
so that you will notice when things go wrong. The other levels are
probably only of interest if you are hunting down a specific problem.
They can produce a hell of an output (especially 16).
-
- </P
-><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> used to ship with the debug levels recommended above enabled by
- default, but due to privacy concerns 3.0.7 and later are configured to
- only log fatal errors.
</P
><P
> If you are used to the more verbose settings, simply enable the debug lines
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->None</I
+>1 or 0</I
></SPAN
></P
></DD
CLASS="emphasis"
><I
CLASS="EMPHASIS"
->Unset</I
+>0</I
></SPAN
></P
></DD
>Specifies:</DT
><DD
><P
-> The IP address and TCP port on which <SPAN
+> The address and TCP port on which <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
> will
>Port</I
></TT
></P
+><P
+>[<TT
+CLASS="REPLACEABLE"
+><I
+>Hostname</I
+></TT
+>]:<TT
+CLASS="REPLACEABLE"
+><I
+>Port</I
+></TT
+></P
></DD
><DT
>Default value:</DT
will need to override the default.
</P
><P
+> You can use this statement multiple times to make
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> listen on more ports or more
+ <ABBR
+CLASS="ABBREV"
+>IP</ABBR
+> addresses. Suitable if your operating system does not
+ support sharing <ABBR
+CLASS="ABBREV"
+>IPv6</ABBR
+> and <ABBR
+CLASS="ABBREV"
+>IPv4</ABBR
+> protocols
+ on the same socket.
+ </P
+><P
+> If a hostname is used instead of an IP address, <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ will try to resolve it to an IP address and if there are multiple, use the first
+ one returned.
+ </P
+><P
+> If the address for the hostname isn't already known on the system
+ (for example because it's in /etc/hostname), this may result in DNS
+ traffic.
+ </P
+><P
+> If the specified address isn't available on the system, or if the
+ hostname can't be resolved, <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ will fail to start.
+ </P
+><P
> IPv6 addresses containing colons have to be quoted by brackets.
+ They can only be used if <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> has
+ been compiled with IPv6 support. If you aren't sure if your version
+ supports it, have a look at
+ <TT
+CLASS="LITERAL"
+>http://config.privoxy.org/show-status</TT
+>.
</P
><P
-> If you leave out the IP address, <SPAN
+> Some operating systems will prefer IPv6 to IPv4 addresses even if the
+ system has no IPv6 connectivity which is usually not expected by the user.
+ Some even rely on DNS to resolve localhost which mean the "localhost" address
+ used may not actually be local.
+ </P
+><P
+> It is therefore recommended to explicitly configure the intended IP address
+ instead of relying on the operating system, unless there's a strong reason not to.
+ </P
+><P
+> If you leave out the address, <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> will
- bind to all IPv4 interfaces (addresses) on your machine and may become reachable
- from the Internet. In that case, consider using <A
+> will bind to all
+ IPv4 interfaces (addresses) on your machine and may become reachable from the
+ Internet and/or the local network. Be aware that some GNU/Linux distributions
+ modify that behaviour without updating the documentation. Check for non-standard
+ patches if your <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> version behaves differently.
+ </P
+><P
+> If you configure <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to be reachable from the
+ network, consider using <A
HREF="config.html#ACLS"
>access control lists</A
-> (ACL's, see below), and/or
- a firewall.
+>
+ (ACL's, see below), and/or a firewall.
</P
><P
> If you open <SPAN
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Suppose you are running <SPAN
CLASS="APPLICATION"
IPv6-capable machine and you want it to listen on the IPv6 address
of the loopback device:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
></DD
></DL
></DIV
>enable-remote-toggle</TT
> below.
</P
-><P
-> The windows version will only display the toggle icon in the system tray
- if this option is present.
- </P
></DD
></DL
></DIV
CLASS="APPLICATION"
>Privoxy</SPAN
> with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
</P
></DD
></DL
CLASS="APPLICATION"
>Privoxy</SPAN
> with
- support for this feature, otherwise this option has no effect.
+ support for this feature, otherwise this option has no effect.
</P
></DD
></DL
><I
>src_addr</I
></TT
-> and
+> and
<TT
CLASS="REPLACEABLE"
><I
>are not usually needed by individual users</I
></SPAN
>.
- For a typical home user, it will normally suffice to ensure that
+ For a typical home user, it will normally suffice to ensure that
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></SPAN
></A
>
- option.
+ option.
</P
><P
> Please see the warnings in the FAQ that <SPAN
></SPAN
> destination addresses are OK:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Allow any host on the same class C subnet as www.privoxy.org access to
nothing but www.example.com (or other domains hosted on the same system):
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
with the exception that 192.168.45.73 may not access the IP address behind
www.dirty-stuff.example.com:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Allow access from the IPv4 network 192.0.2.0/24 even if listening on
an IPv6 wild card address (not supported on all platforms):
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> This is equivalent to the following line even if listening on an
IPv4 address (not supported on all platforms):
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
></DD
></DL
></DIV
<TT
CLASS="LITERAL"
>+deanimate-gif</TT
-> actions, it is necessary that
+> actions, it is necessary that
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
></DL
></DIV
></DIV
-></DIV
><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
><A
-NAME="FORWARDING"
->7.5. Forwarding</A
-></H2
+NAME="ENABLE-PROXY-AUTHENTICATION-FORWARDING"
+>7.4.9. enable-proxy-authentication-forwarding</A
+></H4
><P
-> This feature allows routing of HTTP requests through a chain of
- multiple proxies.</P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
><P
-> Forwarding can be used to chain Privoxy with a caching proxy to speed
- up browsing. Using a parent proxy may also be necessary if the machine
- that <SPAN
+> Whether or not proxy authentication through <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> runs on has no direct Internet access.</P
+> should work.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
><P
-> Note that parent proxies can severely decrease your privacy level.
- For example a parent proxy could add your IP address to the request
- headers and if it's a caching proxy it may add the <SPAN
-CLASS="QUOTE"
->"Etag"</SPAN
->
- header to revalidation requests again, even though you configured Privoxy
- to remove it. It may also ignore Privoxy's header time randomization and use the
- original values which could be used by the server as cookie replacement
- to track your steps between visits.</P
+>0 or 1</P
+></DD
+><DT
+>Default value:</DT
+><DD
><P
-> Also specified here are SOCKS proxies. <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- supports the SOCKS 4 and SOCKS 4A protocols.</P
+>0</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Proxy authentication headers are removed.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Privoxy itself does not support proxy authentication, but can
+ allow clients to authenticate against Privoxy's parent proxy.
+ </P
+><P
+> By default Privoxy (3.0.21 and later) don't do that and remove
+ Proxy-Authorization headers in requests and Proxy-Authenticate
+ headers in responses to make it harder for malicious sites to
+ trick inexperienced users into providing login information.
+ </P
+><P
+> If this option is enabled the headers are forwarded.
+ </P
+><P
+> Enabling this option is <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>not recommended</I
+></SPAN
+> if there is
+ no parent proxy that requires authentication or if the local network between
+ Privoxy and the parent proxy isn't trustworthy. If proxy authentication is
+ only required for some requests, it is recommended to use a client header filter
+ to remove the authentication headers for requests where they aren't needed.
+ </P
+></DD
+></DL
+></DIV
+></DIV
><DIV
CLASS="SECT3"
><H4
CLASS="SECT3"
><A
-NAME="FORWARD"
->7.5.1. forward</A
+NAME="TRUSTED-CGI-REFERER"
+>7.4.10. trusted-cgi-referer</A
></H4
><P
></P
>Specifies:</DT
><DD
><P
-> To which parent HTTP proxy specific requests should be routed.
+> A trusted website or webpage whose links can be followed to reach sensitive CGI pages
</P
></DD
><DT
>Type of value:</DT
><DD
><P
-> <TT
-CLASS="REPLACEABLE"
-><I
->target_pattern</I
-></TT
->
- <TT
-CLASS="REPLACEABLE"
-><I
->http_parent</I
-></TT
->[:<TT
-CLASS="REPLACEABLE"
+>URL or URL prefix</P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>Unset</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> No external pages are considered trusted referers.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Before <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> accepts configuration changes through CGI pages like
+ <A
+HREF="config.html#CLIENT-SPECIFIC-TAG"
+>client-tags</A
+> or the
+ <A
+HREF="config.html#ENABLE-REMOTE-TOGGLE"
+>remote toggle</A
+>, it checks
+ the Referer header to see if the request comes from a trusted source.
+ </P
+><P
+> By default only the webinterface domains
+ <A
+HREF="http://config.privoxy.org/"
+TARGET="_top"
+>config.privoxy.org</A
+>
+ and
+ <A
+HREF="http://p.p/"
+TARGET="_top"
+>p.p</A
+>
+ are considered trustworthy.
+ Requests originating from other domains are rejected to prevent
+ third-parties from modifiying Privoxy's state by e.g. embedding
+ images that result in CGI requests.
+ </P
+><P
+> In some environments it may be desirable to embed links to CGI pages
+ on external pages, for example on an Intranet homepage the Privoxy admin
+ controls.
+ </P
+><P
+> The <SPAN
+CLASS="QUOTE"
+>"trusted-cgi-referer"</SPAN
+> option can be used to add that page,
+ or the whole domain, as trusted source so the resulting requests aren't
+ rejected.
+ Requests are accepted if the specified trusted-cgi-refer is the prefix
+ of the Referer.
+ </P
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="90%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> Declaring pages the admin doesn't control trustworthy may allow
+ malicious third parties to modify Privoxy's internal state against
+ the user's wishes and without the user's knowledge.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
+></DD
+></DL
+></DIV
+></DIV
+></DIV
+><DIV
+CLASS="SECT2"
+><H2
+CLASS="SECT2"
+><A
+NAME="FORWARDING"
+>7.5. Forwarding</A
+></H2
+><P
+> This feature allows routing of HTTP requests through a chain of
+ multiple proxies.</P
+><P
+> Forwarding can be used to chain Privoxy with a caching proxy to speed
+ up browsing. Using a parent proxy may also be necessary if the machine
+ that <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> runs on has no direct Internet access.</P
+><P
+> Note that parent proxies can severely decrease your privacy level.
+ For example a parent proxy could add your IP address to the request
+ headers and if it's a caching proxy it may add the <SPAN
+CLASS="QUOTE"
+>"Etag"</SPAN
+>
+ header to revalidation requests again, even though you configured Privoxy
+ to remove it. It may also ignore Privoxy's header time randomization and use the
+ original values which could be used by the server as cookie replacement
+ to track your steps between visits.</P
+><P
+> Also specified here are SOCKS proxies. <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ supports the SOCKS 4 and SOCKS 4A protocols.</P
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="FORWARD"
+>7.5.1. forward</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> To which parent HTTP proxy specific requests should be routed.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>target_pattern</I
+></TT
+>
+ <TT
+CLASS="REPLACEABLE"
+><I
+>http_parent</I
+></TT
+>[:<TT
+CLASS="REPLACEABLE"
><I
>port</I
></TT
> is a <A
HREF="actions-file.html#AF-PATTERNS"
>URL pattern</A
->
+>
that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <TT
CLASS="LITERAL"
>/</TT
><P
> Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Everything goes to our example ISP's caching proxy, except for requests
to that ISP's sites:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> Parent proxy specified by an IPv6 address:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TD
><PRE
CLASS="PROGRAMLISTING"
-> foward / [2001:DB8::1]:8000</PRE
+> forward / [2001:DB8::1]:8000</PRE
></TD
></TR
></TABLE
->
- </P
><P
> Suppose your parent proxy doesn't support IPv6:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
></DD
></DL
></DIV
CLASS="SECT3"
><A
NAME="SOCKS"
->7.5.2. forward-socks4, forward-socks4a and forward-socks5</A
+>7.5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</A
></H4
><A
NAME="FORWARD-SOCKS4"
> to denote <SPAN
CLASS="QUOTE"
>"no HTTP forwarding"</SPAN
->), and the optional
+>), and the optional
<TT
CLASS="REPLACEABLE"
><I
</P
><P
> <TT
+CLASS="LITERAL"
+>forward-socks5t</TT
+> works like vanilla <TT
+CLASS="LITERAL"
+>forward-socks5</TT
+> but
+ lets <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> additionally use Tor-specific SOCKS extensions. Currently the only supported
+ SOCKS extension is optimistic data which can reduce the latency for the first request made
+ on a newly created connection.
+ </P
+><P
+> <TT
CLASS="REPLACEABLE"
><I
>socks_proxy</I
their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
the Internet.
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
> A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
><P
-> To chain Privoxy and Tor, both running on the same system, you would use
+> To chain Privoxy and Tor, both running on the same system, you would use
something like:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TD
><PRE
CLASS="SCREEN"
-> forward-socks5 / 127.0.0.1:9050 .</PRE
+> forward-socks5t / 127.0.0.1:9050 .</PRE
></TD
></TR
></TABLE
->
+><P
+> Note that if you got Tor through one of the bundles, you may
+ have to change the port from 9050 to 9150 (or even another one).
+ For details, please check the documentation on the
+ <A
+HREF="https://torproject.org/"
+TARGET="_top"
+>Tor website</A
+>.
</P
><P
> The public <SPAN
reach your local network, if you need to access local servers you
therefore might want to make some exceptions:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><PRE
CLASS="SCREEN"
> forward 192.168.*.*/ .
- forward 10.*.*.*/ .
- forward 127.*.*.*/ .</PRE
+ forward 10.*.*.*/ .
+ forward 127.*.*.*/ .</PRE
></TD
></TR
></TABLE
->
- </P
><P
> Unencrypted connections to systems in these address ranges will
be as (un)secure as the local network is, but the alternative is that you
using their names, you will need additional exceptions that look like
this:
</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
></TD
></TR
></TABLE
->
- </P
></DD
></DL
></DIV
>7.5.3. Advanced Forwarding Examples</A
></H4
><P
-> If you have links to multiple ISPs that provide various special content
+> If you have links to multiple ISPs that provide various special content
only to their subscribers, you can configure multiple <SPAN
CLASS="APPLICATION"
>Privoxies</SPAN
configuration can look like this:</P
><P
> host-a:</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
-></P
><P
> host-b:</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
-></P
><P
> Now, your users can set their browser's proxy to use either
host-a or host-b and be able to browse the internal content
> If you intend to chain <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> and
+> and
<SPAN
CLASS="APPLICATION"
>squid</SPAN
-> locally, then chaining as
+> locally, then chaining as
<TT
CLASS="LITERAL"
>browser -> squid -> privoxy</TT
-> is the recommended way. </P
+> is the recommended way.</P
><P
> Assuming that <SPAN
CLASS="APPLICATION"
CLASS="APPLICATION"
>squid</SPAN
> configuration could then look like this:</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TD
><PRE
CLASS="SCREEN"
-> # Define Privoxy as parent proxy (without ICP)
- cache_peer 127.0.0.1 parent 8118 7 no-query
+> # Define Privoxy as parent proxy (without ICP)
+ cache_peer 127.0.0.1 parent 8118 7 no-query
- # Define ACL for protocol FTP
- acl ftp proto FTP
+ # Define ACL for protocol FTP
+ acl ftp proto FTP
# Do not forward FTP requests to Privoxy
- always_direct allow ftp
+ always_direct allow ftp
# Forward all the rest to Privoxy
never_direct allow all</PRE
></TD
></TR
></TABLE
-></P
><P
> You would then need to change your browser's proxy settings to <SPAN
CLASS="APPLICATION"
CLASS="LITERAL"
>antivir.example.com</TT
>, port 8010:</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
-> </P
></DIV
><DIV
CLASS="SECT3"
>Specifies:</DT
><DD
><P
-> How often Privoxy retries if a forwarded connection request fails.
+> How often Privoxy retries if a forwarded connection request fails.
</P
></DD
><DT
that go away when you try again manually. Start with a small value and check Privoxy's
logfile from time to time, to see how many retries are usually needed.
</P
-><P
-> Due to a bug, this option currently also causes Privoxy to
- retry in case of certain problems with direct connections.
- </P
></DD
><DT
>Examples:</DT
HTTP connections into <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->.
+>.
+ </P
+><P
+> Note that intercepting encrypted connections (HTTPS) isn't supported.
</P
><P
> Make sure that <SPAN
> listening port is reachable
by the outside or an attacker has access to the pages you visit.
</P
+><P
+> If you are running Privoxy as intercepting proxy without being
+ able to intercept all client requests you may want to adjust
+ the CGI templates to make sure they don't reference content from
+ config.privoxy.org.
+ </P
></DD
><DT
>Examples:</DT
> Several users have reported this as a Privoxy bug, so the
default value has been reduced. Consider increasing it to
300 seconds or even more if you think your browser can handle
- it. If your browser appears to be hanging it can't.
+ it. If your browser appears to be hanging, it probably can't.
</P
></DD
><DT
><H4
CLASS="SECT3"
><A
-NAME="DEFAULT-SERVER-TIMEOUT"
->7.6.5. default-server-timeout</A
+NAME="TOLERATE-PIPELINING"
+>7.6.5. tolerate-pipelining</A
></H4
><P
></P
>Specifies:</DT
><DD
><P
-> Assumed server-side keep-alive timeout if not specified by the server.
+> Whether or not pipelined requests should be served.
</P
></DD
><DT
> <TT
CLASS="REPLACEABLE"
><I
->Time in seconds.</I
+>0 or 1.</I
></TT
>
</P
>Effect if unset:</DT
><DD
><P
-> Connections for which the server didn't specify the keep-alive
- timeout are not reused.
+> If Privoxy receives more than one request at once, it terminates the
+ client connection after serving the first one.
</P
></DD
><DT
>Notes:</DT
><DD
><P
-> Enabling this option significantly increases the number of connections
- that are reused, provided the <A
-HREF="#KEEP-ALIVE-TIMEOUT"
-TARGET="_top"
->keep-alive-timeout</A
-> option
- is also enabled.
- </P
-><P
-> While it also increases the number of connections problems
- when <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> tries to reuse a connection that already has
- been closed on the server side, or is closed while <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->
- is trying to reuse it, this should only be a problem if it
- happens for the first request sent by the client. If it happens
- for requests on reused client connections, <SPAN
+> <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> will simply
- close the connection and the client is supposed to retry the
- request without bothering the user.
- </P
-><P
-> Enabling this option is therefore only recommended if the
- <A
-HREF="#CONNECTION-SHARING"
-TARGET="_top"
->connection-sharing</A
-> option
- is disabled.
+> currently doesn't pipeline outgoing requests,
+ thus allowing pipelining on the client connection is not
+ guaranteed to improve the performance.
</P
><P
-> It is an error to specify a value larger than the <A
-HREF="#KEEP-ALIVE-TIMEOUT"
-TARGET="_top"
->keep-alive-timeout</A
-> value.
+> By default <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> tries to discourage clients from pipelining
+ by discarding aggressively pipelined requests, which forces the
+ client to resend them through a new connection.
</P
><P
-> This option has no effect if <SPAN
+> This option lets <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
->
- has been compiled without keep-alive support.
+> tolerate pipelining. Whether or not
+ that improves performance mainly depends on the client configuration.
+ </P
+><P
+> If you are seeing problems with pages not properly loading,
+ disabling this option could work around the problem.
</P
></DD
><DT
>Examples:</DT
><DD
><P
-> default-server-timeout 60
+> tolerate-pipelining 1
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="DEFAULT-SERVER-TIMEOUT"
+>7.6.6. default-server-timeout</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Assumed server-side keep-alive timeout if not specified by the server.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Time in seconds.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>None</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Connections for which the server didn't specify the keep-alive
+ timeout are not reused.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Enabling this option significantly increases the number of connections
+ that are reused, provided the <A
+HREF="#KEEP-ALIVE-TIMEOUT"
+TARGET="_top"
+>keep-alive-timeout</A
+> option
+ is also enabled.
+ </P
+><P
+> While it also increases the number of connections problems
+ when <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> tries to reuse a connection that already has
+ been closed on the server side, or is closed while <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ is trying to reuse it, this should only be a problem if it
+ happens for the first request sent by the client. If it happens
+ for requests on reused client connections, <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> will simply
+ close the connection and the client is supposed to retry the
+ request without bothering the user.
+ </P
+><P
+> Enabling this option is therefore only recommended if the
+ <A
+HREF="#CONNECTION-SHARING"
+TARGET="_top"
+>connection-sharing</A
+> option
+ is disabled.
+ </P
+><P
+> It is an error to specify a value larger than the <A
+HREF="#KEEP-ALIVE-TIMEOUT"
+TARGET="_top"
+>keep-alive-timeout</A
+> value.
+ </P
+><P
+> This option has no effect if <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ has been compiled without keep-alive support.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> default-server-timeout 60
</P
></DD
></DL
CLASS="SECT3"
><A
NAME="CONNECTION-SHARING"
->7.6.6. connection-sharing</A
+>7.6.7. connection-sharing</A
></H4
><P
></P
there.
</P
><P
-> If there are more than one client (maybe even belonging to multiple users),
- they will be able to reuse each others connections. This is potentially
- dangerous in case of authentication schemes like NTLM where only the
- connection is authenticated, instead of requiring authentication for
- each request.
+> If there are more than one client (maybe even belonging to multiple users),
+ they will be able to reuse each others connections. This is potentially
+ dangerous in case of authentication schemes like NTLM where only the
+ connection is authenticated, instead of requiring authentication for
+ each request.
+ </P
+><P
+> If there is only a single client, and if said client can keep connections
+ alive on its own, enabling this option has next to no effect. If the client
+ doesn't support connection keep-alive, enabling this option may make sense
+ as it allows <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to keep outgoing connections alive even if the client
+ itself doesn't support it.
+ </P
+><P
+> You should also be aware that enabling this option increases the likelihood
+ of getting the "No server or forwarder data" error message, especially if you
+ are using a slow connection to the Internet.
+ </P
+><P
+> This option should only be used by experienced users who
+ understand the risks and can weight them against the benefits.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> connection-sharing 1
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="SOCKET-TIMEOUT"
+>7.6.8. socket-timeout</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Number of seconds after which a socket times out if
+ no data is received.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Time in seconds.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>None</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> A default value of 300 seconds is used.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> The default is quite high and you probably want to reduce it.
+ If you aren't using an occasionally slow proxy like Tor, reducing
+ it to a few seconds should be fine.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> socket-timeout 300
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="MAX-CLIENT-CONNECTIONS"
+>7.6.9. max-client-connections</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Maximum number of client connections that will be served.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Positive number.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>128</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Connections are served until a resource limit is reached.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> creates one thread (or process) for every incoming client
+ connection that isn't rejected based on the access control settings.
+ </P
+><P
+> If the system is powerful enough, <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can theoretically deal with
+ several hundred (or thousand) connections at the same time, but some
+ operating systems enforce resource limits by shutting down offending
+ processes and their default limits may be below the ones <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> would
+ require under heavy load.
+ </P
+><P
+> Configuring <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to enforce a connection limit below the thread
+ or process limit used by the operating system makes sure this doesn't
+ happen. Simply increasing the operating system's limit would work too,
+ but if <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> isn't the only application running on the system,
+ you may actually want to limit the resources used by <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>.
+ </P
+><P
+> If <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> is only used by a single trusted user, limiting the
+ number of client connections is probably unnecessary. If there
+ are multiple possibly untrusted users you probably still want to
+ additionally use a packet filter to limit the maximal number of
+ incoming connections per client. Otherwise a malicious user could
+ intentionally create a high number of connections to prevent other
+ users from using <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>.
+ </P
+><P
+> Obviously using this option only makes sense if you choose a limit
+ below the one enforced by the operating system.
+ </P
+><P
+> One most POSIX-compliant systems <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can't properly deal with
+ more than FD_SETSIZE file descriptors at the same time and has to reject
+ connections if the limit is reached. This will likely change in a
+ future version, but currently this limit can't be increased without
+ recompiling <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> with a different FD_SETSIZE limit.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> max-client-connections 256
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="LISTEN-BACKLOG"
+>7.6.10. listen-backlog</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Connection queue length requested from the operating system.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Number.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>128</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> A connection queue length of 128 is requested from the operating system.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Under high load incoming connection may queue up before Privoxy
+ gets around to serve them. The queue length is limitted by the
+ operating system. Once the queue is full, additional connections
+ are dropped before Privoxy can accept and serve them.
+ </P
+><P
+> Increasing the queue length allows Privoxy to accept more
+ incomming connections that arrive roughly at the same time.
+ </P
+><P
+> Note that Privoxy can only request a certain queue length,
+ whether or not the requested length is actually used depends
+ on the operating system which may use a different length instead.
+ </P
+><P
+> On many operating systems a limit of -1 can be specified to
+ instruct the operating system to use the maximum queue length
+ allowed. Check the listen man page to see if your platform allows this.
+ </P
+><P
+> On some platforms you can use "netstat -Lan -p tcp" to see the effective
+ queue length.
+ </P
+><P
+> Effectively using a value above 128 usually requires changing
+ the system configuration as well. On FreeBSD-based system the
+ limit is controlled by the kern.ipc.soacceptqueue sysctl.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> listen-backlog 4096
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="ENABLE-ACCEPT-FILTER"
+>7.6.11. enable-accept-filter</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Whether or not Privoxy should use an accept filter
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>0 or 1</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>0</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> No accept filter is enabled.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Accept filters reduce the number of context switches by not
+ passing sockets for new connections to Privoxy until a complete
+ HTTP request is available.
+ </P
+><P
+> As a result, Privoxy can process the whole request right away
+ without having to wait for additional data first.
+ </P
+><P
+> For this option to work, Privoxy has to be compiled with
+ FEATURE_ACCEPT_FILTER and the operating system has to support
+ it (which may require loading a kernel module).
+ </P
+><P
+> Currently accept filters are only supported on FreeBSD-based
+ systems. Check the
+ <A
+HREF="https://www.freebsd.org/cgi/man.cgi?query=accf_http"
+TARGET="_top"
+>accf_http(9)
+ man page</A
+>
+ to learn how to enable the support in the operating system.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><P
+> enable-accept-filter 1
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="HANDLE-AS-EMPTY-DOC-RETURNS-OK"
+>7.6.12. handle-as-empty-doc-returns-ok</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> The status code Privoxy returns for pages blocked with
+
+ <TT
+CLASS="LITERAL"
+><A
+HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
+TARGET="_top"
+>+handle-as-empty-document</A
+></TT
+>.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>0 or 1</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>0</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Privoxy returns a status 403(forbidden) for all blocked pages.
+ </P
+></DD
+><DT
+>Effect if set:</DT
+><DD
+><P
+> Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
+ and a status 403(Forbidden) for all other blocked pages.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> This directive was added as a work-around for Firefox bug 492459:
+ <SPAN
+CLASS="QUOTE"
+>"Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy."</SPAN
+>
+ (<A
+HREF="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
+TARGET="_top"
+> https://bugzilla.mozilla.org/show_bug.cgi?id=492459</A
+>),
+ the bug has been fixed for quite some time, but this directive is also useful
+ to make it harder for websites to detect whether or not resources are being
+ blocked.
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="ENABLE-COMPRESSION"
+>7.6.13. enable-compression</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> Whether or not buffered content is compressed before delivery.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>0 or 1</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>0</P
+></DD
+><DT
+>Effect if unset:</DT
+><DD
+><P
+> Privoxy does not compress buffered content.
+ </P
+></DD
+><DT
+>Effect if set:</DT
+><DD
+><P
+> Privoxy compresses buffered content before delivering it to the client,
+ provided the client supports it.
+ </P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> This directive is only supported if Privoxy has been compiled with
+ FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
+ </P
+><P
+> Compressing buffered content is mainly useful if Privoxy and the
+ client are running on different systems. If they are running on the
+ same system, enabling compression is likely to slow things down.
+ If you didn't measure otherwise, you should assume that it does
+ and keep this option disabled.
+ </P
+><P
+> Privoxy will not compress buffered content below a certain length.
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="COMPRESSION-LEVEL"
+>7.6.14. compression-level</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> The compression level that is passed to the zlib library when compressing buffered content.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Positive number ranging from 0 to 9.</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>1</P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> Compressing the data more takes usually longer than compressing
+ it less or not compressing it at all. Which level is best depends
+ on the connection between Privoxy and the client. If you can't
+ be bothered to benchmark it for yourself, you should stick with
+ the default and keep compression disabled.
+ </P
+><P
+> If compression is disabled, the compression level is irrelevant.
+ </P
+></DD
+><DT
+>Examples:</DT
+><DD
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Best speed (compared to the other levels)
+ compression-level 1
+
+ # Best compression
+ compression-level 9
+
+ # No compression. Only useful for testing as the added header
+ # slightly increases the amount of data that has to be sent.
+ # If your benchmark shows that using this compression level
+ # is superior to using no compression at all, the benchmark
+ # is likely to be flawed.
+ compression-level 0</PRE
+></TD
+></TR
+></TABLE
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="CLIENT-HEADER-ORDER"
+>7.6.15. client-header-order</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> The order in which client headers are sorted before forwarding them.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Client header names delimited by spaces or tabs</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>None</P
+></DD
+><DT
+>Notes:</DT
+><DD
+><P
+> By default <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> leaves the client headers in the order they
+ were sent by the client. Headers are modified in-place, new headers
+ are added at the end of the already existing headers.
+ </P
+><P
+> The header order can be used to fingerprint client requests
+ independently of other headers like the User-Agent.
+ </P
+><P
+> This directive allows to sort the headers differently to better
+ mimic a different User-Agent. Client headers will be emitted
+ in the order given, headers whose name isn't explicitly specified
+ are added at the end.
+ </P
+><P
+> Note that sorting headers in an uncommon way will make fingerprinting
+ actually easier. Encrypted headers are not affected by this directive.
+ </P
+></DD
+></DL
+></DIV
+></DIV
+><DIV
+CLASS="SECT3"
+><H4
+CLASS="SECT3"
+><A
+NAME="CLIENT-SPECIFIC-TAG"
+>7.6.16. client-specific-tag</A
+></H4
+><P
+></P
+><DIV
+CLASS="VARIABLELIST"
+><DL
+><DT
+>Specifies:</DT
+><DD
+><P
+> The name of a tag that will always be set for clients that
+ requested it through the webinterface.
+ </P
+></DD
+><DT
+>Type of value:</DT
+><DD
+><P
+> <TT
+CLASS="REPLACEABLE"
+><I
+>Tag name followed by a description that will be shown in the webinterface</I
+></TT
+>
+ </P
+></DD
+><DT
+>Default value:</DT
+><DD
+><P
+>None</P
+></DD
+><DT
+>Notes:</DT
+><DD
+><DIV
+CLASS="WARNING"
+><P
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="90%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> This is an experimental feature. The syntax is likely to change
+ in future versions.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
+><P
+> Client-specific tags allow Privoxy admins to create different
+ profiles and let the users chose which one they want without
+ impacting other users.
+ </P
+><P
+> One use case is allowing users to circumvent certain blocks
+ without having to allow them to circumvent all blocks.
+ This is not possible with the
+ <A
+HREF="config.html#ENABLE-REMOTE-TOGGLE"
+>enable-remote-toggle feature</A
+>
+ because it would bluntly disable all blocks for all users and also affect
+ other actions like filters.
+ It also is set globally which renders it useless in most multi-user setups.
</P
><P
-> If there is only a single client, and if said client can keep connections
- alive on its own, enabling this option has next to no effect. If the client
- doesn't support connection keep-alive, enabling this option may make sense
- as it allows <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> to keep outgoing connections alive even if the client
- itself doesn't support it.
+> After a client-specific tag has been defined with the client-specific-tag
+ directive, action sections can be activated based on the tag by using a
+ <A
+HREF="actions-file.html#CLIENT-TAG-PATTERN"
+TARGET="_top"
+>CLIENT-TAG</A
+> pattern.
+ The CLIENT-TAG pattern is evaluated at the same priority
+ as URL patterns, as a result the last matching pattern wins.
+ Tags that are created based on client or server headers are evaluated
+ later on and can overrule CLIENT-TAG and URL patterns!
</P
><P
-> You should also be aware that enabling this option increases the likelihood
- of getting the "No server or forwarder data" error message, especially if you
- are using a slow connection to the Internet.
+> The tag is set for all requests that come from clients that requested
+ it to be set.
+ Note that "clients" are differentiated by IP address,
+ if the IP address changes the tag has to be requested again.
</P
><P
-> This option should only be used by experienced users who
- understand the risks and can weight them against the benefits.
+> Clients can request tags to be set by using the CGI interface <A
+HREF="http://config.privoxy.org/client-tags"
+TARGET="_top"
+>http://config.privoxy.org/client-tags</A
+>.
+ The specific tag description is only used on the web page and should
+ be phrased in away that the user understand the effect of the tag.
</P
></DD
><DT
>Examples:</DT
><DD
-><P
-> connection-sharing 1
- </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Define a couple of tags, the described effect requires action sections
+ # that are enabled based on CLIENT-TAG patterns.
+ client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
+ disable-content-filters Disable content-filters but do not affect other actions</PRE
+></TD
+></TR
+></TABLE
></DD
></DL
></DIV
><H4
CLASS="SECT3"
><A
-NAME="SOCKET-TIMEOUT"
->7.6.7. socket-timeout</A
+NAME="CLIENT-TAG-LIFETIME"
+>7.6.17. client-tag-lifetime</A
></H4
><P
></P
>Specifies:</DT
><DD
><P
-> Number of seconds after which a socket times out if
- no data is received.
+> How long a temporarily enabled tag remains enabled.
</P
></DD
><DT
>Default value:</DT
><DD
><P
->None</P
+>60</P
></DD
><DT
->Effect if unset:</DT
+>Notes:</DT
><DD
+><DIV
+CLASS="WARNING"
><P
-> A default value of 300 seconds is used.
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="90%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> This is an experimental feature. The syntax is likely to change
+ in future versions.
+ </P
+></TD
+></TR
+></TABLE
+></DIV
+><P
+> In case of some tags users may not want to enable them permanently,
+ but only for a short amount of time, for example to circumvent a block
+ that is the result of an overly-broad URL pattern.
</P
-></DD
-><DT
->Notes:</DT
-><DD
><P
-> For SOCKS requests the timeout currently doesn't start until
- the SOCKS server accepted the request. This will be fixed in
- the next release.
+> The CGI interface <A
+HREF="http://config.privoxy.org/client-tags"
+TARGET="_top"
+>http://config.privoxy.org/client-tags</A
+>
+ therefore provides a "enable this tag temporarily" option.
+ If it is used, the tag will be set until the client-tag-lifetime
+ is over.
</P
></DD
><DT
>Examples:</DT
><DD
-><P
-> socket-timeout 300
- </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Increase the time to life for temporarily enabled tags to 3 minutes
+ client-tag-lifetime 180</PRE
+></TD
+></TR
+></TABLE
></DD
></DL
></DIV
><H4
CLASS="SECT3"
><A
-NAME="MAX-CLIENT-CONNECTIONS"
->7.6.8. max-client-connections</A
+NAME="TRUST-X-FORWARDED-FOR"
+>7.6.18. trust-x-forwarded-for</A
></H4
><P
></P
>Specifies:</DT
><DD
><P
-> Maximum number of client connections that will be served.
+> Whether or not Privoxy should use IP addresses specified with the X-Forwarded-For header
</P
></DD
><DT
> <TT
CLASS="REPLACEABLE"
><I
->Positive number.</I
+>0 or one</I
></TT
>
</P
>Default value:</DT
><DD
><P
->None</P
-></DD
-><DT
->Effect if unset:</DT
-><DD
-><P
-> Connections are served until a resource limit is reached.
- </P
+>0</P
></DD
><DT
>Notes:</DT
><DD
+><DIV
+CLASS="WARNING"
><P
-> <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> creates one thread (or process) for every incoming client
- connection that isn't rejected based on the access control settings.
+></P
+><TABLE
+CLASS="WARNING"
+BORDER="1"
+WIDTH="90%"
+><TR
+><TD
+ALIGN="CENTER"
+><B
+>Warning</B
+></TD
+></TR
+><TR
+><TD
+ALIGN="LEFT"
+><P
+> This is an experimental feature. The syntax is likely to change
+ in future versions.
</P
+></TD
+></TR
+></TABLE
+></DIV
><P
-> If the system is powerful enough, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> can theoretically deal with
- several hundred (or thousand) connections at the same time, but some
- operating systems enforce resource limits by shutting down offending
- processes and their default limits may be below the ones <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> would
- require under heavy load.
+> If clients reach Privoxy through another proxy, for example a load
+ balancer, Privoxy can't tell the client's IP address from the connection.
+ If multiple clients use the same proxy, they will share the same
+ client tag settings which is usually not desired.
</P
><P
-> Configuring <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> to enforce a connection limit below the thread
- or process limit used by the operating system makes sure this doesn't
- happen. Simply increasing the operating system's limit would work too,
- but if <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> isn't the only application running on the system,
- you may actually want to limit the resources used by <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->.
+> This option lets Privoxy use the X-Forwarded-For header value as
+ client IP address. If the proxy sets the header, multiple clients
+ using the same proxy do not share the same client tag settings.
</P
><P
-> If <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is only used by a single trusted user, limiting the
- number of client connections is probably unnecessary. If there
- are multiple possibly untrusted users you probably still want to
- additionally use a packet filter to limit the maximal number of
- incoming connections per client. Otherwise a malicious user could
- intentionally create a high number of connections to prevent other
- users from using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->.
+> This option should only be enabled if Privoxy can only be reached
+ through a proxy and if the proxy can be trusted to set the header
+ correctly. It is recommended that ACL are used to make sure only
+ trusted systems can reach Privoxy.
</P
><P
-> Obviously using this option only makes sense if you choose a limit
- below the one enforced by the operating system.
+> If access to Privoxy isn't limited to trusted systems, this option
+ would allow malicious clients to change the client tags for other
+ clients or increase Privoxy's memory requirements by registering
+ lots of client tag settings for clients that don't exist.
</P
></DD
><DT
>Examples:</DT
><DD
-><P
-> max-client-connections 256
- </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Allow systems that can reach Privoxy to provide the client
+ # IP address with a X-Forwarded-For header.
+ trust-x-forwarded-for 1</PRE
+></TD
+></TR
+></TABLE
></DD
></DL
></DIV
><H4
CLASS="SECT3"
><A
-NAME="HANDLE-AS-EMPTY-DOC-RETURNS-OK"
->7.6.9. handle-as-empty-doc-returns-ok</A
+NAME="RECEIVE-BUFFER-SIZE"
+>7.6.19. receive-buffer-size</A
></H4
><P
></P
CLASS="VARIABLELIST"
><DL
><DT
->Note:</DT
-><DD
-><P
-> This is a work-around for Firefox bug 492459:
- <SPAN
-CLASS="QUOTE"
->" Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
- "</SPAN
->
- (<A
-HREF="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
-TARGET="_top"
->https://bugzilla.mozilla.org/show_bug.cgi?id=492459</A
->)
- </P
-></DD
-><DT
>Specifies:</DT
><DD
><P
-> The status code Privoxy returns for pages blocked with
-
- <TT
-CLASS="LITERAL"
-><A
-HREF="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT"
-TARGET="_top"
->+handle-as-empty-document</A
-></TT
->.
+> The size of the buffer Privoxy uses to receive data from the server.
</P
></DD
><DT
> <TT
CLASS="REPLACEABLE"
><I
->0 or 1</I
+>Size in bytes</I
></TT
>
</P
>Default value:</DT
><DD
><P
->0</P
+>5000</P
></DD
><DT
->Effect if unset:</DT
+>Notes:</DT
><DD
><P
-> Privoxy returns a status 403(forbidden) for all blocked pages.
+> Increasing the receive-buffer-size increases Privoxy's memory usage but
+ can lower the number of context switches and thereby reduce the
+ cpu usage and potentially increase the throughput.
+ </P
+><P
+> This is mostly relevant for fast network connections and
+ large downloads that don't require filtering.
+ </P
+><P
+> Reducing the buffer size reduces the amount of memory Privoxy
+ needs to handle the request but increases the number of systemcalls
+ and may reduce the throughput.
+ </P
+><P
+> A dtrace command like:
+ <SPAN
+CLASS="QUOTE"
+>"sudo dtrace -n 'syscall::read:return /execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'"</SPAN
+>
+ can be used to properly tune the receive-buffer-size.
+ On systems without dtrace, strace or truss may be used as
+ less convenient alternatives.
+ </P
+><P
+> If the buffer is too large it will increase Privoxy's memory
+ footprint without any benefit. As the memory is (currently)
+ cleared before using it, a buffer that is too large can
+ actually reduce the throughput.
</P
></DD
><DT
->Effect if set:</DT
+>Examples:</DT
><DD
-><P
-> Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
- and a status 403(Forbidden) for all other blocked pages.
- </P
+><TABLE
+BORDER="0"
+BGCOLOR="#E0E0E0"
+WIDTH="90%"
+><TR
+><TD
+><PRE
+CLASS="SCREEN"
+> # Increase the receive buffer size
+ receive-buffer-size 32768</PRE
+></TD
+></TR
+></TABLE
></DD
></DL
></DIV
>"Privoxy"</SPAN
> is active. To turn off, set to 0.</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>activity-animation 1</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-MESSAGES"
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> will log messages to the console
- window:</P
+> copies log messages to the console
+ window.
+ The log detail depends on the <A
+HREF="config.html#DEBUG"
+>debug</A
+> directive.</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-messages 1</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-BUFFER-SIZE"
></A
><P
->
- If <SPAN
+> If <SPAN
CLASS="QUOTE"
>"log-buffer-size"</SPAN
> is set to 1, the size of the log buffer,
> Warning: Setting this to 0 will result in the buffer to grow infinitely and
eat up all your memory!</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-buffer-size 1</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-MAX-LINES"
> is the maximum number of lines held
in the log buffer. See above.</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-max-lines 200</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-HIGHLIGHT-MESSAGES"
> will highlight portions of the log
messages with a bold-faced font:</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-highlight-messages 1</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-FONT-NAME"
><P
> The font used in the console window:</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-font-name Comic Sans MS</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="LOG-FONT-SIZE"
><P
> Font size used in the console window:</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>log-font-size 8</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="SHOW-ON-TASK-BAR"
></A
><P
->
- <SPAN
+> <SPAN
CLASS="QUOTE"
>"show-on-task-bar"</SPAN
> controls whether or not
> will appear as a button on the Task bar
when minimized:</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>show-on-task-bar 0</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="CLOSE-BUTTON-MINIMIZES"
> instead of closing
the program (close with the exit option on the File menu).</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>close-button-minimizes 1</I
></SPAN
-><br>
- </P
->
- </TT
></P
><A
NAME="HIDE-CONSOLE"
> will disconnect from and hide the
command console.</P
><P
-> <TT
-CLASS="LITERAL"
-> <P
CLASS="LITERALLAYOUT"
> #<SPAN
CLASS="emphasis"
CLASS="EMPHASIS"
>hide-console</I
></SPAN
-><br>
- </P
->
- </TT
></P
></DIV
></DIV
></DIV
></BODY
></HTML
->
+>
\ No newline at end of file
projects / privoxy.git / blobdiff