<!--
- File : $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
+ File : doc/source/p-config.sgml
Purpose : Used with other docs and files only.
- $Id: p-config.sgml,v 2.125 2017/03/08 13:11:01 fabiankeil Exp $
-
- Copyright (C) 2001-2017 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
Sample Configuration File for Privoxy &p-version;
</title>
<para>
- $Id: p-config.sgml,v 2.125 2017/03/08 13:11:01 fabiankeil Exp $
-</para>
-<para>
-Copyright (C) 2001-2017 Privoxy Developers https://www.privoxy.org/
+Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
</para>
<para>
<para>
Unix, in local filesystem (may not work with all browsers):
</para>
- <para>
<screen> user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
- </para>
<para>
Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
</para>
- <para>
<screen> user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
- </para>
<para>
Windows, UNC notation (with forward slashes):
</para>
- <para>
<screen> user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
- </para>
-->
<para>
The best all purpose solution is simply to put the full local
<literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
located:
</para>
- <para>
<screen> user-manual /usr/share/doc/privoxy/user-manual</screen>
- </para>
<para>
The User Manual is then available to anyone with access to
<application>Privoxy</application>, by following the built-in URL:
If the documentation is not on the local system, it can be accessed
from a remote server, as:
</para>
- <para>
<screen> user-manual http://example.com/privoxy/user-manual/</screen>
- </para>
<![%user-man;[
<!-- this gets hammered in conversion to config. Text repeated below. -->
<warning>
<para>
The available debug levels are:
</para>
- <para>
<programlisting>
debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
debug 2 # show each connection status
debug 32768 # log all data read from the network
debug 65536 # Log the applying actions
</programlisting>
- </para>
<para>
To select multiple debug levels, you can either add them or use
multiple <literal>debug</literal> lines.
(192.168.0.0) and has another outside connection with a different address.
You want it to serve requests from inside only:
</para>
- <para>
<programlisting>
listen-address 192.168.0.1:8118
</programlisting>
- </para>
<para>
Suppose you are running <application>Privoxy</application> on an
IPv6-capable machine and you want it to listen on the IPv6 address
of the loopback device:
</para>
- <para>
<programlisting>
listen-address [::1]:8118
</programlisting>
- </para>
</listitem>
</varlistentry>
</variablelist>
is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
<emphasis>all</emphasis> destination addresses are OK:
</para>
- <para>
<screen>
permit-access localhost
</screen>
- </para>
<para>
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):
</para>
- <para>
<screen>
permit-access www.privoxy.org/24 www.example.com/32
</screen>
- </para>
<para>
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:
</para>
- <para>
<screen>
permit-access 192.168.45.64/26
deny-access 192.168.45.73 www.dirty-stuff.example.com
</screen>
- </para>
<para>
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):
</para>
- <para>
<programlisting>
permit-access 192.0.2.0/24
</programlisting>
- </para>
<para>
This is equivalent to the following line even if listening on an
IPv4 address (not supported on all platforms):
</para>
- <para>
<programlisting>
permit-access [::ffff:192.0.2.0]/120
</programlisting>
- </para>
</listitem>
</varlistentry>
</variablelist>
<para>
Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
</para>
- <para>
<screen>
forward / parent-proxy.example.org:8080
forward :443 .
</screen>
- </para>
<para>
Everything goes to our example ISP's caching proxy, except for requests
to that ISP's sites:
</para>
- <para>
<screen>
forward / caching-proxy.isp.example.net:8000
forward .isp.example.net .
</screen>
- </para>
<para>
Parent proxy specified by an IPv6 address:
</para>
- <para>
<programlisting>
forward / [2001:DB8::1]:8000
</programlisting>
- </para>
<para>
Suppose your parent proxy doesn't support IPv6:
</para>
- <para>
<programlisting>
forward / parent-proxy.example.org:8000
forward ipv6-server.example.org .
forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
</programlisting>
- </para>
</listitem>
</varlistentry>
</variablelist>
their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
the Internet.
</para>
- <para>
<screen>
forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
forward .example.com .
</screen>
- </para>
<para>
A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
</para>
- <para>
<screen>
forward-socks4 / socks-gw.example.com:1080 .
</screen>
- </para>
<para>
To chain Privoxy and Tor, both running on the same system, you would use
something like:
</para>
- <para>
<screen>
forward-socks5t / 127.0.0.1:9050 .
</screen>
- </para>
<para>
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).
reach your local network, if you need to access local servers you
therefore might want to make some exceptions:
</para>
- <para>
<screen>
forward 192.168.*.*/ .
forward 10.*.*.*/ .
forward 127.*.*.*/ .
</screen>
- </para>
<para>
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:
</para>
- <para>
<screen>
forward localhost/ .
</screen>
- </para>
</listitem>
</varlistentry>
host-a:
</para>
-<para>
<screen>
forward / .
forward .isp-b.example.net host-b:8118
</screen>
-</para>
<para>
host-b:
</para>
-<para>
<screen>
forward / .
forward .isp-a.example.org host-a:8118
</screen>
-</para>
<para>
Now, your users can set their browser's proxy to use either
run on the same box, your <application>squid</application> configuration could then look like this:
</para>
-<para>
<screen>
# Define Privoxy as parent proxy (without ICP)
cache_peer 127.0.0.1 parent 8118 7 no-query
# Forward all the rest to Privoxy
never_direct allow all</screen>
-</para>
<para>
You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
say, on <literal>antivir.example.com</literal>, port 8010:
</para>
-<para>
<screen>
forward / .
forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010</screen>
-</para>
</sect3>
]]>
</sect3>
+<sect3 renderas="sect4" id="listen-backlog"><title>listen-backlog</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ Connection queue length requested from the operating system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>Number.</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>128</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if unset:</term>
+ <listitem>
+ <para>
+ A connection queue length of 128 is requested from the operating system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ Increasing the queue length allows Privoxy to accept more
+ incomming connections that arrive roughly at the same time.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ On some platforms you can use "netstat -Lan -p tcp" to see the effective
+ queue length.
+ </para>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Examples:</term>
+ <listitem>
+ <para>
+ listen-backlog 4096
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@#listen-backlog -1</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="enable-accept-filter"><title>enable-accept-filter</title>
+<variablelist>
+ <varlistentry>
+ <term>Specifies:</term>
+ <listitem>
+ <para>
+ Whether or not Privoxy should use an accept filter
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Type of value:</term>
+ <listitem>
+ <para>
+ <replaceable>0 or 1</replaceable>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Default value:</term>
+ <listitem>
+ <para>0</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Effect if unset:</term>
+ <listitem>
+ <para>
+ No accept filter is enabled.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notes:</term>
+ <listitem>
+ <para>
+ Accept filters reduce the number of context switches by not
+ passing sockets for new connections to Privoxy until a complete
+ HTTP request is available.
+ </para>
+ <para>
+ As a result, Privoxy can process the whole request right away
+ without having to wait for additional data first.
+ </para>
+ <para>
+ 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).
+ </para>
+ <para>
+ Currently accept filters are only supported on FreeBSD-based
+ systems. Check the
+ <ulink url="https://www.freebsd.org/cgi/man.cgi?query=accf_http">accf_http(9)
+ man page</ulink>
+ to learn how to enable the support in the operating system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Examples:</term>
+ <listitem>
+ <para>
+ enable-accept-filter 1
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@#enable-accept-filter 1</literallayout>]]>
+</sect3>
+
+
<sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
<variablelist>
<varlistentry>
<varlistentry>
<term>Examples:</term>
<listitem>
- <para>
<screen>
# Best speed (compared to the other levels)
compression-level 1
# is likely to be flawed.
compression-level 0
</screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
- <para>
<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
</screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
- <para>
<screen>
# Increase the time to life for temporarily enabled tags to 3 minutes
client-tag-lifetime 180
</screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
- <para>
<screen>
# Allow systems that can reach Privoxy to provide the client
# IP address with a X-Forwarded-For header.
trust-x-forwarded-for 1
</screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
- <para>
<screen>
# Increase the receive buffer size
receive-buffer-size 32768
</screen>
- </para>
</listitem>
</varlistentry>
</variablelist>
projects / privoxy.git / blobdiff