From: Amos Jeffries Date: Sat, 25 Oct 2008 06:48:50 +0000 (+1300) Subject: Release Notes for 3.1 X-Git-Tag: SQUID_3_2_0_1~1379 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6a171502dcd9bba826257071d8e0c8cd89de20b4;p=thirdparty%2Fsquid.git Release Notes for 3.1 --- diff --git a/doc/release-notes/Makefile b/doc/release-notes/Makefile index 485c9a9641..e4cb1de4bf 100644 --- a/doc/release-notes/Makefile +++ b/doc/release-notes/Makefile @@ -13,10 +13,10 @@ $(DOC).ps: $(DOC).sgml linuxdoc -B txt --filter $< %.html: %.sgml - linuxdoc -B html --split=0 $< + linuxdoc -B html -T 2 --split=0 $< %.man: %.sgml - linuxdoc -B txt -m $(DOC) + linuxdoc -B txt -T 2 -m $(DOC) clean: rm -f *.html diff --git a/doc/release-notes/release-3.1.html b/doc/release-notes/release-3.1.html index 2e3329f19b..ce3bbebf90 100644 --- a/doc/release-notes/release-3.1.html +++ b/doc/release-notes/release-3.1.html @@ -13,7 +13,72 @@ Squid is a WWW Cache application developed by the National Laboratory for Applied Network Research and members of the Web Caching community.
-

1. Notice

+

+

1. Notice

+ + +

+

2. Major new features since Squid-3.0

+ + +

+

3. Windows support

+ + +

+

4. Changes to squid.conf since Squid-3.0

+ + +

+

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

+ + +

+

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.1.0.1 for testing.

This new release is available for download from @@ -24,17 +89,19 @@ While this release is not deemed ready for production use, we believe it is read

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.

-

2. Known issues

+

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.1.

-

3. Changes since earlier releases of Squid-3.1

+

1.2 Changes since earlier releases of Squid-3.1 +

The 3.1 change history can be viewed here.

-

4. Major new features sinceSsquid-3.0

+

2. Major new features since Squid-3.0

Squid 3.1 represents a new feature release above 3.0.

The most important of these new features are:

@@ -52,7 +119,7 @@ While this release is not deemed ready for production use, we believe it is read

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

-

4.1 New Version Numbering System +

2.1 New Version Numbering System

Begining with 3.1 the Squid Developers are trialling a new release numbering system.

@@ -97,7 +164,7 @@ Vastly reducing the number of bugs in all code.

-

4.2 Minimal squid.conf improvements +

2.2 Minimal squid.conf improvements

squid.conf has undergone a facelift.

@@ -117,7 +184,7 @@ contains a fully documented set of options previously cluttering up squid.conf i config options provided on a clean install.

-

4.3 Internet Protocol version 6 (IPv6) +

2.3 Internet Protocol version 6 (IPv6)

Squid 3.1 supports IPv6. @@ -176,7 +243,7 @@ A new one will be needed for IPv6 traffic between the helper and server.

with the RADIUS server. A new helper will be needed for IPv6 RADIUS protocol.

-

4.4 Error Page Localization +

2.4 Error Page Localization

Details in @@ -194,7 +261,7 @@ Updates can be downloaded from Contribution of new languages is encouraged.

-

4.5 Connection Pinning (for NTLM Auth Passthrough) +

2.5 Connection Pinning (for NTLM Auth Passthrough)

Details in @@ -206,7 +273,7 @@ Contribution of new languages is encouraged.

Microsoft NTLM Authentication instead of HTTP standard authentication through a web proxy.

-

4.6 Quality of Service (QoS) Flow support +

2.6 Quality of Service (QoS) Flow support

Details in @@ -245,7 +312,7 @@ on the client connection. Requires a kernel patch.

-

4.7 SSL Bump (for HTTPS Filtering and Adaptation) +

2.7 SSL Bump (for HTTPS Filtering and Adaptation)

Details in @@ -256,35 +323,41 @@ using configurable client- and server-side certificates. While decrypted, the traffic can be inspected using ICAP.

-

4.8 eCAP Adaptation Module support +

2.8 eCAP Adaptation Module support

Details in The Squid wiki

-

5. Windows support

+

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. -

+restarting automatically after 60 seconds.

+ +

