SourceFormat Enforcement

[thirdparty/squid.git] / doc / release-notes / release-5.sgml

<!doctype linuxdoc system>
<article>
<title>Squid 5.0.0 release notes</title>
<author>Squid Developers</author>

<abstract>
This document contains the release notes for version 4 of Squid.
Squid is a WWW Cache application developed by the National Laboratory
for Applied Network Research and members of the Web Caching community.
</abstract>

<toc>

<sect>Notice
<p>The Squid Team are pleased to announce the release of Squid-5.0.0 for testing.

This new release is available for download from <url url="http://www.squid-cache.org/Versions/v5/"> or the
 <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.

<p>While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.

<p>We welcome feedback and bug reports. If you find a bug, please see <url url="http://wiki.squid-cache.org/SquidFaq/BugReporting">
   for how to submit a report with a stack trace.

<sect1>Known issues
<p>Although this release is deemed good enough for use in many setups, please note the existence of 
<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">.

<sect1>Changes since earlier releases of Squid-5
<p>
The Squid-4 change history can be <url url="http://www.squid-cache.org/Versions/v5/changesets/" name="viewed here">.


<sect>Major new features since Squid-4
<p>Squid-5 represents a new feature release above Squid-4.

<p>The most important of these new features are:
<itemize>
	<item>ICAP Trailers
</itemize>

Most user-facing changes are reflected in squid.conf (see below).


<sect1>ICAP Trailers
<p>Details in <url url="https://datatracker.ietf.org/doc/draft-rousskov-icap-trailers/" name="Draft: ICAP Trailers">

<p>The <em>Trailers</em> feature from HTTP is being proposed for addition to ICAP,
   with some modifications.

<p>This implementation complies with version -01 of that draft:
<itemize>
	<item>Announces ICAP Trailer support via the ICAP Allow request header field.
	<item>Parses the ICAP response trailer if and only if the ICAP server signals
		its presence by sending both Trailer header and Allow/trailers in the
		ICAP response.
</itemize>

<p>For now Squid logs and ignores all parsed ICAP header fields.


<sect>Changes to squid.conf since Squid-4
<p>
There have been changes to Squid's configuration file since Squid-4.

This section gives a thorough account of those changes in three categories:

<itemize>
	<item><ref id="newdirectives" name="New directives">
	<item><ref id="modifieddirectives" name="Changes to existing directives">
	<item><ref id="removeddirectives" name="Removed directives">
</itemize>
<p>

<sect1>New directives<label id="newdirectives">
<p>
<descrip>
	<tag>auth_schemes</tag>
	<p>New access control to customize authentication schemes presence
	   and order in Squid generated HTTP 401 (Unauthorized) and 407
	   (Proxy Authentication Required) responses.

</descrip>

<sect1>Changes to existing directives<label id="modifieddirectives">
<p>
<descrip>
	<p>No changes to existing directives in this version.

</descrip>

<sect1>Removed directives<label id="removeddirectives">
<p>
<descrip>
	<p>No removed directives in this version.

</descrip>


<sect>Changes to ./configure options since Squid-4
<p>
There have been some changes to Squid's build configuration since Squid-4.

This section gives an account of those changes in three categories:

<itemize>
	<item><ref id="newoptions" name="New options">
	<item><ref id="modifiedoptions" name="Changes to existing options">
	<item><ref id="removedoptions" name="Removed options">
</itemize>


<sect1>New options<label id="newoptions">
<p>
<descrip>
	<p>No new options in this version.

</descrip>

<sect1>Changes to existing options<label id="modifiedoptions">
<p>
<descrip>
	<p>No changes to existing options in this version.

</descrip>
</p>

<sect1>Removed options<label id="removedoptions">
<p>
<descrip>
	<p>No removed options in this version.

</descrip>


<sect>Regressions since Squid-2.7

<p>Some squid.conf options which were available in Squid-2.7 are not yet available in Squid-5

<p>If you need something to do then porting one of these from Squid-2 is most welcome.

<sect1>Missing squid.conf options available in Squid-2.7
<p>
<descrip>
	<tag>broken_vary_encoding</tag>
	<p>Not yet ported from 2.6

	<tag>cache_peer</tag>
	<p><em>monitorinterval=</em> not yet ported from 2.6
	<p><em>monitorsize=</em> not yet ported from 2.6
	<p><em>monitortimeout=</em> not yet ported from 2.6
	<p><em>monitorurl=</em> not yet ported from 2.6

	<tag>cache_vary</tag>
	<p>Not yet ported from 2.6

	<tag>error_map</tag>
	<p>Not yet ported from 2.6

	<tag>external_refresh_check</tag>
	<p>Not yet ported from 2.7

	<tag>location_rewrite_access</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_children</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_concurrency</tag>
	<p>Not yet ported from 2.6

	<tag>location_rewrite_program</tag>
	<p>Not yet ported from 2.6

	<tag>refresh_pattern</tag>
	<p><em>stale-while-revalidate=</em> not yet ported from 2.7
	<p><em>ignore-stale-while-revalidate=</em> not yet ported from 2.7
	<p><em>negative-ttl=</em> not yet ported from 2.7

	<tag>refresh_stale_hit</tag>
	<p>Not yet ported from 2.7

	<tag>update_headers</tag>
	<p>Not yet ported from 2.7

</descrip>

<sect>Copyright
<p>
Copyright (C) 1996-2017 The Squid Software Foundation and contributors
<p>
Squid software is distributed under GPLv2+ license and includes
contributions from numerous individuals and organizations.
Please see the COPYING and CONTRIBUTORS files for details.

</article>