From: Amos Jeffries Date: Sat, 15 Aug 2009 09:42:30 +0000 (+1200) Subject: Initial release notes for 3.2 X-Git-Tag: SQUID_3_2_0_1~791 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=745114d191b9a312f79a19bae625f2342a640c82;p=thirdparty%2Fsquid.git Initial release notes for 3.2 --- diff --git a/doc/release-notes/Makefile b/doc/release-notes/Makefile index 332f7e160c..bed971f995 100644 --- a/doc/release-notes/Makefile +++ b/doc/release-notes/Makefile @@ -1,6 +1,6 @@ -all: release-3.1.html +all: release-3.2.html -DOC= release-3.1 +DOC= release-3.2 $(DOC).ps: $(DOC).sgml linuxdoc -B latex -o ps $(DOC) diff --git a/doc/release-notes/release-3.2.html b/doc/release-notes/release-3.2.html new file mode 100644 index 0000000000..004593c5a5 --- /dev/null +++ b/doc/release-notes/release-3.2.html @@ -0,0 +1,733 @@ + + + + + Squid 3.2.0.0 release notes + + +

Squid 3.2.0.0 release notes

+ +

Squid Developers

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

+

1. Notice

+ + +

+

2. Major new features since Squid-3.1

+ + +

+

3. Windows support

+ + +

+

4. Changes to squid.conf since Squid-3.1

+ + +

+

5. Changes to ./configure options since Squid-3.1

+ + +

+

6. Options Removed since Squid-2

+ + +

+

7. Regressions since Squid-2.7

+ + + +
+

1. Notice

+ +

The Squid Team are pleased to announce the release of Squid-3.2.0.0 for testing.

+

This new release is available for download from +http://www.squid-cache.org/Versions/v3/3.2/ or the +mirrors.

+

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

+

We welcome feedback and bug reports. If you find a bug, please see +http://wiki.squid-cache.org/SquidFaq/TroubleShooting#head-7067fc0034ce967e67911becaabb8c95a34d576d for how to submit a report with a stack trace.

+ +

1.1 Known issues +

+ +

Although this release is deemed good enough for use in many setups, please note the existence of +open bugs against Squid-3.2.

+ +

1.2 Changes since earlier releases of Squid-3.2 +

+ +

The 3.2 change history can be +viewed here.

+ +

2. Major new features since Squid-3.1

+ +

Squid 3.2 represents a new feature release above 3.1.

+

The most important of these new features are:

+

+

+

+

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

+ +

2.1 Multi-Lingual manuals +

+ +

The man(8) and man(1) pages bundled with Squid are now provided online for all +versions and beginning with 3.2 they are available in languages other than english.

+ +

Details in +The Squid wiki

+ +

3.1 began the Internationalization of Squid with the public facing error pages. +This move begins the Localization of the internal administrator facing manuals.

+ +

2.2 Solaris 10 pthreads Support (Experimental) +

+ +

Automatic detection and use of the pthreads library available from Solaris 10

+ + +

3. Windows support

+ +

This Squid version can run on Windows as a system service using the Cygwin emulation environment, +or can be compiled in Windows native mode using the MinGW + MSYS development environment. Windows NT 4 SP4 and later are supported.
+On Windows 2000 and later the service is configured to use the Windows Service Recovery option +restarting automatically after 60 seconds.

+ +

3.1 Usage +

+ +

Some new command line options were added for the Windows service support:

+ +

The service installation is made with -i command line switch, it's possible to use -f switch at +the same time for specify a different config-file settings for the Squid Service that will be +stored on the Windows Registry.

+ +

A new -n switch specify the Windows Service Name, so multiple Squid instance are allowed. +"Squid" is the default when the switch is not used.

+ +

So, to install the service, the syntax is:

+

+

+squid -i [-f file] [-n name]
+
+

+ +

Service uninstallation is made with -r command line switch with the appropriate -n switch.

+ +

The -k switch family must be used with the appropriate -f and -n switches, so the syntax is:

+

+

