Rebuild docs for Privoxy 3.0.27 stable
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3 <html>
4 <head>
5   <title>What's New in this Release</title>
6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
7   <link rel="HOME" title="Privoxy 3.0.27 User Manual" href="index.html">
8   <link rel="PREVIOUS" title="Installation" href="installation.html">
9   <link rel="NEXT" title="Quickstart to Using Privoxy" href="quickstart.html">
10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
12   <link rel="STYLESHEET" type="text/css" href="p_doc.css">
13 </head>
14 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
15   <div class="NAVHEADER">
16     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
17       <tr>
18         <th colspan="3" align="center">Privoxy 3.0.27 User Manual</th>
19       </tr>
20       <tr>
21         <td width="10%" align="left" valign="bottom"><a href="installation.html" accesskey="P">Prev</a></td>
22         <td width="80%" align="center" valign="bottom"></td>
23         <td width="10%" align="right" valign="bottom"><a href="quickstart.html" accesskey="N">Next</a></td>
24       </tr>
25     </table>
26     <hr align="left" width="100%">
27   </div>
28   <div class="SECT1">
29     <h1 class="SECT1"><a name="WHATSNEW" id="WHATSNEW">3. What's New in this Release</a></h1>
30     <p><span class="APPLICATION">Privoxy 3.0.26</span> stable is a bug-fix release for the previously released 3.0.25
31     beta which introduced client-specific tags and included a couple of minor improvements.</p>
32     <ul>
33       <li>
34         <p>Bug fixes:</p>
35         <ul>
36           <li>
37             <p>Fixed crashes with "listen-addr :8118" (SF Bug #902). The regression was introduced in 3.0.25 beta and
38             reported by Marvin Renich in Debian bug #834941.</p>
39           </li>
40         </ul>
41       </li>
42       <li>
43         <p>General improvements:</p>
44         <ul>
45           <li>
46             <p>Log when privoxy is toggled on or off via cgi interface.</p>
47           </li>
48           <li>
49             <p>Highlight the "Info: Now toggled " on/off log message in the Windows log viewer.</p>
50           </li>
51           <li>
52             <p>Highlight the loading actions/filter file log message in the Windows log viewer.</p>
53           </li>
54           <li>
55             <p>Mention client-specific tags on the toggle page as a potentionally more appropriate alternative.</p>
56           </li>
57         </ul>
58       </li>
59       <li>
60         <p>Documentation improvements:</p>
61         <ul>
62           <li>
63             <p>Update download section on the homepage. The downloads are available from the website now.</p>
64           </li>
65           <li>
66             <p>Add sponsor FAQ.</p>
67           </li>
68           <li>
69             <p>Remove obsolete reference to mailing lists hosted at SourceForge.</p>
70           </li>
71           <li>
72             <p>Update the "Before the Release" section of the developer manual.</p>
73           </li>
74         </ul>
75       </li>
76       <li>
77         <p>Infrastructure improvements:</p>
78         <ul>
79           <li>
80             <p>Add perl script to generate an RSS feed for the packages Submitted by "Unknown".</p>
81           </li>
82         </ul>
83       </li>
84       <li>
85         <p>Build system improvements:</p>
86         <ul>
87           <li>
88             <p>strptime.h: fix a compiler warning about ambiguous else.</p>
89           </li>
90           <li>
91             <p>configure.in: Check for Docbook goo on the BSDs as well.</p>
92           </li>
93           <li>
94             <p>GNUMakefile.in: Let the dok-user target remove temporary files.</p>
95           </li>
96         </ul>
97       </li>
98     </ul>
99     <p>Changes between <span class="APPLICATION">Privoxy 3.0.25 beta</span> and the previous release:</p>
100     <ul>
101       <li>
102         <p>Bug fixes:</p>
103         <ul>
104           <li>
105             <p>Always use the current toggle state for new requests. Previously new requests on reused connections
106             inherited the toggle state from the previous request even though the toggle state could have changed.
107             Reported by Robert Klemme.</p>
108           </li>
109           <li>
110             <p>Fixed two buffer-overflows in the (deprecated) static pcre code. These bugs are not considered security
111             issues as the input is trusted. Found with afl-fuzz and ASAN.</p>
112           </li>
113         </ul>
114       </li>
115       <li>
116         <p>General improvements:</p>
117         <ul>
118           <li>
119             <p>Added support for client-specific tags which allow Privoxy admins to pre-define tags that are set for
120             all requests from clients that previously opted in through the CGI interface. They are useful in multi-user
121             setups where admins may want to allow users to disable certain actions and filters for themselves without
122             affecting others. In single-user setups they are useful to allow more fine-grained toggling. For example to
123             disable request blocking while still crunching cookies, or to disable experimental filters only. This is an
124             experimental feature, the syntax and behaviour may change in future versions. Sponsored by Robert
125             Klemme.</p>
126           </li>
127           <li>
128             <p>Dynamic filters and taggers now support a $listen-address variable which contains the address the
129             request came in on. For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS. Original patch
130             contributed by pursievro.</p>
131           </li>
132           <li>
133             <p>Add client-header-tagger 'listen-address'.</p>
134           </li>
135           <li>
136             <p>Include the listen-address in the log message when logging new requests. Patch contributed by
137             pursievro.</p>
138           </li>
139           <li>
140             <p>Turn invalid max-client-connections values into fatal errors.</p>
141           </li>
142           <li>
143             <p>The show-status page now shows whether or not dates before 1970 and after 2038 are expected to be
144             handled properly. This is mainly useful for Privoxy-Regression-Test but could also come handy when dealing
145             with time-related support requests.</p>
146           </li>
147           <li>
148             <p>On Mac OS X the thread id in log messages are more likely to be unique now.</p>
149           </li>
150           <li>
151             <p>When complaining about missing filters, the filter type is logged as well.</p>
152           </li>
153           <li>
154             <p>A couple of harmless coverity warnings were silenced (CID #161202, CID #161203, CID #161211).</p>
155           </li>
156         </ul>
157       </li>
158       <li>
159         <p>Action file improvements:</p>
160         <ul>
161           <li>
162             <p>Filtering is disabled for Range requests to let download resumption and Windows updates work with the
163             default configuration.</p>
164           </li>
165           <li>
166             <p>Unblock ".ardmediathek.de/". Reported by ThTomate in #932.</p>
167           </li>
168         </ul>
169       </li>
170       <li>
171         <p>Documentation improvements:</p>
172         <ul>
173           <li>
174             <p>Add FAQ entry for crashes caused by memory limits.</p>
175           </li>
176           <li>
177             <p>Remove obsolete FAQ entry about a bug in PHP 4.2.3.</p>
178           </li>
179           <li>
180             <p>Mention the new mailing lists were appropriate. As the archives have not been migrated, continue to
181             mention the archives at SF in the contacting section for now.</p>
182           </li>
183           <li>
184             <p>Note that the templates should be adjusted if Privoxy is running as intercepting proxy without getting
185             all requests.</p>
186           </li>
187           <li>
188             <p>A bunch of links were converted to https://.</p>
189           </li>
190           <li>
191             <p>Rephrase onion service paragraph to make it more obvious that Tor is involved and that the whole website
192             (and not just the homepage) is available as onion service.</p>
193           </li>
194           <li>
195             <p>Streamline the "More information" section on the homepage further by additionally ditching the link to
196             the 'See also' section of the user manual. The section contains mostly links that are directly reachable
197             from the homepage already and the rest is not significant enough to get a link from the homepage.</p>
198           </li>
199           <li>
200             <p>Change the add-header{} example to set the DNT header and use a complete section to make copy and
201             pasting more convenient. Add a comment to make it obvious that adding the header is not recommended for
202             obvious reasons. Using the DNT header as example was suggested by Leo Wzukw.</p>
203           </li>
204           <li>
205             <p>Streamline the support-and-service template Instead of linking to the various support trackers (whose
206             URLs hopefully change soon), link to the contact section of the user manual to increase the chances that
207             users actually read it.</p>
208           </li>
209           <li>
210             <p>Add a FAQ entry for tainted sockets.</p>
211           </li>
212           <li>
213             <p>More sections in the documentation have stable URLs now.</p>
214           </li>
215           <li>
216             <p>FAQ: Explain why 'ping config.privoxy.org' is not expected to reach a local Privoxy installation.</p>
217           </li>
218           <li>
219             <p>Note that donations done through Zwiebelfreunde e.V. currently can't be checked automatically.</p>
220           </li>
221           <li>
222             <p>Updated section regarding starting Privoxy under OS X.</p>
223           </li>
224           <li>
225             <p>Use dedicated start instructions for FreeBSD and ElectroBSD.</p>
226           </li>
227           <li>
228             <p>Removed release instructions for AIX. They haven't been working for years and unsurprisingly nobody
229             seems to care.</p>
230           </li>
231           <li>
232             <p>Removed obsolete reference to the solaris-dist target.</p>
233           </li>
234           <li>
235             <p>Updated the release instructions for FreeBSD.</p>
236           </li>
237           <li>
238             <p>Removed unfinished release instructions for Amiga OS and HP-UX 11.</p>
239           </li>
240           <li>
241             <p>Added a pointer to the Cygwin Time Machine for getting the last release of Cygwin version 1.5 to use for
242             building Privoxy on Windows.</p>
243           </li>
244           <li>
245             <p>Various typos have been fixed.</p>
246           </li>
247         </ul>
248       </li>
249       <li>
250         <p>Infrastructure improvements:</p>
251         <ul>
252           <li>
253             <p>The website is no longer hosted at SourceForge and can be reached through https now.</p>
254           </li>
255           <li>
256             <p>The mailing lists at SourceForge have been deprecated, you can subscribe to the new ones at:
257             https://lists.privoxy.org/</p>
258           </li>
259           <li>
260             <p>Migrating the remaining services from SourceForge is work in progress (TODO list item #53).</p>
261           </li>
262         </ul>
263       </li>
264       <li>
265         <p>Build system improvements:</p>
266         <ul>
267           <li>
268             <p>Add configure argument to optimistically redefine FD_SETSIZE with the intent to change the maximum
269             number of client connections Privoxy can handle. Only works with some libcs. Sponsored by Robert
270             Klemme.</p>
271           </li>
272           <li>
273             <p>Let the tarball-dist target skip files in ".git".</p>
274           </li>
275           <li>
276             <p>Let the tarball-dist target work in cwds other than current.</p>
277           </li>
278           <li>
279             <p>Make the 'clean' target faster when run from a git repository.</p>
280           </li>
281           <li>
282             <p>Include tools in the generic distribution.</p>
283           </li>
284           <li>
285             <p>Let the gen-dist target work in cwds other than current.</p>
286           </li>
287           <li>
288             <p>Sort find output that is used for distribution tarballs to get reproducible results.</p>
289           </li>
290           <li>
291             <p>Don't add '-src' to the name of the tar ball generated by the gen-dist target. The package isn't a
292             source distribution but a binary package. While at it, use a variable for the name to reduce the chances
293             that the various references get out of sync and fix the gen-upload target which was looking in the wrong
294             directory.</p>
295           </li>
296           <li>
297             <p>Add regression-tests.action to the files that are distributed.</p>
298           </li>
299           <li>
300             <p>The gen-dist target which was broken since 2002 (r1.92) has been fixed.</p>
301           </li>
302           <li>
303             <p>Remove genclspec.sh which has been obsolete since 2009.</p>
304           </li>
305           <li>
306             <p>Remove obsolete reference to Redhat spec file.</p>
307           </li>
308           <li>
309             <p>Remove the obsolete announce target which has been commented out years ago.</p>
310           </li>
311           <li>
312             <p>Let rsync skip files if the checksums match.</p>
313           </li>
314         </ul>
315       </li>
316       <li>
317         <p>Privoxy-Regression-Test:</p>
318         <ul>
319           <li>
320             <p>Add a "Default level offset" directive which can be used to change the default level by a given value.
321             This directive affects all tests located after it until the end of the file or a another "Default level
322             offset" directive is reached. The purpose of this directive is to make it more convenient to skip similar
323             tests in a given file without having to remove or disable the tests completely.</p>
324           </li>
325           <li>
326             <p>Let test level 17 depend on FEATURE_64_BIT_TIME_T instead of FEATURE_PTHREAD which has no direct
327             connection to the time_t size.</p>
328           </li>
329           <li>
330             <p>Fix indentation in perldoc examples.</p>
331           </li>
332           <li>
333             <p>Don't overlook directives in the first line of the action file.</p>
334           </li>
335           <li>
336             <p>Bump version to 0.7.</p>
337           </li>
338           <li>
339             <p>Fix detection of the Privoxy version now that https:// is used for the website.</p>
340           </li>
341         </ul>
342       </li>
343     </ul>
344     <div class="SECT2">
345       <h2 class="SECT2"><a name="UPGRADERSNOTE" id="UPGRADERSNOTE">3.1. Note to Upgraders</a></h2>
346       <p>A quick list of things to be aware of before upgrading from earlier versions of <span class=
347       "APPLICATION">Privoxy</span>:</p>
348       <ul>
349         <li>
350           <p>The recommended way to upgrade <span class="APPLICATION">Privoxy</span> is to backup your old
351           configuration files, install the new ones, verify that <span class="APPLICATION">Privoxy</span> is working
352           correctly and finally merge back your changes using <span class="APPLICATION">diff</span> and maybe
353           <span class="APPLICATION">patch</span>.</p>
354           <p>There are a number of new features in each <span class="APPLICATION">Privoxy</span> release and most of
355           them have to be explicitly enabled in the configuration files. Old configuration files obviously don't do
356           that and due to syntax changes using old configuration files with a new <span class=
357           "APPLICATION">Privoxy</span> isn't always possible anyway.</p>
358         </li>
359         <li>
360           <p>Note that some installers remove earlier versions completely, including configuration files, therefore you
361           should really save any important configuration files!</p>
362         </li>
363         <li>
364           <p>On the other hand, other installers don't overwrite existing configuration files, thinking you will want
365           to do that yourself.</p>
366         </li>
367         <li>
368           <p>In the default configuration only fatal errors are logged now. You can change that in the <a href=
369           "config.html#DEBUG">debug section</a> of the configuration file. You may also want to enable more verbose
370           logging until you verified that the new <span class="APPLICATION">Privoxy</span> version is working as
371           expected.</p>
372         </li>
373         <li>
374           <p>Three other config file settings are now off by default: <a href=
375           "config.html#ENABLE-REMOTE-TOGGLE">enable-remote-toggle</a>, <a href=
376           "config.html#ENABLE-REMOTE-HTTP-TOGGLE">enable-remote-http-toggle</a>, and <a href=
377           "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a>. If you use or want these, you will need to
378           explicitly enable them, and be aware of the security issues involved.</p>
379         </li>
380       </ul>
381     </div>
382   </div>
383   <div class="NAVFOOTER">
384     <hr align="left" width="100%">
385     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
386       <tr>
387         <td width="33%" align="left" valign="top"><a href="installation.html" accesskey="P">Prev</a></td>
388         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
389         <td width="33%" align="right" valign="top"><a href="quickstart.html" accesskey="N">Next</a></td>
390       </tr>
391       <tr>
392         <td width="33%" align="left" valign="top">Installation</td>
393         <td width="34%" align="center" valign="top">&nbsp;</td>
394         <td width="33%" align="right" valign="top">Quickstart to Using Privoxy</td>
395       </tr>
396     </table>
397   </div>
398 </body>
399 </html>