doc/release-notes/release-7.sgml.in

   1 <!doctype linuxdoc system>
   2 <article>
   3 <title>Squid @SQUID_VERSION@ release notes</title>
   4 <author>Squid Developers</author>
   5
   6 <toc>
   7
   8 <sect>Notice
   9 <p>The Squid Team are pleased to announce the release of Squid-@PACKAGE_VERSION@ for testing.
  10
  11 This new release is available for download from <url url="http://www.squid-cache.org/Versions/v@SQUID_RELEASE@/"> or the
  12  <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
  13
  14 <p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.
  15
  16 <p>We welcome feedback and bug reports. If you find a bug, please see <url url="https://wiki.squid-cache.org/SquidFaq/BugReporting">
  17    for how to submit a report with a stack trace.
  18
  19 <sect1>Known issues
  20 <p>Although this release is deemed good enough for use in many setups, please note the existence of
  21 <url url="https://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=@SQUID_RELEASE@" name="open bugs against Squid-@SQUID_RELEASE@">.
  22
  23 <sect1>Changes since earlier releases of Squid-@SQUID_RELEASE@
  24 <p>
  25 The Squid-@SQUID_RELEASE@ change history can be <url url="https://github.com/squid-cache/squid/commits/v@SQUID_RELEASE@" name="viewed here">.
  26
  27
  28 <sect>Major new features since Squid-@SQUID_RELEASE_OLD@
  29 <p>Squid-@SQUID_RELEASE@ represents a new feature release above Squid-@SQUID_RELEASE_OLD@.
  30
  31 <p>The most important of these new features are:
  32 <itemize>
  33         <item>Cache Manager changes
  34         <item>Removed purge tool
  35         <item>Remove deprecated languages
  36 </itemize>
  37
  38 <p>Most user-facing changes are reflected in squid.conf (see further below).
  39
  40 <sect1>Cache Manager changes<label id="mgr">
  41 <p>For more information about the Cache Manager feature, see <url url="https://wiki.squid-cache.org/Features/CacheManager/Index" name="wiki">.
  42
  43 <p>In order to reduce workload on the Squid development team we have chosen to stop
  44    providing several tools related to Cache Manager which have previously been
  45    bundled with Squid.
  46
  47 <sect2>Removal of the <em>squidclient</em> tool.
  48 <p>Popular command-line tools such as <em>curl</em> or <em>wget</em>
  49    provide equivalent features.
  50
  51 <sect2>Removal of the <em>cachemgr.cgi</em> tool.
  52 <p>Access to the Cache Manager API is available by sending HTTP(S) requests
  53    directly to Squid with the URL-path prefix <em>/squid-internal-mgr/</em>.
  54    A plethora of tools, such as curl, wget, or any web browser, can be used
  55    instead of cachemgr.cgi.
  56
  57 <sect2>Removal of the <em>cache_object:</em> URI scheme.
  58 <p>This custom scheme does not conform to RFC 3986 URI sytax. It has been replaced
  59    with Cache Manager access through HTTP and HTTPS URLs.
  60
  61 <sect2>Removal of <em>non_peers</em> Report
  62 <p>Squid still ignores unexpected ICP responses but no longer remembers the
  63    details that comprised the removed report. The senders of these ICP messages
  64    are still reported to cache.log at debugging level 1 (with an exponential backoff).
  65
  66 <sect1>Removed purge tool
  67 <p>The <em>purge</em> tool (also known as <em>squidpurge</em>, and <em>squid-purge</em>)
  68    was limited to managing UFS/AUFS/DiskD caches and had problems parsing non-trivial squid.conf files.
  69
  70 <p>The cache contents display and search it provided can be obtained with a script
  71    searching the cache manager <em>objects</em> report.
  72
  73 <p>This tool used the custom <em>PURGE</em> HTTP method to remove cache
  74    objects. This can be performed directly on any Squid configured to allow
  75    the method. Like so:
  76 <verb>
  77     acl PURGE method PURGE
  78     http_access allow localhost PURGE
  79 </verb>
  80     Any HTTP client (such as curl) can then be used to evict objects from the cache, for example:
  81 <verb>
  82     curl -XPURGE --proxy http://127.0.0.1:3128 http://url.to/evict/
  83 </verb>
  84    Alternatively the HTCP <em>CLR</em> mechanism can be used.
  85
  86 <sect1>Removed deprecated languages
  87 <p>Old Squid used full language name to refer to error page translations.
  88    These have been deprecated since addition of ISO-639 language codes
  89    and support for HTTP Accept-Language negotiation in Squid-3.x.
  90
  91 <p>As of this release Squid will no longer provide the symlinks
  92    needed for seamless upgrade for squid.conf containing settings such as
  93 <verb>
  94     error_directory English
  95 </verb>
  96    All Squid installations are expected to already have them,
  97    or to convert to the ISO-639 equivalents. Existing symlinks are not
  98    affected.
  99
 100 <p>See <url url="http://www.squid-cache.org/Versions/langpack/"> for the latest
 101    list of official Squid translations.
 102
 103 <p>See <url url="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes"> for
 104    the full ISO-639 list. HTTP uses the 2-letter (set 1) codes.
 105
 106
 107 <sect>Changes to squid.conf since Squid-@SQUID_RELEASE_OLD@
 108 <p>
 109 This section gives an account of those changes in three categories:
 110
 111 <itemize>
 112         <item><ref id="newdirectives" name="New directives">
 113         <item><ref id="modifieddirectives" name="Changes to existing directives">
 114         <item><ref id="removeddirectives" name="Removed directives">
 115 </itemize>
 116 <p>
 117
 118 <sect1>New directives<label id="newdirectives">
 119 <p>
 120 <descrip>
 121         <p>No new directives in this version.
 122
 123 </descrip>
 124
 125 <sect1>Changes to existing directives<label id="modifieddirectives">
 126 <p>
 127 <descrip>
 128         <tag>acl</tag>
 129         <p>Changed <em>src</em> to detect and handle overlapping IP and
 130            IP-range values. Merging where necessary.
 131         <p>Changed <em>dst</em> to detect and handle overlapping IP and
 132            IP-range values. Merging where necessary.
 133         <p>Changed <em>localip</em> to detect and handle overlapping IP and
 134            IP-range values. Merging where necessary.
 135         <p>Changed <em>ssl::server_name</em> to detect and handle overlapping
 136            sub-domain and wildcard domains. Merging or ignoring where
 137            necessary.
 138         <p>Changed <em>srcdomain</em> to detect and handle overlapping
 139            sub-domain and wildcard domains. Merging or ignoring where
 140            necessary.
 141         <p>Changed <em>dstdomain</em> to detect and handle overlapping
 142            sub-domain and wildcard domains. Merging or ignoring where
 143            necessary.
 144         <p>Changed <em>http_status</em> to detect and handle overlapping
 145            status and status-range values. Merging where necessary.
 146
 147         <tag>buffered_logs</tag>
 148         <p>Honor the <em>off</em> setting in 'udp' access_log module.
 149
 150         <tag>cachemgr_passwd</tag>
 151         <p>Removed the <em>non_peers</em> action. See the Cache Manager
 152         <ref id="mgr" name="section"> for details.
 153
 154 </descrip>
 155
 156 <sect1>Removed directives<label id="removeddirectives">
 157 <p>
 158 <descrip>
 159         <tag>mcast_miss_addr</tag>
 160         <p>The corresponding code has not built for many years, indicating that the
 161         feature is unused.
 162
 163         <tag>mcast_miss_ttl</tag>
 164         <p>The corresponding code has not built for many years, indicating that the
 165         feature is unused.
 166
 167         <tag>mcast_miss_port</tag>
 168         <p>The corresponding code has not built for many years, indicating that the
 169         feature is unused.
 170
 171         <tag>mcast_miss_encode_key</tag>
 172         <p>The corresponding code has not built for many years, indicating that the
 173         feature is unused.
 174
 175 </descrip>
 176
 177
 178 <sect>Changes to ./configure options since Squid-@SQUID_RELEASE_OLD@
 179 <p>
 180 This section gives an account of those changes in three categories:
 181
 182 <itemize>
 183         <item><ref id="newoptions" name="New options">
 184         <item><ref id="modifiedoptions" name="Changes to existing options">
 185         <item><ref id="removedoptions" name="Removed options">
 186 </itemize>
 187
 188 <sect1>New options<label id="newoptions">
 189 <p>
 190 <descrip>
 191         <tag>--without-gss</tag>
 192         <p>Renamed from <em>--without-gnugss</em>.
 193
 194         <tag>--without-psapi</tag>
 195         <p>Disable auto-detection of Windows PSAPI library.
 196
 197         <tag>CPPFLAGS=-DINCOMING_FACTOR=</tag>
 198         <p>Control the listening sockets responsiveness with poll(2) and select(2).
 199            The higher the INCOMING_FACTOR, the slower the algorithm will
 200            respond to load spikes/increases/decreases in demand. A value
 201            between 3 and 8 is recommended. Default is 5.
 202
 203 </descrip>
 204
 205 <sect1>Changes to existing options<label id="modifiedoptions">
 206 <p>
 207 <descrip>
 208         <tag>--disable-esi</tag>
 209         <p>The ESI feature is now disabled by default.
 210            Use <em>--enable-esi</em> if needed.
 211
 212 </descrip>
 213 </p>
 214
 215 <sect1>Removed options<label id="removedoptions">
 216 <p>
 217 <descrip>
 218         <tag>--enable-cachemgr-hostname=</tag>
 219         <p>The <em>cachemgr.cgi</em> tool this option relates to has been removed.
 220
 221         <tag>--without-gnugss</tag>
 222         <p>Renamed to <em>--without-gss</em>.
 223
 224         <tag>CPPFLAGS=-DHEADERS_LOG</tag>
 225         <p>The code enabled by this preprocessor macro has not built for many
 226            years, indicating that the feature is unused.
 227
 228         <tag>CPPFLAGS=-DMULTICAST_MISS_STREAM</tag>
 229         <p>The code enabled by this preprocessor macro has not built for many
 230            years, indicating that the feature is unused.
 231
 232 </descrip>
 233
 234 <sect>Copyright
 235 <p>
 236 Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 237 <p>
 238 Squid software is distributed under GPLv2+ license and includes
 239 contributions from numerous individuals and organizations.
 240 Please see the COPYING and CONTRIBUTORS files for details.
 241
 242 </article>