e288a7234ab497a5f64b3e313267bb382addae2b
[privoxy.git] / doc / webserver / announce.txt
1                Announcing Privoxy 3.0.26 stable
2 --------------------------------------------------------------------
3
4 Privoxy 3.0.26 stable is a bug-fix release for the previously
5 released 3.0.25 beta which introduced client-specific tags and
6 included a couple of minor improvements.
7 --------------------------------------------------------------------
8 ChangeLog for Privoxy
9 --------------------------------------------------------------------
10 - Bug fixes:
11   - Fixed crashes with "listen-addr :8118" (SF Bug #902).
12     The regression was introduced in 3.0.25 beta and reported
13     by Marvin Renich in Debian bug #834941.
14
15 - General improvements:
16   - Log when privoxy is toggled on or off via cgi interface.
17   - Highlight the "Info: Now toggled " on/off log message
18     in the Windows log viewer.
19   - Highlight the loading actions/filter file log message
20     in the Windows log viewer.
21   - Mention client-specific tags on the toggle page as a
22     potentionally more appropriate alternative.
23
24 - Documentation improvements:
25   - Update download section on the homepage.
26     The downloads are available from the website now.
27   - Add sponsor FAQ.
28   - Remove obsolete reference to mailing lists hosted at SourceForge.
29   - Update the "Before the Release" section of the developer manual.
30
31 - Infrastructure improvements:
32   - Add perl script to generate an RSS feed for the packages
33     Submitted by "Unknown".
34
35 - Build system improvements:
36   - strptime.h: fix a compiler warning about ambiguous else.
37   - configure.in: Check for Docbook goo on the BSDs as well.
38   - GNUMakefile.in: Let the dok-user target remove temporary files.
39
40 *** Version 3.0.25 beta ***
41
42 - Bug fixes:
43   - Always use the current toggle state for new requests.
44     Previously new requests on reused connections inherited
45     the toggle state from the previous request even though
46     the toggle state could have changed.
47     Reported by Robert Klemme.
48   - Fixed two buffer-overflows in the (deprecated) static
49     pcre code. These bugs are not considered security issues
50     as the input is trusted.
51     Found with afl-fuzz and ASAN.
52
53 - General improvements:
54   - Added support for client-specific tags which allow Privoxy
55     admins to pre-define tags that are set for all requests from
56     clients that previously opted in through the CGI interface.
57     They are useful in multi-user setups where admins may
58     want to allow users to disable certain actions and filters
59     for themselves without affecting others.
60     In single-user setups they are useful to allow more fine-grained
61     toggling. For example to disable request blocking while still
62     crunching cookies, or to disable experimental filters only.
63     This is an experimental feature, the syntax and behaviour may
64     change in future versions.
65     Sponsored by Robert Klemme.
66   - Dynamic filters and taggers now support a $listen-address variable
67     which contains the address the request came in on.
68     For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
69     Original patch contributed by pursievro.
70   - Add client-header-tagger 'listen-address'.
71   - Include the listen-address in the log message when logging new requests.
72     Patch contributed by pursievro.
73   - Turn invalid max-client-connections values into fatal errors.
74   - The show-status page now shows whether or not dates before 1970
75     and after 2038 are expected to be handled properly.
76     This is mainly useful for Privoxy-Regression-Test but could
77     also come handy when dealing with time-related support requests.
78   - On Mac OS X the thread id in log messages are more likely to
79     be unique now.
80   - When complaining about missing filters, the filter type is logged
81     as well.
82   - A couple of harmless coverity warnings were silenced
83     (CID #161202, CID #161203, CID #161211).
84
85 - Action file improvements:
86   - Filtering is disabled for Range requests to let download resumption
87     and Windows updates work with the default configuration.
88   - Unblock ".ardmediathek.de/".
89     Reported by ThTomate in #932.
90
91 - Documentation improvements:
92   - Add FAQ entry for crashes caused by memory limits.
93   - Remove obsolete FAQ entry about a bug in PHP 4.2.3.
94   - Mention the new mailing lists were appropriate.
95     As the archives have not been migrated, continue to
96     mention the archives at SF in the contacting section
97     for now.
98   - Note that the templates should be adjusted if Privoxy is
99     running as intercepting proxy without getting all requests.
100   - A bunch of links were converted to https://.
101   - Rephrase onion service paragraph to make it more obvious
102     that Tor is involved and that the whole website (and not
103     just the homepage) is available as onion service.
104   - Streamline the "More information" section on the homepage further
105     by additionally ditching the link to the 'See also' section
106     of the user manual. The section contains mostly links that are
107     directly reachable from the homepage already and the rest is
108     not significant enough to get a link from the homepage.
109   - Change the add-header{} example to set the DNT header
110     and use a complete section to make copy and pasting
111     more convenient.
112     Add a comment to make it obvious that adding the
113     header is not recommended for obvious reasons.
114     Using the DNT header as example was suggested by
115     Leo Wzukw.
116   - Streamline the support-and-service template
117     Instead of linking to the various support trackers
118     (whose URLs hopefully change soon), link to the
119     contact section of the user manual to increase the
120     chances that users actually read it.
121   - Add a FAQ entry for tainted sockets.
122   - More sections in the documentation have stable URLs now.
123   - FAQ: Explain why 'ping config.privoxy.org' is not expected
124     to reach a local Privoxy installation.
125   - Note that donations done through Zwiebelfreunde e.V. currently
126     can't be checked automatically.
127   - Updated section regarding starting Privoxy under OS X.
128   - Use dedicated start instructions for FreeBSD and ElectroBSD.
129   - Removed release instructions for AIX. They haven't been working
130     for years and unsurprisingly nobody seems to care.
131   - Removed obsolete reference to the solaris-dist target.
132   - Updated the release instructions for FreeBSD.
133   - Removed unfinished release instructions for Amiga OS and HP-UX 11.
134   - Added a pointer to the Cygwin Time Machine for getting the last release of
135     Cygwin version 1.5 to use for building Privoxy on Windows.
136   - Various typos have been fixed.
137
138 - Infrastructure improvements:
139   - The website is no longer hosted at SourceForge and
140     can be reached through https now.
141   - The mailing lists at SourceForge have been deprecated,
142     you can subscribe to the new ones at: https://lists.privoxy.org/
143   - Migrating the remaining services from SourceForge is
144     work in progress (TODO list item #53).
145
146 - Build system improvements:
147   - Add configure argument to optimistically redefine FD_SETSIZE
148     with the intent to change the maximum number of client
149     connections Privoxy can handle. Only works with some libcs.
150     Sponsored by Robert Klemme.
151   - Let the tarball-dist target skip files in ".git".
152   - Let the tarball-dist target work in cwds other than current.
153   - Make the 'clean' target faster when run from a git repository.
154   - Include tools in the generic distribution.
155   - Let the gen-dist target work in cwds other than current.
156   - Sort find output that is used for distribution tarballs
157     to get reproducible results.
158   - Don't add '-src' to the name of the tar ball generated by the
159     gen-dist target. The package isn't a source distribution but a
160     binary package.
161     While at it, use a variable for the name to reduce the chances
162     that the various references get out of sync and fix the gen-upload
163     target which was looking in the wrong directory.
164   - Add regression-tests.action to the files that are distributed.
165   - The gen-dist target which was broken since 2002 (r1.92) has been fixed.
166   - Remove genclspec.sh which has been obsolete since 2009.
167   - Remove obsolete reference to Redhat spec file.
168   - Remove the obsolete announce target which has been commented out years ago.
169   - Let rsync skip files if the checksums match.
170
171 - Privoxy-Regression-Test:
172   - Add a "Default level offset" directive which can be used to
173     change the default level by a given value.
174     This directive affects all tests located after it until the end
175     of the file or a another "Default level offset" directive is reached.
176     The purpose of this directive is to make it more convenient to skip
177     similar tests in a given file without having to remove or disable
178     the tests completely.
179   - Let test level 17 depend on FEATURE_64_BIT_TIME_T
180     instead of FEATURE_PTHREAD which has no direct connection
181     to the time_t size.
182   - Fix indentation in perldoc examples.
183   - Don't overlook directives in the first line of the action file.
184   - Bump version to 0.7.
185   - Fix detection of the Privoxy version now that https://
186     is used for the website.
187
188 -----------------------------------------------------------------
189 About Privoxy:
190 -----------------------------------------------------------------
191
192 Privoxy is a non-caching web proxy with advanced filtering capabilities for
193 enhancing privacy, modifying web page data and HTTP headers, controlling
194 access, and removing ads and other obnoxious Internet junk. Privoxy has a
195 flexible configuration and can be customized to suit individual needs and
196 tastes. It has application for both stand-alone systems and multi-user
197 networks.
198
199 Privoxy is Free Software and licensed under the GNU GPLv2.
200
201 Our TODO list is rather long. Helping hands and donations are welcome:
202
203   * https://www.privoxy.org/faq/general.html#PARTICIPATE
204
205   * https://www.privoxy.org/faq/general.html#DONATE
206
207 At present, Privoxy is known to run on Windows 95 and later versions
208 (98, ME, 2000, XP, Vista, Windows 7 etc.), GNU/Linux (RedHat, SuSE,
209 Debian, Fedora, Gentoo, Slackware and others), Mac OS X (10.4 and
210 upwards on PPC and Intel processors), OS/2, Haiku, DragonFly, ElectroBSD,
211 FreeBSD, NetBSD, OpenBSD, Solaris, and various other flavors of Unix.
212
213 In addition to the core features of ad blocking and cookie management,
214 Privoxy provides many supplemental features, that give the end-user
215 more control, more privacy and more freedom:
216
217   *  Supports "Connection: keep-alive". Outgoing connections can be kept
218      alive independently from the client. Currently not available on all
219      platforms.
220
221   *  Supports IPv6, provided the operating system does so too,
222      and the configure script detects it.
223
224   *  Supports tagging which allows to change the behaviour based on client
225      and server headers.
226
227   *  Can be run as an "intercepting" proxy, which obviates the need to
228      configure browsers individually.
229
230   *  Sophisticated actions and filters for manipulating both server and
231      client headers.
232
233   *  Can be chained with other proxies.
234
235   *  Integrated browser based configuration and control utility at
236      http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
237      tracing of rule and filter effects. Remote toggling.
238
239   *  Web page filtering (text replacements, removes banners based on size,
240      invisible "web-bugs" and HTML annoyances, etc.)
241
242   *  Modularized configuration that allows for standard settings and user
243      settings to reside in separate files, so that installing updated actions
244      files won't overwrite individual user settings.
245
246   *  Support for Perl Compatible Regular Expressions in the configuration
247      files, and a more sophisticated and flexible configuration syntax.
248
249   *  GIF de-animation.
250
251   *  Bypass many click-tracking scripts (avoids script redirection).
252
253   *  User-customizable HTML templates for most proxy-generated pages (e.g.
254      "blocked" page).
255
256   *  Auto-detection and re-reading of config file changes.
257     
258   *  Most features are controllable on a per-site or per-location basis.
259
260
261 Home Page: 
262    https://www.privoxy.org/
263
264   - Privoxy Developers <privoxy-devel@lists.privoxy.org>