+squid -k command [-f file] -n service-name
+
+ +where service-name is the name specified with -n options at service install time.

+ +

To use the Squid original command line, the new -O switch must be used ONCE, the syntax is:

+

+

+squid -O cmdline [-n service-name]
+
+

+

If multiple service command line options must be specified, use quote. The -n switch is +needed only when a non default service name is in use.

+ +

Don't use the "Start parameters" in the Windows 2000/XP/2003 Service applet: they are +specific to Windows services functionality and Squid is not designed for understand they.

+ +

In the following example the command line of the "squidsvc" Squid service is set to "-D -u 3130":

+

+

+squid -O "-u 3130" -n squidsvc
+
+

+ +

3.2 PSAPI.DLL (Process Status Helper) Considerations +

+ +

The process status helper functions make it easier for you to obtain information about +processes and device drivers running on Microsoft® Windows NT®/Windows® 2000. These +functions are available in PSAPI.DLL, which is distributed in the Microsoft® Platform +Software Development Kit (SDK). The same information is generally available through the +performance data in the registry, but it is more difficult to get to it. PSAPI.DLL is +freely redistributable.

+ +

PSAPI.DLL is available only on Windows NT, 2000, XP and 2003. The implementation in Squid is +aware of this, and try to use it only on the right platform.

+ +

On Windows NT PSAPI.DLL can be found as component of many applications, if you need it, +you can find it on Windows NT Resource KIT. If you have problem, it can be +downloaded from here: +http://download.microsoft.com/download/platformsdk/Redist/4.0.1371.1/NT4/EN-US/psinst.EXE

+ +

On Windows 2000 and later it is available installing the Windows Support Tools, located on the +Support\Tools folder of the installation Windows CD-ROM.

+ +

3.3 Registry DNS lookup +

+ +

On Windows platforms, if no value is specified in the dns_nameservers option on +squid.conf or in the /etc/resolv.conf file, the list of DNS name servers are +taken from the Windows registry, both static and dynamic DHCP configurations +are supported.

+ +

3.4 Compatibility Notes +

+ +

+

+

+ + +

3.5 Known Limitations +

+ +

+

+

+ +

3.6 Building Squid on Windows +

+ +

A reasonably recent release of +Cygwin or +MinGW is needed.
+The usage of the Cygwin environment is very similar to other Unix/Linux environments, and -devel version of libraries must be installed.
+For the MinGW environment, the packages MSYS, MinGW and msysDTK must be installed. Some additional libraries and tools must be downloaded separately:

+OpenSSL: +Shining Light Productions Win32 OpenSSL
+libcrypt: +MinGW packages repository
+db-1.85: +TinyCOBOL download area
+When running configure, --disable-wccp and --disable-wccpv2 options should always specified to avoid compile errors.
+

+
+Before build Squid with SSL support, some operations are needed (in the following example OpenSSL is installed in C:\OpenSSL and MinGW in C:\MinGW): + +

+ +

3.7 Using cache manager on Windows: +

+ +

On Windows, cache manager (cachemgr.cgi) can be used with Microsoft IIS or Apache.
+Some specific configuration could be needed:
+

+

+ + +

4. Changes to squid.conf since Squid-3.1

+ +

There have been changes to Squid's configuration file since Squid-3.1.

+

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

+

+

+

+ + + +

4.1 New tags +

+ +

+

+
memory_cache_mode
+

Controls which objects to keep in the memory cache (cache_mem) +

+        'always'  Keep most recently fetched objects in memory (default)
+        
+        'disk'    Only disk cache hits are kept in memory, which means
+                  an object must first be cached on disk and then hit
+                  a second time before cached in memory.
+        
+        network   Only objects fetched from network is kept in memory
+        
+
+

+ + +
+

+ +

4.2 Changes to existing tags +

+ +

+

+
windows_ipaddrchangemonitor
+

Now only available to be set in Windows builds.

+ +
+

+ + +

4.3 Removed tags +

+ +

+

+ +
???alphabetical list???
+

??? +

+        relevant quote directly from cf.data.pre
+        
+
+

+ +
+

