When building from a source tarball, first unpack the source:
- tar xzvf privoxy-3.0.33-beta-src.tar.gz
- cd privoxy-3.0.33-beta
+ tar xzvf privoxy-3.0.33-stable-src.tar.gz
+ cd privoxy-3.0.33-stable
To build the development version, you can get the source code by doing:
*
*********************************************************************/
-This README is included with the development version of Privoxy 3.0.33. See
-https://www.privoxy.org/ for more information. The current code maturity level
-is "UNRELEASED", but seems stable to us :).
+This README is included with Privoxy 3.0.33. See https://www.privoxy.org/ for
+more information. The current code maturity level is "stable".
-------------------------------------------------------------------------------
The actions list can be configured via the web interface accessed via http://
p.p/, as well other options.
-All configuration files are subject to unannounced changes during the
-development process.
-
-------------------------------------------------------------------------------
5. DOCUMENTATION
-There should be documentation in the 'doc' subdirectory, but it may not be
-completed at this point. In particular, see the User Manual there, the FAQ, and
-those interested in Privoxy development, should look at developer-manual.
+There should be documentation in the 'doc' subdirectory. In particular, see the
+User Manual there, the FAQ, and those interested in Privoxy development, should
+look at developer-manual.
-The most up to date source of information on the current development version,
-may still be either comments in the source code, or the included configuration
-files. The source and configuration files are all well commented. The main
-configuration files are: 'config', 'default.action', and 'default.filter' in
-the top-level source directory.
+The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter'.
Included documentation may vary according to platform and packager. All
documentation is posted on https://www.privoxy.org, in case you don't have it,
<p><a href="https://www.privoxy.org/donate" target="_top">https://www.privoxy.org/donate</a></p>
</li>
</ul>
- <p>The most recent release is <a href="announce.txt" target="_top">3.0.33 (UNRELEASED)</a>.</p>
+ <p>The most recent release is <a href="announce.txt" target="_top">3.0.33 (stable)</a>.</p>
</div>
</div>
<hr>
these. If not, you will get a friendly error message. Internet access is not necessary either.</p>
<ul>
<li>
- <p>Privoxy main page:</p><a name="AEN6361" id="AEN6361"></a>
+ <p>Privoxy main page:</p><a name="AEN6368" id="AEN6368"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/" target="_top">http://config.privoxy.org/</a></p>
</blockquote>
"APPLICATION">Privoxy</span>)</p>
</li>
<li>
- <p>View and toggle client tags:</p><a name="AEN6369" id="AEN6369"></a>
+ <p>View and toggle client tags:</p><a name="AEN6376" id="AEN6376"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/client-tags" target=
"_top">http://config.privoxy.org/client-tags</a></p>
</li>
<li>
<p>Show information about the current configuration, including viewing and editing of actions
- files:</p><a name="AEN6374" id="AEN6374"></a>
+ files:</p><a name="AEN6381" id="AEN6381"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-status" target=
"_top">http://config.privoxy.org/show-status</a></p>
</blockquote>
</li>
<li>
- <p>Show the browser's request headers:</p><a name="AEN6379" id="AEN6379"></a>
+ <p>Show the browser's request headers:</p><a name="AEN6386" id="AEN6386"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-request" target=
"_top">http://config.privoxy.org/show-request</a></p>
</blockquote>
</li>
<li>
- <p>Show which actions apply to a URL and why:</p><a name="AEN6384" id="AEN6384"></a>
+ <p>Show which actions apply to a URL and why:</p><a name="AEN6391" id="AEN6391"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-url-info" target=
"_top">http://config.privoxy.org/show-url-info</a></p>
<li>
<p>Toggle Privoxy on or off. This feature can be turned off/on in the main <tt class="FILENAME">config</tt>
file. When toggled <span class="QUOTE">"off"</span>, <span class="QUOTE">"Privoxy"</span> continues to run,
- but only as a pass-through proxy, with no actions taking place:</p><a name="AEN6392" id="AEN6392"></a>
+ but only as a pass-through proxy, with no actions taking place:</p><a name="AEN6399" id="AEN6399"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle" target="_top">http://config.privoxy.org/toggle</a></p>
</blockquote>
- <p>Short cuts. Turn off, then on:</p><a name="AEN6396" id="AEN6396"></a>
+ <p>Short cuts. Turn off, then on:</p><a name="AEN6403" id="AEN6403"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle?set=disable" target=
"_top">http://config.privoxy.org/toggle?set=disable</a></p>
- </blockquote><a name="AEN6399" id="AEN6399"></a>
+ </blockquote><a name="AEN6406" id="AEN6406"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle?set=enable" target=
"_top">http://config.privoxy.org/toggle?set=enable</a></p>
<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>
+ <div class="WARNING">
+ <table class="WARNING" border="1" width="90%">
+ <tr>
+ <td align="center"><b>Warning</b></td>
+ </tr>
+ <tr>
+ <td align="left">
+ <p>When a TLS library is being used to read or write data from a socket with <tt class=
+ "LITERAL"><a href="actions-file.html#HTTPS-INSPECTION" target="_top">https-inspection</a></tt>
+ enabled the socket-timeout currently isn't applied and the timeout used depends on the library
+ (which may not even use a timeout).</p>
+ </td>
+ </tr>
+ </table>
+ </div>
</dd>
<dt>Example:</dt>
<dd>
<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>
+ more than FD_SETSIZE file descriptors if <span class="APPLICATION">Privoxy</span> has been configured to
+ use select() and has to reject connections if the limit is reached. When using select() this limit
+ therefore can't be increased without recompiling <span class="APPLICATION">Privoxy</span> with a
+ different FD_SETSIZE limit unless <span class="APPLICATION">Privoxy</span> is running on Windows with
+ _WIN32 defined.</p>
+ <p>When <span class="APPLICATION">Privoxy</span> has been configured to use poll() the FD_SETSIZE limit
+ does not apply.</p>
</dd>
<dt>Example:</dt>
<dd>
<dd>
<p>This directive specifies the password for the CA keyfile that is used when Privoxy generates
certificates for intercepted requests.</p>
- <p>Note that the password is shown on the CGI page so don't reuse an important one.</p>
+ <div class="WARNING">
+ <table class="WARNING" border="1" width="90%">
+ <tr>
+ <td align="center"><b>Warning</b></td>
+ </tr>
+ <tr>
+ <td align="left">
+ <p>Note that the password is shown on the CGI page so don't reuse an important one.</p>
+ <p>If disclosure of the password is a compliance issue consider blocking the relevant CGI
+ requests after enabling the <a href="config.html#ENFORCE-BLOCKS">enforce-blocks</a> and <a href=
+ "config.html#ALLOW-CGI-REQUEST-CRUNCHING">allow-cgi-request-crunching</a>.</p>
+ </td>
+ </tr>
+ </table>
+ </div>
</dd>
<dt>Example:</dt>
<dd>
<tr>
<td>
<pre class="SCREEN"> </pre>
- <h2 class="BRIDGEHEAD"><a name="AEN845"></a> Privoxy Menu</h2>
+ <h2 class="BRIDGEHEAD"><a name="AEN842"></a> Privoxy Menu</h2>
<pre><br></pre>
<table border="0">
<tbody>
<h2 class="SECT2"><a name="CONFOVERVIEW">6.2. Configuration Files Overview</a></h2>
<p>For Unix, *BSD and GNU/Linux, all configuration files are located in <tt class="FILENAME">/etc/privoxy/</tt>
by default. For MS Windows these are all in the same directory as the <span class="APPLICATION">Privoxy</span>
- executable. The name and number of configuration files has changed from previous versions, and is subject to
- change as development progresses.</p>
+ executable.</p>
<p>The installed defaults provide a reasonable starting point, though some settings may be aggressive by some
standards. For the time being, the principle configuration files are:</p>
<ul>
listening address of <span class="APPLICATION">Privoxy</span>, these <span class="QUOTE">"wake up"</span>
requests must obviously be sent to the <span class="emphasis"><i class="EMPHASIS">old</i></span> listening
address.</p>
- <p>While under development, the configuration content is subject to change. The below documentation may not be
- accurate by the time you read this. Also, what constitutes a <span class="QUOTE">"default"</span> setting, may
- change, so please check all your configuration files on important issues.</p>
</div>
</div>
<div class="NAVFOOTER">
Stefan Huehner<br>
Basil Hussain<br>
Peter Hyman<br>
+ Artem Ivanov<br>
Derek Jennings<br>
Andrew Jones<br>
Julien Joubert<br>
Sam<br>
Saperski<br>
Bart Schelstraete<br>
+ Richard Schneidt<br>
Gregory Seidman<br>
Atman Sense<br>
Mark Seward<br>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="SCREEN"> tar xzvf privoxy-3.0.33-beta-src.tar.gz
- cd privoxy-3.0.33-beta</pre>
+ <pre class="SCREEN"> tar xzvf privoxy-3.0.33-stable-src.tar.gz
+ cd privoxy-3.0.33-stable</pre>
</td>
</tr>
</table>
</div>
<div class="SECT1">
<h1 class="SECT1"><a name="INTRODUCTION" id="INTRODUCTION">1. Introduction</a></h1>
- <p>This documentation is included with the current UNRELEASED version of <span class="APPLICATION">Privoxy</span>,
- 3.0.33, and is mostly complete at this point. The most up to date reference for the time being is still the
- comments in the source files and in the individual configuration files. Development of a new version is currently
- nearing completion, and includes significant changes and enhancements over earlier versions.</p>
- <p>Since this is a UNRELEASED version, not all new features are well tested. This documentation may be slightly out
- of sync as a result (especially with <a href="https://www.privoxy.org/gitweb/?p=privoxy.git;a=summary" target=
- "_top">git sources</a>). And there <span class="emphasis"><i class="EMPHASIS">may be</i></span> bugs, though
- hopefully not many!</p>
+ <p>This documentation is included with the current stable version of <span class="APPLICATION">Privoxy</span>,
+ 3.0.33.</p>
<div class="SECT2">
<h2 class="SECT2"><a name="FEATURES" id="FEATURES">1.1. Features</a></h2>
<p>In addition to the core features of ad blocking and <a href="https://en.wikipedia.org/wiki/Browser_cookie"
target="_top">cookie</a> management, <span class="APPLICATION">Privoxy</span> provides many supplemental
- features, some of them currently under development, that give the end-user more control, more privacy and more
- freedom:</p>
+ features, that give the end-user more control, more privacy and more freedom:</p>
<ul>
<li>
<p>Supports "Connection: keep-alive". Outgoing connections can be kept alive independently from the
<p>Find <tt class="FILENAME">user.action</tt> in the top section, and click on <span class=
"QUOTE">"<span class="GUIBUTTON">Edit</span>"</span>:</p>
<div class="FIGURE">
- <a name="AEN612" id="AEN612"></a>
+ <a name="AEN609" id="AEN609"></a>
<p><b>Figure 1. Actions Files in Use</b></p>
<div class="MEDIAOBJECT">
<p><img src="files-in-use.jpg"></p>
<p>Please note that <span class="APPLICATION">Privoxy</span> can only proxy HTTP and HTTPS traffic. It will not
work with FTP or other protocols.</p>
<div class="FIGURE">
- <a name="AEN666" id="AEN666"></a>
+ <a name="AEN663" id="AEN663"></a>
<p><b>Figure 2. Proxy Configuration Showing Mozilla Firefox HTTP and HTTPS (SSL) Settings</b></p>
<div class="MEDIAOBJECT">
<p><img src="proxy_setup.jpg"></p>
protocols"</span> is <span class="emphasis"><i class="EMPHASIS">UNCHECKED</i></span>. You want only HTTP and HTTPS
(SSL)!</p>
<div class="FIGURE">
- <a name="AEN708" id="AEN708"></a>
+ <a name="AEN705" id="AEN705"></a>
<p><b>Figure 3. Proxy Configuration Showing Internet Explorer HTTP and HTTPS (Secure) Settings</b></p>
<div class="MEDIAOBJECT">
<p><img src="proxy2.jpg"></p>
projects / privoxy.git / commitdiff