<title>Actions Files</title>
<meta name="GENERATOR" content=
"Modular DocBook HTML Stylesheet Version 1.79">
- <link rel="HOME" title="Privoxy 3.0.22 User Manual" href="index.html">
+ <link rel="HOME" title="Privoxy 3.0.24 User Manual" href="index.html">
<link rel="PREVIOUS" title="The Main Configuration File" href=
"config.html">
<link rel="NEXT" title="Filter Files" href="filter-file.html">
<table summary="Header navigation table" width="100%" border="0"
cellpadding="0" cellspacing="0">
<tr>
- <th colspan="3" align="center">Privoxy 3.0.22 User Manual</th>
+ <th colspan="3" align="center">Privoxy 3.0.24 User Manual</th>
</tr>
<tr>
in <tt class="FILENAME">default.action</tt> are:</p>
<div class="TABLE">
- <a name="AEN2863" id="AEN2863"></a>
+ <a name="AEN2614" id="AEN2614"></a>
<p><b>Table 1. Default Configurations</b></p>
actions</a>.</p>
<div class="SECT2">
- <h2 class="SECT2"><a name="AEN2962" id="AEN2962">8.1. Finding the Right
+ <h2 class="SECT2"><a name="AEN2713" id="AEN2713">8.1. Finding the Right
Mix</a></h2>
<p>Note that some <a href="actions-file.html#ACTIONS">actions</a>, like
</div>
<div class="SECT2">
- <h2 class="SECT2"><a name="AEN2969" id="AEN2969">8.2. How to
+ <h2 class="SECT2"><a name="AEN2720" id="AEN2720">8.2. How to
Edit</a></h2>
<p>The easiest way to edit the actions files is with a browser by using
</div>
<div class="SECT3">
- <h3 class="SECT3"><a name="AEN3163" id="AEN3163">8.4.2. The Path
+ <h3 class="SECT3"><a name="AEN2914" id="AEN2914">8.4.2. The Path
Pattern</a></h3>
<p><span class="APPLICATION">Privoxy</span> uses <span class=
<dt>Type:</dt>
<dd>
- <p>Parameterized.</p>
+ <p>Multi-value.</p>
</dd>
<dt>Parameter:</dt>
<dt>Type:</dt>
<dd>
- <p>Parameterized.</p>
+ <p>Multi-value.</p>
</dd>
<dt>Parameter:</dt>
</div>
</div>
+ <div class="SECT3">
+ <h4 class="SECT3"><a name="EXTERNAL-FILTER" id=
+ "EXTERNAL-FILTER">8.5.14. external-filter</a></h4>
+
+ <div class="VARIABLELIST">
+ <dl>
+ <dt>Typical use:</dt>
+
+ <dd>
+ <p>Modify content using a programming language of your
+ choice.</p>
+ </dd>
+
+ <dt>Effect:</dt>
+
+ <dd>
+ <p>All instances of text-based type, most notably HTML and
+ JavaScript, to which this action applies, can be filtered
+ on-the-fly through the specified external filter. By default
+ plain text documents are exempted from filtering, because web
+ servers often use the <tt class="LITERAL">text/plain</tt> MIME
+ type for all files whose type they don't know.)</p>
+ </dd>
+
+ <dt>Type:</dt>
+
+ <dd>
+ <p>Multi-value.</p>
+ </dd>
+
+ <dt>Parameter:</dt>
+
+ <dd>
+ <p>The name of an external content filter, as defined in the
+ <a href="filter-file.html">filter file</a>. External filters
+ can be defined in one or more files as defined by the
+ <tt class="LITERAL"><a href=
+ "config.html#FILTERFILE">filterfile</a></tt> option in the
+ <a href="config.html">config file</a>.</p>
+
+ <p>When used in its negative form, and without parameters,
+ <span class="emphasis"><i class="EMPHASIS">all</i></span>
+ filtering with external filters is completely disabled.</p>
+ </dd>
+
+ <dt>Notes:</dt>
+
+ <dd>
+ <p>External filters are scripts or programs that can modify the
+ content in case common <tt class="LITERAL"><a href=
+ "actions-file.html#FILTER">filters</a></tt> aren't powerful
+ enough. With the exception that this action doesn't use
+ pcrs-based filters, the notes in the <tt class=
+ "LITERAL"><a href="actions-file.html#FILTER">filter</a></tt>
+ section apply.</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>Currently external filters are executed with
+ <span class="APPLICATION">Privoxy</span>'s privileges.
+ Only use external filters you understand and trust.</p>
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <p>This feature is experimental, the <tt class=
+ "LITERAL"><a href=
+ "filter-file.html#EXTERNAL-FILTER-SYNTAX">syntax</a></tt> may
+ change in the future.</p>
+ </dd>
+
+ <dt>Example usage:</dt>
+
+ <dd>
+ <table border="0" bgcolor="#E0E0E0" width="90%">
+ <tr>
+ <td>
+ <pre class="SCREEN">
++external-filter{fancy-filter}
+</pre>
+ </td>
+ </tr>
+ </table>
+ </dd>
+ </dl>
+ </div>
+ </div>
+
<div class="SECT3">
<h4 class="SECT3"><a name="FAST-REDIRECTS" id=
- "FAST-REDIRECTS">8.5.14. fast-redirects</a></h4>
+ "FAST-REDIRECTS">8.5.15. fast-redirects</a></h4>
<div class="VARIABLELIST">
<dl>
</div>
<div class="SECT3">
- <h4 class="SECT3"><a name="FILTER" id="FILTER">8.5.15.
+ <h4 class="SECT3"><a name="FILTER" id="FILTER">8.5.16.
filter</a></h4>
<div class="VARIABLELIST">
<dt>Type:</dt>
<dd>
- <p>Parameterized.</p>
+ <p>Multi-value.</p>
</dd>
<dt>Parameter:</dt>
<div class="SECT3">
<h4 class="SECT3"><a name="FORCE-TEXT-MODE" id=
- "FORCE-TEXT-MODE">8.5.16. force-text-mode</a></h4>
+ "FORCE-TEXT-MODE">8.5.17. force-text-mode</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="FORWARD-OVERRIDE" id=
- "FORWARD-OVERRIDE">8.5.17. forward-override</a></h4>
+ "FORWARD-OVERRIDE">8.5.18. forward-override</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Type:</dt>
<dd>
- <p>Multi-value.</p>
+ <p>Parameterized.</p>
</dd>
<dt>Parameter:</dt>
<span class="QUOTE">"forward-socks5"</span> for socks5
connections (with remote DNS resolution).</p>
</li>
+
+ <li>
+ <p><span class="QUOTE">"forward-webserver
+ 127.0.0.1:80"</span> to use the HTTP server listening at
+ 127.0.0.1 port 80 without adjusting the request
+ headers.</p>
+
+ <p>This makes it more convenient to use Privoxy to make
+ existing websites available as onion services as well.</p>
+
+ <p>Many websites serve content with hardcoded URLs and
+ can't be easily adjusted to change the domain based on the
+ one used by the client.</p>
+
+ <p>Putting Privoxy between Tor and the webserver (or an
+ stunnel that forwards to the webserver) allows to rewrite
+ headers and content to make client and server happy at the
+ same time.</p>
+
+ <p>Using Privoxy for webservers that are only reachable
+ through onion addresses and whose location is supposed to
+ be secret is not recommended and should not be necessary
+ anyway.</p>
+ </li>
</ul>
</dd>
<p>If the ports are missing or invalid, default values
will be used. This might change in the future and you
shouldn't rely on it. Otherwise incorrect syntax causes
- Privoxy to exit.</p>
+ Privoxy to exit. Due to design limitations, invalid
+ parameter syntax isn't detected until the action is
+ used the first time.</p>
<p>Use the <a href=
"http://config.privoxy.org/show-url-info" target=
<tr>
<td>
<pre class="SCREEN">
-# Always use direct connections for requests previously tagged as
+# Use an ssh tunnel for requests previously tagged as
# <span class="QUOTE">"User-Agent: fetch libfetch/2.0"</span> and make sure
# resuming downloads continues to work.
+#
# This way you can continue to use Tor for your normal browsing,
# without overloading the Tor network with your FreeBSD ports updates
# or downloads of bigger files like ISOs.
+#
# Note that HTTP headers are easy to fake and therefore their
# values are as (un)trustworthy as your clients and users.
-{+forward-override{forward .} \
+{+forward-override{forward-socks5 10.0.0.2:2222 .} \
-hide-if-modified-since \
-overwrite-last-modified \
}
<div class="SECT3">
<h4 class="SECT3"><a name="HANDLE-AS-EMPTY-DOCUMENT" id=
- "HANDLE-AS-EMPTY-DOCUMENT">8.5.18. handle-as-empty-document</a></h4>
+ "HANDLE-AS-EMPTY-DOCUMENT">8.5.19. handle-as-empty-document</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="HANDLE-AS-IMAGE" id=
- "HANDLE-AS-IMAGE">8.5.19. handle-as-image</a></h4>
+ "HANDLE-AS-IMAGE">8.5.20. handle-as-image</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="HIDE-ACCEPT-LANGUAGE" id=
- "HIDE-ACCEPT-LANGUAGE">8.5.20. hide-accept-language</a></h4>
+ "HIDE-ACCEPT-LANGUAGE">8.5.21. hide-accept-language</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="HIDE-CONTENT-DISPOSITION" id=
- "HIDE-CONTENT-DISPOSITION">8.5.21. hide-content-disposition</a></h4>
+ "HIDE-CONTENT-DISPOSITION">8.5.22. hide-content-disposition</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="HIDE-IF-MODIFIED-SINCE" id=
- "HIDE-IF-MODIFIED-SINCE">8.5.22. hide-if-modified-since</a></h4>
+ "HIDE-IF-MODIFIED-SINCE">8.5.23. hide-if-modified-since</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="HIDE-FROM-HEADER" id=
- "HIDE-FROM-HEADER">8.5.23. hide-from-header</a></h4>
+ "HIDE-FROM-HEADER">8.5.24. hide-from-header</a></h4>
<div class="VARIABLELIST">
<dl>
</div>
<div class="SECT3">
- <h4 class="SECT3"><a name="HIDE-REFERRER" id="HIDE-REFERRER">8.5.24.
+ <h4 class="SECT3"><a name="HIDE-REFERRER" id="HIDE-REFERRER">8.5.25.
hide-referrer</a></h4><a name="HIDE-REFERER" id="HIDE-REFERER"></a>
<div class="VARIABLELIST">
<div class="SECT3">
<h4 class="SECT3"><a name="HIDE-USER-AGENT" id=
- "HIDE-USER-AGENT">8.5.25. hide-user-agent</a></h4>
+ "HIDE-USER-AGENT">8.5.26. hide-user-agent</a></h4>
<div class="VARIABLELIST">
<dl>
</div>
<div class="SECT3">
- <h4 class="SECT3"><a name="LIMIT-CONNECT" id="LIMIT-CONNECT">8.5.26.
+ <h4 class="SECT3"><a name="LIMIT-CONNECT" id="LIMIT-CONNECT">8.5.27.
limit-connect</a></h4>
<div class="VARIABLELIST">
<div class="SECT3">
<h4 class="SECT3"><a name="LIMIT-COOKIE-LIFETIME" id=
- "LIMIT-COOKIE-LIFETIME">8.5.27. limit-cookie-lifetime</a></h4>
+ "LIMIT-COOKIE-LIFETIME">8.5.28. limit-cookie-lifetime</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="PREVENT-COMPRESSION" id=
- "PREVENT-COMPRESSION">8.5.28. prevent-compression</a></h4>
+ "PREVENT-COMPRESSION">8.5.29. prevent-compression</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="OVERWRITE-LAST-MODIFIED" id=
- "OVERWRITE-LAST-MODIFIED">8.5.29. overwrite-last-modified</a></h4>
+ "OVERWRITE-LAST-MODIFIED">8.5.30. overwrite-last-modified</a></h4>
<div class="VARIABLELIST">
<dl>
</div>
<div class="SECT3">
- <h4 class="SECT3"><a name="REDIRECT" id="REDIRECT">8.5.30.
+ <h4 class="SECT3"><a name="REDIRECT" id="REDIRECT">8.5.31.
redirect</a></h4>
<div class="VARIABLELIST">
<p>The syntax for pcrs commands is documented in the <a href=
"filter-file.html">filter file</a> section.</p>
- <p>This action will be ignored if you use it together with
- <tt class="LITERAL"><a href=
- "actions-file.html#BLOCK">block</a></tt>. It can be combined
- with <tt class="LITERAL"><a href=
- "actions-file.html#FAST-REDIRECTS">fast-redirects{check-decoded-url}</a></tt>
+ <p>Requests can't be blocked and redirected at the same time,
+ applying this action together with <tt class="LITERAL"><a href=
+ "actions-file.html#BLOCK">block</a></tt> is a configuration
+ error. Currently the request is blocked and an error message
+ logged, the behavior may change in the future and result in
+ Privoxy rejecting the action file.</p>
+
+ <p>This action can be combined with <tt class=
+ "LITERAL"><a href="actions-file.html#FAST-REDIRECTS">fast-redirects{check-decoded-url}</a></tt>
to redirect to a decoded version of a rewritten URL.</p>
<p>Use this action carefully, make sure not to create
{+redirect{s@^http://[^/]*/results\.aspx\?q=([^&]*).*@http://search.yahoo.com/search?p=$1@}}
search.msn.com//results\.aspx\?q=
+# Redirect http://example.com/&bla=fasel&toChange=foo (and any other value but "bar")
+# to http://example.com/&bla=fasel&toChange=bar
+#
+# The URL pattern makes sure that the following request isn't redirected again.
+{+redirect{s@toChange=[^&]+@toChange=bar@}}
+example.com/.*toChange=(?!bar)
+
+# Add a shortcut to look up illumos bugs
+{+redirect{s@^http://i([0-9]+)/.*@https://www.illumos.org/issues/$1@}}
+# Redirected URL = http://i4974/
+# Redirect Destination = https://www.illumos.org/issues/4974
+i[0-9][0-9][0-9][0-9]*/
+
# Redirect remote requests for this manual
# to the local version delivered by Privoxy
{+redirect{s@^http://www@http://config@}}
<div class="SECT3">
<h4 class="SECT3"><a name="SERVER-HEADER-FILTER" id=
- "SERVER-HEADER-FILTER">8.5.31. server-header-filter</a></h4>
+ "SERVER-HEADER-FILTER">8.5.32. server-header-filter</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Type:</dt>
<dd>
- <p>Parameterized.</p>
+ <p>Multi-value.</p>
</dd>
<dt>Parameter:</dt>
<div class="SECT3">
<h4 class="SECT3"><a name="SERVER-HEADER-TAGGER" id=
- "SERVER-HEADER-TAGGER">8.5.32. server-header-tagger</a></h4>
+ "SERVER-HEADER-TAGGER">8.5.33. server-header-tagger</a></h4>
<div class="VARIABLELIST">
<dl>
<dt>Type:</dt>
<dd>
- <p>Parameterized.</p>
+ <p>Multi-value.</p>
</dd>
<dt>Parameter:</dt>
{+server-header-tagger{content-type}}
/
+# If the response has a tag starting with 'image/' enable an external
+# filter that only applies to images.
+#
+# Note that the filter is not available by default, it's just a
+# <tt class="LITERAL"><a href=
+"filter-file.html#EXTERNAL-FILTER-SYNTAX">silly example</a></tt>.
+{+external-filter{rotate-image} +force-text-mode}
+TAG:^image/
+
</pre>
</td>
</tr>
<div class="SECT3">
<h4 class="SECT3"><a name="SESSION-COOKIES-ONLY" id=
- "SESSION-COOKIES-ONLY">8.5.33. session-cookies-only</a></h4>
+ "SESSION-COOKIES-ONLY">8.5.34. session-cookies-only</a></h4>
<div class="VARIABLELIST">
<dl>
<div class="SECT3">
<h4 class="SECT3"><a name="SET-IMAGE-BLOCKER" id=
- "SET-IMAGE-BLOCKER">8.5.34. set-image-blocker</a></h4>
+ "SET-IMAGE-BLOCKER">8.5.35. set-image-blocker</a></h4>
<div class="VARIABLELIST">
<dl>
</div>
<div class="SECT3">
- <h3 class="SECT3"><a name="AEN4847" id="AEN4847">8.5.35.
+ <h3 class="SECT3"><a name="AEN4653" id="AEN4653">8.5.36.
Summary</a></h3>
<p>Note that many of these actions have the potential to cause a page
together:</p>
<div class="SECT3">
- <h3 class="SECT3"><a name="AEN4911" id="AEN4911">8.7.1.
+ <h3 class="SECT3"><a name="AEN4717" id="AEN4717">8.7.1.
match-all.action</a></h3>
<p>Remember <span class="emphasis"><i class="EMPHASIS">all actions
</div>
<div class="SECT3">
- <h3 class="SECT3"><a name="AEN4933" id="AEN4933">8.7.2.
+ <h3 class="SECT3"><a name="AEN4739" id="AEN4739">8.7.2.
default.action</a></h3>
<p>If you aren't a developer, there's no need for you to edit the
</div>
<div class="SECT3">
- <h3 class="SECT3"><a name="AEN5046" id="AEN5046">8.7.3.
+ <h3 class="SECT3"><a name="AEN4852" id="AEN4852">8.7.3.
user.action</a></h3>
<p>So far we are painting with a broad brush by setting general
projects / privoxy.git / blobdiff