+ + +

5. Changes to ./configure options since Squid-3.1

+ +

There have been some changes to Squid's build configuration since Squid-3.1.

+

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

+

+

+

+ + +

5.1 New options +

+ +

+

+ +
???alphabetical list within group ordered: enable, disable, with, without) ???
+

???explain??

+ +
+

+ +

5.2 Changes to existing options +

+ +

+

+
???alphabetical list within group ordered: enable, disable, with, without) ???
+

???explain??

+
+

+

5.3 Removed options +

+ +

+

+
???alphabetical list within group ordered: enable, disable, with, without) ???
+

???explain??

+ +
+

+ + +

6. Options Removed since Squid-2

+ +

Some squid.conf and ./configure options which were available in Squid-2.6 and Squid-2.7 are made obsolete in Squid-3.2.

+ +

6.1 Removed squid.conf options since Squid-2.7 +

+ +

+

+
auth_param
+

blankpassword option for basic scheme removed.

+ +
external_acl_type
+

Format tag %{Header} replaced by %>{Header}

+

Format tag %{Header:member} replaced by %>{Header:member}

+ +
header_access
+

Replaced by request_header_access and reply_header_access

+ +
http_port
+

no-connection-auth replaced by connection-auth=[on|off]. Default is ON.

+

transparent option replaced by intercept

+ +
httpd_accel_no_pmtu_disc
+

Replaced by http_port disable-pmtu-discovery= option

+ +
incoming_rate
+

Obsolete.

+ +
redirector_bypass
+

Replaced by url_rewrite_bypass

+ +
zph_local
+

Replaced by qos_flows local-hit=

+ +
zph_mode
+

Obsolete.

+ +
zph_option
+

Obsolete.

+ +
zph_parent
+

Replaced by qos_flows parent-hit=

+ +
zph_sibling
+

Replaced by qos_flows sibling-hit=

+ +
+

+ +

6.2 Removed squid.conf options since Squid-2.6 +

+ +

+

+
cache_dir
+

read-only option replaced by no-store.

+ +
+

+ +

6.3 Removed ./configure options since Squid-2.7 +

+ +

+

+
--enable-coss-aio-ops
+

Obsolete.

+ +
--enable-devpoll
+

Replaced by automatic detection.

+ +
--enable-dlmalloc=LIB
+

Obsolete.

+ +
--enable-epoll
+

Replaced by automatic detection.

+ +
--enable-forward-log
+

Obsolete.

+ +
--enable-heap-replacement
+

Obsolete.

+ +
--enable-htcp
+

Obsolete. Enabled by default.

+ +
--enable-large-cache-files
+

Obsolete.

+ +
--enable-mempool-debug
+

Obsolete.

+ +
--enable-multicast-miss
+

Obsolete.

+ +
--enable-poll
+

Replaced by automatic detection.

+ +
--enable-select
+

Replaced by automatic detection.

+ +
--enable-select-simple
+

Replaced by automatic detection.

+ +
--enable-snmp
+

Obsolete. Enabled by default.

+ +
--enable-truncate
+

Obsolete.

+ +
--disable-kqueue
+

Obsolete. Disabled by default.

+ +
+

+ + +

7. Regressions since Squid-2.7

+ +

Some squid.conf and ./configure options which were available in Squid-2.7 are not yet available in Squid-3.2

+ +

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

+ +

7.1 Missing squid.conf options available in Squid-2.7 +

+ +

+

+
acl
+

urllogin option not yet ported from 2.6

+

urlgroup option not yet ported from 2.6

+ +
auth_param digest
+

concurrency option not yet ported from Squid-2

+ +
authenticate_ip_shortcircuit_access
+

Not yet ported from 2.7

+ +
authenticate_ip_shortcircuit_ttl
+

Not yet ported from 2.7

+ +
broken_vary_encoding
+

Not yet ported from 2.6

+ +
cache_dir
+

min-size option not yet ported from Squid-2

+

COSS storage type is lacking stability fixes from 2.6

+

COSS overwrite-percent= option not yet ported from 2.6

