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