3.1 Usage +

-
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:

@@ -292,55 +365,58 @@ 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 +

+

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 "-D -u 3130" -n squidsvc
 

-
-

-

-

-
PSAPI.DLL (Process Status Helper) Considerations
+ +

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.

-
-

-

-

-
Registry DNS lookup
+ +

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.

-
-

-

-

-
Compatibility Notes
+ +

3.4 Compatibility Notes +

+

  • It's recommended to use '/' char in Squid paths instead of '\'
  • @@ -366,11 +442,11 @@ redirect_program c:/winnt/system32/cmd.exe /C c:/squid/libexec/redir.cmd
  • "Start parameters" in the Windows 2000/XP/2003 Service applet cannot be used

-
-

-

-

-
Known Limitations
+ + +

3.5 Known Limitations +

+

  • Squid features not operational:
    @@ -385,11 +461,10 @@ redirect_program c:/winnt/system32/cmd.exe /C c:/squid/libexec/redir.cmd
  • File Descriptors number hard-limited to 2048 when building with MinGW.

-
-

-

-

-
Building Squid on Windows
+ +

3.6 Building Squid on Windows +

+

A reasonably recent release of Cygwin or MinGW is needed.
@@ -435,11 +510,9 @@ Before build Squid with SSL support, some operations are needed (in the followin

-
-

-

-

-
Using cache manager on Windows:
+

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:

    @@ -477,11 +550,9 @@ ScriptAlias /squid/cgi-bin/ "c:/squid/libexec/"

-
-

-

6. Changes to squid.conf since Squid-3.0

+

4. Changes to squid.conf since Squid-3.0

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

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

@@ -498,8 +569,7 @@ ScriptAlias /squid/cgi-bin/ "c:/squid/libexec/" - -

6.1 New tags +

4.1 New tags

@@ -885,7 +955,7 @@ DEFAULT: None bypassed.

-

6.2 Changes to existing tags +

4.2 Changes to existing tags

@@ -899,8 +969,8 @@ DEFAULT: None bypassed.

acl myportname peername
-

New acl type myportname, matching the name of the http(s)_port where the request was accepted. -New acl type peername, matching against a named cache_peer entry where the request will be attempted first. +

New acl type myportname, matching the name of the http(s)_port where the request was accepted.

+

New acl type peername, matching against a named cache_peer entry where the request will be attempted first. NP: peername currently is limited to only match the first peer possible.

         acl aclname myportname 3128 ...         # http(s)_port name
@@ -931,9 +1001,9 @@ It has thus been turned off by default. Making the 'best choice' IP continue in
 Replaced by new refresh_pattern instead.

cache_dir
-

Default changed from 100MB on-disk UFS cache to 256MB in-memory cache. -see cache_mem and maximum_object_size_in_memory for size parameters. -'null' storage type dropped.

+

Default changed to 256MB in-memory cache. +see cache_mem and maximum_object_size_in_memory for size parameters.

+

'null' storage type dropped. In-memory cache is always present. Remove all cache_dir options to prevent on-disk caching.

cache_mem

Default size increased to 256MB.

@@ -969,7 +1039,7 @@ see cache_mem and maximum_object_size_in_memory for size parameters.
error_directory

Now an optional entry in squid.conf. If present it will force all visitors to receive the error pages -contained in the directory it points at. If absent error page localization will be given a chance. +contained in the directory it points at. If absent, error page localization will be given a chance.

         If you wish to create your own versions of the default
         error files to customize them to suit your company COPY
@@ -978,15 +1048,6 @@ contained in the directory it points at. If absent error page localization will
 
         WARNING: This option will disable multi-language support
                  on error pages if used.
-
-        The squid developers are interested in making squid available in
-        a wide variety of languages. If you are making translations for a
-        language that Squid does not currently provide please consider
-        contributing your translation back to the project.
-        http://wiki.squid-cache.org/Translations
-
-        The squid developers working on translations are happy to supply drop-in
-        translated error files in exchange for any new language contributions.
         
 

@@ -1080,21 +1141,19 @@ For now option 'tproxy' remains with old behaviour meaning fully-invisible proxy

Default size limit increased to 512KB.

negative_ttl
-

New default to prevent negative-caching of failure messages unless explicitly -permitted by the message generating web server. -This is an RFC 1616 violation and now requires --enable-http-violations -to even be usable.

+

New default of 0 seconds. To prevent negative-caching of failure messages unless explicitly +permitted by the message generating web server.

+

Changing this is an RFC 2616 violation and now requires --enable-http-violations

refresh_pattern

New set of basic patterns. These should always be listed after any custom ptterns. They ensure RFC compliance with certain protocol and request handling in the absence of accurate Cache-Control: and Expires: information.

-refresh_pattern ^ftp:          1440    20%     10080
-refresh_pattern ^gopher:       1440    0%      1440
-refresh_pattern (cgi-bin|\?)   0       0%      0
-refresh_pattern -i (/cgi-bin/|\?) 0    0%      0
-refresh_pattern .              0       20%     4320
+refresh_pattern ^ftp:             1440   20%    10080
+refresh_pattern ^gopher:          1440    0%     1440
+refresh_pattern -i (/cgi-bin/|\?)    0    0%        0
+refresh_pattern .                    0   20%     4320
         
 

@@ -1147,14 +1206,15 @@ refresh_pattern . 0 20% 4320

-

6.3 Removed tags +

4.3 Removed tags

dns_testnames
-

Obsolete. This feature is no longer relevant to modern networks and causes boot problems.

+

Obsolete. This feature is no longer relevant to modern networks and was causing boot problems. +The -D command line option used previously to suppress these tests is also obsolete.

extension_methods

Obsolete. All possible methods are now accepted and handled properly.

@@ -1169,7 +1229,7 @@ refresh_pattern . 0 20% 4320

-

7. Changes to ./configure Options since Squid-3.0

+

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

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

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

@@ -1185,134 +1245,339 @@ refresh_pattern . 0 20% 4320

- -

7.1 New options +

5.1 New options

-
--enable-ipv6
-

Buildwith IPv6 support. The default is to build with IPv6.

+
--enable-ecap
+

Build with support for loadable content adaptation modules. +Cannot be used with --disable-loadable-modules.

+ +
--enable-follow-x-forwarded-for
+

Support following the X-Forwarded-For HTTP header for determining the +original or indirect client when a request has been forwarded through other +proxies.

+ +
--enable-zph-qos
+

Build with support for ZPH Quality of Service controls

+ +
--disable-auto-locale
+

Disable error page localization for visitors.

+

error_directory option is required if this option is used.

+ +
--disable-ipv6
+

Build without IPv6 support. The default is to auto-detect system capabilities +and build with IPv6 when possible.

+ +
--disable-loadable-modules
+

Build without support for loadable modules.

+ +
--with-dns-cname
+

Enable CNAME recursion within the Internal DNS resolver stub squid uses. +This has no effect on the external DNS helper.

+

Please note this extension is still experimental and may encounter problems. +To see if it is actually needed you can run squid without it for a period and +check the CNAME-Only Requests statistics squid maintains.

+

If it produces ongoing serious problems the external helper may be needed +but please report the bugs anyway.

--with-localhost-ipv6

Build support for squid to map all 127.0.0.1 traffic onto ::1. The default is to build with 127.0.0.1 and ::1 being considered seperate IP. see the IPv6 details above for a better description.

+

WARNING: This is an RFC violation. Use is discouraged.

+ +
--with-logdir=PATH
+

Allow build-time configuration of Default location for squid logs.

--with-ipv6-split-stack

Enable special additions for IPv6 support in Windows XP. see the IPv6 details above for a better description.

-
--with-dns-cname
-

Enable CNAME recursion within the Internal DNS resolver stub squid uses. -This has no effect on the external DNS helper. -Please note this extension is still experimental and may encounter problems. -To see if it is actually needed you can run squid without it for a period and -check the CNAME-Only Requests statistics squid maintains. -If it produces ongoing serious problems the external helper may be needed -but please report the bugs anyway.

- -
--enable-auto-locale
-

Enable error page localization for visitors.

+
--with-po2html=PATH
+

Absolute path to po2html executable. +Default is to automatically detect the binary.

-

7.2 Changes to existing options + +

5.2 Changes to existing options

-
--disable-internl-dns
-

Better support for Linux using the external DNS helper. -The helper will compile and work with dns_nameservers on more variants of Linux than previously.

+
--enable-shared[=PKGS]
+

Default changed to yes.

--enable-linux-netfilter
-

This option now enables support for all three netfilter interception targets. -Adding TPROXY version 4+ support to squid through the TPROXY target. -This options requires a linux kernel 2.6.25 or later for embeded netfilter TPROXY targets. -Older REDIRECT and DNAT targets work as before on HTTP ports marked 'intercept'.

+

This option now enables support for all three netfilter interception targets.

+

Adding TPROXY version 4+ support to squid through the netfilter TPROXY target. +This options requires a linux kernel 2.6.25 or later for embeded netfilter TPROXY targets.

+

Older REDIRECT and DNAT targets work as before on HTTP ports marked 'intercept'.

+ +
--enable-linux-tproxy
+

Deprecated. Remains only to support old TPROXY version 2.2 installations.

+ +
--disable-internl-dns
+

Better support for Linux using the external DNS helper. +The helper will now compile and work with dns_nameservers on more variants of Linux than previously.

-

7.3 Removed options +

5.3 Removed options

-

The following configure options have been removed.

-
--enable-linux-tproxy
-

Replaced by --enable-linux-tproxy2 to make way for differences in TPROXY v2 and v4 support.

--enable-default-err-language

Replaced by error_default_language squid.conf option

+
--enable-err-languages
-

Removed.

+

Removed. All languages used now for error page localization.

+ +
--disable-carp
+

Removed. CARP is required by several peering algoithms. Disabling is not useful.

-

8. Regressions since Squid-2.6

+

6. Options Removed since Squid-2

-

Some squid.conf and ./configure options which were available in Squid 2.6 are no longer -or not yet available in Squid-3.1

+

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

-

Some options are listed as Not Yet Ported -If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.

- -

8.1 Missing and Removed squid.conf Options +

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.

+

tcpkeepalive= replaced by keepalive=

+

transparent option replaced by intercept

+ +
httpd_accel_no_pmtu_disc
+

Replaced by http_port disable-pmtu-discovery= option

+ +
redirector_bypass
+

Replaced by url_rewrite_bypass

+
zph_local
+

Replaced by zph_tos_local

+ +
zph_mode
+

Obsolete.

+ +
zph_option
+

Obsolete.

+ +
zph_parent
+

Replaced by zph_tos_peer and zph_tos_parent

+ +
zph_sibling
+

Replaced by zph_tos_peer

-

8.2 Missing and Removed ./configure Options +

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
-

Support for Solaris /dev/poll

+

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
-

Basic POSIX select() loop without any binary fd_set optimizations.

+

Replaced by automatic detection.

+ +
--enable-snmp
+

Obsolete. Enabled by default.

+ +
--enable-truncate
+

Obsolete.

+ +
--disable-kqueue
+

Obsolete. Disabled by default.

-
--enable-follow-x-forwarded-for
-

Support following the X-Forwarded-For HTTP header for determining the -client IP address

-

9. Regressions since Squid-2.7

+

7. Regressions since Squid-2.7

-

Some squid.conf and ./configure options which were available in Squid 2.7 are no longer -or not yet available in Squid-3.1

+

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

-

Some options are listed as Not Yet Ported -If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.

+

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

-

9.1 Missing and Removed squid.conf Options +

7.1 Missing squid.conf options available in Squid-2.7

-
+
acl
+

urllogin option

+

urlgroup option

+ +
auth_param
+

concurrency option

+ +
authenticate_ip_shortcircuit_access
+ +
authenticate_ip_shortcircuit_ttl
+ +
broken_vary_encoding
+ +
cache_dir
+

min-size option

+

COSS storage type is lacking stability fixes.

+

COSS overwrite-percent= option

+

COSS max-stripe-waste= option

+

COSS membufs= option

+

COSS maxfullbufs= option

+ +
cache_peer
+

monitorinterval=

+

monitorsize=

+

monitortimeout=

+

monitorurl=

+

multicast-siblings

+

idle=

+

http11

+ +
cache_vary
+ +
clientside_tos
+ +
collapsed_forwarding
+ +
error_map
+ +
external_acl_type
+

%ACL

+

%DATA

+ +
external_refresh_check
+
http_access2
+ +
http_port
+

act-as-origin

+

allow-direct

+

http11

+

urlgroup=

+ +
ignore_expect_100
+ +
ignore_ims_on_miss
+ +
incoming_rate
+ +
location_rewrite_access
+ +
location_rewrite_children
+ +
location_rewrite_concurrency
+ +
location_rewrite_program
+ +
logfile_daemon
+ +
logformat
+

%oa

+

%sn

+ +
max_filedescriptors / max_filedesc
+ +
max_stale
+ +
refresh_pattern
+

stale-while-revalidate=

+

ignore-stale-while-revalidate=

+

max-stale=

+

negative-ttl=

+ +
refresh_stale_hit
+ +
server_http11
+ +
storeurl_access
+ +
storeurl_rewrite_children
+ +
storeurl_rewrite_concurrency
+ +
storeurl_rewrite_program
+ +
update_headers
+ +
upgrade_http0.9
+ +
zero_buffers

-

9.2 Missing and Removed ./configure Options +

7.2 Missing ./configure options available in Squid-2.7

-
- +
--without-system-md5

diff --git a/doc/release-notes/release-3.1.sgml b/doc/release-notes/release-3.1.sgml index 1311dc0b6f..560e9361af 100644 --- a/doc/release-notes/release-3.1.sgml +++ b/doc/release-notes/release-3.1.sgml @@ -22,15 +22,15 @@ While this release is not deemed ready for production use, we believe it is read 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 +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.1 +Changes since earlier releases of Squid-3.1

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

Squid 3.1 represents a new feature release above 3.0. @@ -243,76 +243,71 @@ While decrypted, the traffic can be inspected using ICAP. 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 +Usage -Some new command line options were added for the Windows service support: +

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 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. +

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. +

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: +

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 +

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 +

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": +

In the following example the command line of the "squidsvc" Squid service is set to "-D -u 3130": squid -O "-D -u 3130" -n squidsvc - - -PSAPI.DLL (Process Status Helper) Considerations +PSAPI.DLL (Process Status Helper) Considerations -The process status helper functions make it easier for you to obtain information about +

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 +

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, +

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 +

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 Registry DNS lookup + +

On Windows platforms, if no value is specified in the - -Compatibility Notes +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 @@ -330,10 +325,10 @@ 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 - - -Known Limitations + +Known Limitations +

Squid features not operational: @@ -345,11 +340,10 @@ redirect_program c:/winnt/system32/cmd.exe /C c:/squid/libexec/redir.cmd 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. +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: @@ -384,11 +378,8 @@ Before build Squid with SSL support, some operations are needed (in the followin 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. +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): @@ -420,7 +411,6 @@ ScriptAlias /squid/cgi-bin/ "c:/squid/libexec/" - Changes to squid.conf since Squid-3.0 @@ -434,7 +424,6 @@ This section gives a thorough account of those changes in three categories: -

@@ -780,7 +769,7 @@ NOCOMMENT_START acl myportname peername

New acl type myportname, matching the name of the http(s)_port where the request was accepted. - New acl type peername, matching against a named cache_peer entry where the request will be attempted first. +

New acl type peername, matching against a named cache_peer entry where the request will be attempted first. NP: peername currently is limited to only match the first peer possible. acl aclname myportname 3128 ... # http(s)_port name @@ -807,9 +796,9 @@ NOCOMMENT_START Replaced by new refresh_pattern instead. cache_dir -

Default changed from 100MB on-disk UFS cache to 256MB in-memory cache. +

Default changed to 256MB in-memory cache. see cache_mem and maximum_object_size_in_memory for size parameters. - 'null' storage type dropped. +

'null' storage type dropped. In-memory cache is always present. Remove all cache_dir options to prevent on-disk caching. cache_mem

Default size increased to 256MB. @@ -843,7 +832,7 @@ NOCOMMENT_START error_directory

Now an optional entry in squid.conf. If present it will force all visitors to receive the error pages - contained in the directory it points at. If absent error page localization will be given a chance. + contained in the directory it points at. If absent, error page localization will be given a chance. If you wish to create your own versions of the default error files to customize them to suit your company COPY @@ -852,15 +841,6 @@ NOCOMMENT_START WARNING: This option will disable multi-language support on error pages if used. - - The squid developers are interested in making squid available in - a wide variety of languages. If you are making translations for a - language that Squid does not currently provide please consider - contributing your translation back to the project. - http://wiki.squid-cache.org/Translations - - The squid developers working on translations are happy to supply drop-in - translated error files in exchange for any new language contributions. external_acl_type @@ -944,21 +924,19 @@ NOCOMMENT_START

Default size limit increased to 512KB. negative_ttl -

New default to prevent negative-caching of failure messages unless explicitly +

New default of 0 seconds. To prevent negative-caching of failure messages unless explicitly permitted by the message generating web server. - This is an RFC 1616 violation and now requires --enable-http-violations - to even be usable. +

Changing this is an RFC 2616 violation and now requires --enable-http-violations refresh_pattern

New set of basic patterns. These should always be listed after any custom ptterns. They ensure RFC compliance with certain protocol and request handling in the absence of accurate Cache-Control: and Expires: information. -refresh_pattern ^ftp: 1440 20% 10080 -refresh_pattern ^gopher: 1440 0% 1440 -refresh_pattern (cgi-bin|\?) 0 0% 0 -refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 -refresh_pattern . 0 20% 4320 +refresh_pattern ^ftp: 1440 20% 10080 +refresh_pattern ^gopher: 1440 0% 1440 +refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 +refresh_pattern . 0 20% 4320 reply_header_max_size @@ -1011,7 +989,8 @@ refresh_pattern . 0 20% 4320 dns_testnames -

Obsolete. This feature is no longer relevant to modern networks and causes boot problems.

+

Obsolete. This feature is no longer relevant to modern networks and was causing boot problems. + The -D command line option used previously to suppress these tests is also obsolete. extension_methods

Obsolete. All possible methods are now accepted and handled properly.

@@ -1025,7 +1004,7 @@ refresh_pattern . 0 20% 4320 -Changes to ./configure Options since Squid-3.0 +Changes to ./configure options since Squid-3.0

There have been some changes to Squid's build configuration since Squid-3.0. @@ -1036,122 +1015,320 @@ This section gives an account of those changes in three categories: -

New options

- --enable-ipv6 -

Buildwith IPv6 support. The default is to build with IPv6.

+ --enable-ecap +

Build with support for loadable content adaptation modules. + Cannot be used with --disable-loadable-modules. - --with-localhost-ipv6 -

Build support for squid to map all 127.0.0.1 traffic onto ::1. - The default is to build with 127.0.0.1 and ::1 being considered seperate IP. - see the IPv6 details above for a better description. -

+ --enable-follow-x-forwarded-for +

Support following the X-Forwarded-For HTTP header for determining the + original or indirect client when a request has been forwarded through other + proxies. - --with-ipv6-split-stack -

Enable special additions for IPv6 support in Windows XP. - see the IPv6 details above for a better description.

+ --enable-zph-qos +

Build with support for ZPH Quality of Service controls + + --disable-auto-locale +

Disable error page localization for visitors. +

error_directory option is required if this option is used. + + --disable-ipv6 +

Build without IPv6 support. The default is to auto-detect system capabilities + and build with IPv6 when possible. + + --disable-loadable-modules +

Build without support for loadable modules. --with-dns-cname

Enable CNAME recursion within the Internal DNS resolver stub squid uses. This has no effect on the external DNS helper. - Please note this extension is still experimental and may encounter problems. +

Please note this extension is still experimental and may encounter problems. To see if it is actually needed you can run squid without it for a period and check the CNAME-Only Requests statistics squid maintains. - If it produces ongoing serious problems the external helper may be needed +

If it produces ongoing serious problems the external helper may be needed but please report the bugs anyway. -

- --enable-auto-locale -

Enable error page localization for visitors.

+ --with-localhost-ipv6 +

Build support for squid to map all 127.0.0.1 traffic onto ::1. + The default is to build with 127.0.0.1 and ::1 being considered seperate IP. + see the IPv6 details above for a better description. +

WARNING: This is an RFC violation. Use is discouraged. + + --with-logdir=PATH +

Allow build-time configuration of Default location for squid logs. + + --with-ipv6-split-stack +

Enable special additions for IPv6 support in Windows XP. + see the IPv6 details above for a better description. + + --with-po2html=PATH +

Absolute path to po2html executable. + Default is to automatically detect the binary. -

Changes to existing options