+

COSS max-stripe-waste= option not yet ported from 2.6

+

COSS membufs= option not yet ported from 2.6

+

COSS maxfullbufs= option not yet ported from 2.6

+ +
cache_peer
+

multicast-siblings not yet ported from 2.7

+

idle= not yet ported from 2.7

+

http11 not yet ported from 2.7

+

monitorinterval= not yet ported from 2.6

+

monitorsize= not yet ported from 2.6

+

monitortimeout= not yet ported from 2.6

+

monitorurl= not yet ported from 2.6

+ +
cache_vary
+

Not yet ported from 2.6

+ +
collapsed_forwarding
+

Not yet ported from 2.6

+ +
error_map
+

Not yet ported from 2.6

+ +
external_acl_type
+

%ACL format tag not yet ported from 2.6

+

%DATA format tag not yet ported from 2.6

+ +
external_refresh_check
+

Not yet ported from 2.7

+ +
http_access2
+

Not yet ported from 2.6

+ +
http_port
+

act-as-origin not yet ported from 2.7

+

http11 not yet ported from 2.7

+

urlgroup= not yet ported from 2.6

+ +
ignore_expect_100
+

Not yet ported from 2.7

+ +
ignore_ims_on_miss
+

Not yet ported from 2.7

+ +
location_rewrite_access
+

Not yet ported from 2.6

+ +
location_rewrite_children
+

Not yet ported from 2.6

+ +
location_rewrite_concurrency
+

Not yet ported from 2.6

+ +
location_rewrite_program
+

Not yet ported from 2.6

+ +
logfile_daemon
+

Not yet ported from 2.7

+ +
logformat
+

%oa tag not yet ported from 2.7

+

%sn tag not yet ported from 2.7

+ +
max_filedescriptors
+

Not yet ported from 2.7

+ +
max_stale
+

Not yet ported from 2.7

+ +
refresh_pattern
+

stale-while-revalidate= not yet ported from 2.7

+

ignore-stale-while-revalidate= not yet ported from 2.7

+

max-stale= not yet ported from 2.7

+

negative-ttl= not yet ported from 2.7

+ +
refresh_stale_hit
+

Not yet ported from 2.7

+ +
server_http11
+

Not yet ported from 2.7

+ +
storeurl_access
+

Not yet ported from 2.7

+ +
storeurl_rewrite_children
+

Not yet ported from 2.7

+ +
storeurl_rewrite_concurrency
+

Not yet ported from 2.7

+ +
storeurl_rewrite_program
+

Not yet ported from 2.7

+ +
update_headers
+

Not yet ported from 2.7

+ +
upgrade_http0.9
+

Not yet ported from 2.7

+ +
zero_buffers
+

Not yet ported from 2.7

+ +
+

+ +

7.2 Missing ./configure options available in Squid-2.7 +

+ +

+

+
--without-system-md5
+ +
+

+ + + diff --git a/doc/release-notes/release-3.2.sgml b/doc/release-notes/release-3.2.sgml new file mode 100644 index 0000000000..df4d4992a7 --- /dev/null +++ b/doc/release-notes/release-3.2.sgml @@ -0,0 +1,577 @@ + +
+Squid 3.2.0.0 release notes +Squid Developers + + +This document contains the release notes for version 3.2 of Squid. +Squid is a WWW Cache application developed by the National Laboratory +for Applied Network Research and members of the Web Caching community. + + + + +Notice +

+The Squid Team are pleased to announce the release of Squid-3.2.0.0 for testing. + +This new release is available for download from or the . + +While this release is not deemed ready for production use, we believe it is ready for wider testing by the community. + +We welcome feedback and bug reports. If you find a bug, please see for how to submit a report with a stack trace. + +Known issues +

+Although this release is deemed good enough for use in many setups, please note the existence of . + +Changes since earlier releases of Squid-3.2 +

+The 3.2 change history can be . + +Major new features since Squid-3.1 +

