doc/release-notes/release-5.sgml

   1 <!doctype linuxdoc system>
   2 <article>
   3 <title>Squid 5.0.0 release notes</title>
   4 <author>Squid Developers</author>
   5
   6 <abstract>
   7 This document contains the release notes for version 4 of Squid.
   8 Squid is a WWW Cache application developed by the National Laboratory
   9 for Applied Network Research and members of the Web Caching community.
  10 </abstract>
  11
  12 <toc>
  13
  14 <sect>Notice
  15 <p>The Squid Team are pleased to announce the release of Squid-5.0.0 for testing.
  16
  17 This new release is available for download from <url url="http://www.squid-cache.org/Versions/v5/"> or the
  18  <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
  19
  20 <p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.
  21
  22 <p>We welcome feedback and bug reports. If you find a bug, please see <url url="http://wiki.squid-cache.org/SquidFaq/BugReporting">
  23    for how to submit a report with a stack trace.
  24
  25 <sect1>Known issues
  26 <p>Although this release is deemed good enough for use in many setups, please note the existence of
  27 <url url="http://bugs.squid-cache.org/buglist.cgi?query_format=advanced&amp;product=Squid&amp;bug_status=UNCONFIRMED&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;version=5" name="open bugs against Squid-5">.
  28
  29 <sect1>Changes since earlier releases of Squid-5
  30 <p>
  31 The Squid-4 change history can be <url url="http://www.squid-cache.org/Versions/v5/changesets/" name="viewed here">.
  32
  33
  34 <sect>Major new features since Squid-4
  35 <p>Squid-5 represents a new feature release above Squid-4.
  36
  37 <p>The most important of these new features are:
  38 <itemize>
  39         <item>ICAP Trailers
  40 </itemize>
  41
  42 Most user-facing changes are reflected in squid.conf (see below).
  43
  44
  45 <sect1>ICAP Trailers
  46 <p>Details in <url url="https://datatracker.ietf.org/doc/draft-rousskov-icap-trailers/" name="Draft: ICAP Trailers">
  47
  48 <p>The <em>Trailers</em> feature from HTTP is being proposed for addition to ICAP,
  49    with some modifications.
  50
  51 <p>This implementation complies with version -01 of that draft:
  52 <itemize>
  53         <item>Announces ICAP Trailer support via the ICAP Allow request header field.
  54         <item>Parses the ICAP response trailer if and only if the ICAP server signals
  55                 its presence by sending both Trailer header and Allow/trailers in the
  56                 ICAP response.
  57 </itemize>
  58
  59 <p>For now Squid logs and ignores all parsed ICAP header fields.
  60
  61
  62 <sect>Changes to squid.conf since Squid-4
  63 <p>
  64 There have been changes to Squid's configuration file since Squid-4.
  65
  66 This section gives a thorough account of those changes in three categories:
  67
  68 <itemize>
  69         <item><ref id="newdirectives" name="New directives">
  70         <item><ref id="modifieddirectives" name="Changes to existing directives">
  71         <item><ref id="removeddirectives" name="Removed directives">
  72 </itemize>
  73 <p>
  74
  75 <sect1>New directives<label id="newdirectives">
  76 <p>
  77 <descrip>
  78         <tag>auth_schemes</tag>
  79         <p>New access control to customize authentication schemes presence
  80            and order in Squid generated HTTP 401 (Unauthorized) and 407
  81            (Proxy Authentication Required) responses.
  82
  83 </descrip>
  84
  85 <sect1>Changes to existing directives<label id="modifieddirectives">
  86 <p>
  87 <descrip>
  88         <tag>acl</tag>
  89         <p>The <em>CONNECT</em> ACL definition is now built-in.
  90
  91 </descrip>
  92
  93 <sect1>Removed directives<label id="removeddirectives">
  94 <p>
  95 <descrip>
  96         <p>No removed directives in this version.
  97
  98 </descrip>
  99
 100
 101 <sect>Changes to ./configure options since Squid-4
 102 <p>
 103 There have been some changes to Squid's build configuration since Squid-4.
 104
 105 This section gives an account of those changes in three categories:
 106
 107 <itemize>
 108         <item><ref id="newoptions" name="New options">
 109         <item><ref id="modifiedoptions" name="Changes to existing options">
 110         <item><ref id="removedoptions" name="Removed options">
 111 </itemize>
 112
 113
 114 <sect1>New options<label id="newoptions">
 115 <p>
 116 <descrip>
 117         <p>No new options in this version.
 118
 119 </descrip>
 120
 121 <sect1>Changes to existing options<label id="modifiedoptions">
 122 <p>
 123 <descrip>
 124         <tag>--disable-optimizations</tag>
 125         <p>No longer implies <em>--disable-inline</em> option (which is removed).
 126
 127 </descrip>
 128 </p>
 129
 130 <sect1>Removed options<label id="removedoptions">
 131 <p>
 132 <descrip>
 133         <tag>--disable-inline</tag>
 134         <p>Removed.
 135
 136         <tag>-DUSE_CHUNKEDMEMPOOLS=1</tag>
 137         <p>Removed compiler flag. Use run-time environment variable <em>MEMPOOLS=1</em>
 138            to enable chunked memory pools instead.
 139
 140 </descrip>
 141
 142
 143 <sect>Regressions since Squid-2.7
 144
 145 <p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-5
 146
 147 <p>If you need something to do then porting one of these from Squid-2 is most welcome.
 148
 149 <sect1>Missing squid.conf options available in Squid-2.7
 150 <p>
 151 <descrip>
 152         <tag>broken_vary_encoding</tag>
 153         <p>Not yet ported from 2.6
 154
 155         <tag>cache_peer</tag>
 156         <p><em>monitorinterval=</em> not yet ported from 2.6
 157         <p><em>monitorsize=</em> not yet ported from 2.6
 158         <p><em>monitortimeout=</em> not yet ported from 2.6
 159         <p><em>monitorurl=</em> not yet ported from 2.6
 160
 161         <tag>cache_vary</tag>
 162         <p>Not yet ported from 2.6
 163
 164         <tag>error_map</tag>
 165         <p>Not yet ported from 2.6
 166
 167         <tag>external_refresh_check</tag>
 168         <p>Not yet ported from 2.7
 169
 170         <tag>location_rewrite_access</tag>
 171         <p>Not yet ported from 2.6
 172
 173         <tag>location_rewrite_children</tag>
 174         <p>Not yet ported from 2.6
 175
 176         <tag>location_rewrite_concurrency</tag>
 177         <p>Not yet ported from 2.6
 178
 179         <tag>location_rewrite_program</tag>
 180         <p>Not yet ported from 2.6
 181
 182         <tag>refresh_pattern</tag>
 183         <p><em>stale-while-revalidate=</em> not yet ported from 2.7
 184         <p><em>ignore-stale-while-revalidate=</em> not yet ported from 2.7
 185         <p><em>negative-ttl=</em> not yet ported from 2.7
 186
 187         <tag>refresh_stale_hit</tag>
 188         <p>Not yet ported from 2.7
 189
 190         <tag>update_headers</tag>
 191         <p>Not yet ported from 2.7
 192
 193 </descrip>
 194
 195 <sect>Copyright
 196 <p>
 197 Copyright (C) 1996-2018 The Squid Software Foundation and contributors
 198 <p>
 199 Squid software is distributed under GPLv2+ license and includes
 200 contributions from numerous individuals and organizations.
 201 Please see the COPYING and CONTRIBUTORS files for details.
 202
 203 </article>