+Squid 3.2 represents a new feature release above 3.1. + +The most important of these new features are: + + + Multi-Lingual manuals + Solaris 10 pthreads Support (Experimental) + + +Most user-facing changes are reflected in squid.conf (see below). + +Multi-Lingual manuals + +

The man(8) and man(1) pages bundled with Squid are now provided online for all + versions and beginning with 3.2 they are available in languages other than english. + +

Details in + +

3.1 began the Internationalization of Squid with the public facing error pages. + This move begins the Localization of the internal administrator facing manuals. + +Solaris 10 pthreads Support (Experimental) + +

Automatic detection and use of the pthreads library available from Solaris 10 + + +Windows support +

This Squid version can run on Windows as a system service using the Cygwin emulation environment, +or can be compiled in Windows native mode using the MinGW + MSYS development environment. Windows NT 4 SP4 and later are supported. +On Windows 2000 and later the service is configured to use the Windows Service Recovery option +restarting automatically after 60 seconds. + +Usage + +

Some new command line options were added for the Windows service support: + +

The service installation is made with -i command line switch, it's possible to use -f switch at +the same time for specify a different config-file settings for the Squid Service that will be +stored on the Windows Registry. + +

A new -n switch specify the Windows Service Name, so multiple Squid instance are allowed. +So, to install the service, the syntax is: + +squid -i [-f file] [-n name] + +

Service uninstallation is made with -r command line switch with the appropriate -n switch. + +

The -k switch family must be used with the appropriate -f and -n switches, so the syntax is: + +squid -k command [-f file] -n service-name +where To use the Squid original command line, the new -O switch must be used ONCE, the syntax is: + +squid -O cmdline [-n service-name] +

If multiple service command line options must be specified, use quote. The -n switch is +needed only when a non default service name is in use. + +

Don't use the "Start parameters" in the Windows 2000/XP/2003 Service applet: they are +specific to Windows services functionality and Squid is not designed for understand they. + +

In the following example the command line of the "squidsvc" Squid service is set to "-D -u 3130": + +squid -O "-u 3130" -n squidsvc + +PSAPI.DLL (Process Status Helper) Considerations + +

The process status helper functions make it easier for you to obtain information about +processes and device drivers running on Microsoft® Windows NT®/Windows® 2000. These +functions are available in PSAPI.DLL, which is distributed in the Microsoft® Platform +Software Development Kit (SDK). The same information is generally available through the +performance data in the registry, but it is more difficult to get to it. PSAPI.DLL is +freely redistributable. + +

PSAPI.DLL is available only on Windows NT, 2000, XP and 2003. The implementation in Squid is +aware of this, and try to use it only on the right platform. + +

On Windows NT PSAPI.DLL can be found as component of many applications, if you need it, +you can find it on Windows NT Resource KIT. If you have problem, it can be +downloaded from here: + + +

On Windows 2000 and later it is available installing the Windows Support Tools, located on the +Support\Tools folder of the installation Windows CD-ROM. + +Registry DNS lookup + +

On Windows platforms, if no value is specified in the Compatibility Notes +

+ +It's recommended to use '/' char in Squid paths instead of '\' +Paths with spaces (like 'C:\Programs Files\Squid) are NOT supported by Squid +When using ACL like 'acl aclname acltype "file"' the file must be in DOS text +format (CR+LF) and the full Windows path must be specified, for example: + +acl blocklist url_regex -i "c:/squid/etc/blocked1.txt" + +The Windows equivalent of '/dev/null' is 'NUL' +Squid doesn't know how to run external helpers based on scripts, like .bat, .cmd, +.vbs, .pl, etc. So in squid.conf the interpreter path must be always specified, for example: + +redirect_program c:/perl/bin/perl.exe c:/squid/libexec/redir.pl +redirect_program c:/winnt/system32/cmd.exe /C c:/squid/libexec/redir.cmd +When Squid runs in command line mode, the launching user account must have administrative privilege on the system +"Start parameters" in the Windows 2000/XP/2003 Service applet cannot be used +On Windows Vista and later, User Account Control (UAC) must be disabled before running service installation + + + +Known Limitations +

+ +Squid features not operational: + +DISKD: still needs to be ported +WCCP: cannot work because user space GRE support on Windows is missing +Transparent Proxy: missing Windows non commercial interception driver + +Some code sections can make blocking calls. +Some external helpers may not work. +File Descriptors number hard-limited to 2048 when building with MinGW. + + +Building Squid on Windows + +

A reasonably recent release of or is needed. +The usage of the Cygwin environment is very similar to other Unix/Linux environments, and -devel version of libraries must be installed. +For the MinGW environment, the packages MSYS, MinGW and msysDTK must be installed. Some additional libraries and tools must be downloaded separately: +OpenSSL: +libcrypt: +db-1.85: +When running configure, --disable-wccp and --disable-wccpv2 options should always specified to avoid compile errors. + +New configure options: + +--enable-win32-service + +Updated configure options: + +--enable-arp-acl +--enable-default-hostsfile + +Unsupported configure options: + +--enable-coss-aio-ops: On Windows Posix AIO is not available +--with-large-files: No suitable build environment is available on both Cygwin and MinGW, but --enable-large-files works fine + +Recommended configure minimal options for Windows: + +--prefix=c:/squid --disable-wccp --disable-wccpv2 --enable-win32-service --enable-default-hostsfile=none + + + +Before build Squid with SSL support, some operations are needed (in the following example OpenSSL is installed in C:\OpenSSL and MinGW in C:\MinGW): + +Copy C:\OpenSSL\lib\MinGW content to C:\MinGW\lib +Copy C:\OpenSSL\include\openssl content to C:\MinGW\include\openssl +Rename C:\MinGW\lib\ssleay32.a to C:\MinGW\lib\libssleay32.a + + +Using cache manager on Windows: +

On Windows, cache manager (cachemgr.cgi) can be used with Microsoft IIS or Apache. +Some specific configuration could be needed: + +IIS 6 (Windows 2003): + +On IIS 6.0 all CGI extensions are denied by default for security reason, so the following configuration is needed: + +Create a cgi-bin Directory +Define the cgi-bin IIS Virtual Directory with read and CGI execute IIS +permissions, ASP scripts are not needed. This automatically defines a +cgi-bin IIS web application +Copy cachemgr.cgi into cgi-bin directory and look to file permissions: +the IIS system account and SYSTEM must be able to read and execute the file +In IIS manager go to Web Service extensions and add a new Web Service +Extension called + +Apache: + +On Windows, cachemgr.cgi needs to create a temporary file, so Apache must be instructed + to pass the TMP and TEMP Windows environment variables to CGI applications: + +ScriptAlias /squid/cgi-bin/ "c:/squid/libexec/" +<Location /squid/cgi-bin/cachemgr.cgi> + PassEnv TMP TEMP + Order allow,deny + Allow from workstation.example.com +</Location> + + + + + +Changes to squid.conf since Squid-3.1 +

+There have been changes to Squid's configuration file since Squid-3.1. + +This section gives a thorough account of those changes in three categories: + + + + + + +

+ + +New tags

+ + memory_cache_mode +

Controls which objects to keep in the memory cache (cache_mem) + + 'always' Keep most recently fetched objects in memory (default) + + 'disk' Only disk cache hits are kept in memory, which means + an object must first be cached on disk and then hit + a second time before cached in memory. + + network Only objects fetched from network is kept in memory + + + + + +Changes to existing tags

+ + windows_ipaddrchangemonitor +

Now only available to be set in Windows builds. + + + + +Removed tags

+ + + ???alphabetical list??? +

??? + + relevant quote directly from cf.data.pre + + + + + +Changes to ./configure options since Squid-3.1 +

+There have been some changes to Squid's build configuration since Squid-3.1. + +This section gives an account of those changes in three categories: + + + + + + + + +New options

+ + + ???alphabetical list within group ordered: enable, disable, with, without) ??? +

???explain?? + + + +Changes to existing options

+ + ???alphabetical list within group ordered: enable, disable, with, without) ??? +

???explain?? + +

+ +Removed options