1 <!doctype linuxdoc system>
3 <title>Squid 3.0.STABLE26 release notes</title>
4 <author>Squid Developers</author>
7 This document contains the release notes for version 3.0 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.
16 The Squid Team are pleased to announce the release of Squid-3.0.STABLE26.
18 This new release is available for download from <url url="http://www.squid-cache.org/Versions/v3/3.0/"> or the <url url="http://www.squid-cache.org/Download/http-mirrors.html" name="mirrors">.
20 A large number of the show-stopper bugs have been fixed along with general improvements to the ICAP support and additional Languages.
22 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
23 report with a stack trace.
27 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&short_desc_type=allwordssubstr&short_desc=&target_milestone=3.0&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=bugs.bug_severity&field0-0-0=noop&type0-0-0=noop&value0-0-0=" name="open bugs against Squid-3.0">.
29 <sect>Changes since earlier STABLE releases of Squid-3.0
31 The 3.0 change history can be <url url="http://www.squid-cache.org/Versions/v3/3.0/changesets/" name="viewed here">.
33 <sect>Changes since Squid-2.6
35 <sect1>Major new features
37 Squid 3.0 represents a major rewrite of Squid and has a number of new features.
39 The most important of these are:
42 <item>Code converted to C++, with significant internal restructuring and rewrites.
43 <item>ICAP implementation (RFC 3507 and www.icap-forum.org)
44 <item>Edge Side Includes (ESI) implementation (www.esi.org)
47 Most user-facing changes are reflected in squid.conf (see below).
49 <sect2>Internet Content Adaptation Protocol (ICAP)
51 <p>Squid 3.0 supports ICAP/1.0. To enable ICAP support, use the --enable-icap-client ./configure option and icap_enable squid.conf option. You will also need to configure ICAP services in your squid.conf using icap_service, icap_class, and icap_access options. The following example instructs Squid to talk to two ICAP services, one for request and one for response adaptation:
55 icap_service service_req reqmod_precache 1 icap://127.0.0.1:1344/request
56 icap_service service_resp respmod_precache 0 icap://127.0.0.1:1344/response
57 icap_class class_req service_req
58 icap_class class_resp service_resp
59 icap_access class_req allow all
60 icap_access class_resp allow all
63 <p>Please see squid.conf.default for more details about these and many other icap_* options.
65 <p>Squid supports pre-cache request and pre-cache response vectoring points. The following ICAP features are supported: message preview, 204 responses outside of preview, request satisfaction, X-Transfer-* negotiation, persistent ICAP connections, client IP/credentials sharing, and optional bypass of certain service failures.
67 <p>No more than one ICAP service can be applied to an HTTP message. In other words, chaining or load balancing multiple services is not yet supported.
69 <p>Proxy-directed data trickling and patience pages are not supported yet.
71 <p>Following ICAP requirements, Squid never performs HTTP message adaptation without a successful and fresh ICAP OPTIONS response on file. A REQMOD or RESPMOD request will not be sent to a configured ICAP service until Squid receives a valid OPTIONS response from that service. If a service malfunctions or goes down, Squid may stop talking to the service for a while. Several squid.conf options can be used to tune the failure bypass algorithm (e.g., icap_service_failure_limit and icap_service_revival_delay).
73 <p>The bypass parameter of the icap_service squid.conf option determines whether Squid will try to bypass service failures. Most connectivity and preview-stage failures can be bypassed.
75 <p>More information about ICAP can be found from the ICAP-forum website <url url="http://www.icap-forum.org">
77 <sect2>Edge Side Includes (ESI)
79 <p>ESI is an open specification of an markup language enabling reverse proxies
80 to perform some simple XML based processing, offloading the final page assembly from the webserver and similar tasks.
82 <p>More information about ESI can be found from the ESI website <url url="http://www.esi.org">
84 <sect1>2.6 features not found in Squid-3.0
86 Some of the features found in Squid-2.6 is not available in Squid-3.
87 Some have been dropped as they are not needed. Some have not yet been forward-ported to Squid-3 and may appear in a later release.
90 <item>refresh_stale_hit option. Not yet ported.
91 <item>ability to follow X-Forwarded-For. Not yet ported.
92 <item>Full caching of Vary/ETag using If-None-Match. Only basic Vary cache supported. Not yet ported.
93 <item>Mapping of server error messages. Not yet ported.
94 <item>http_access2 access directive. Not yet ported.
95 <item>Location header rewrites. Not yet ported.
96 <item>wais_relay. Feature dropped as it's equivalent to cache_peer + cache_peer_access.
97 <item>urlgroup. Not yet ported.
98 <item>collapsed forwarding. Not yet ported.
99 <item>stable Windows support. Irregularly maintained.
102 <sect1>Logging changes
104 <p>The TCP_REFRESH_HIT and TCP_REFRESH_MISS log types have been replaced because they were misleading (all refreshes need to query the origin server, so they could never be hits). The following log types have been introduced to replace them:
107 <tag>TCP_REFRESH_UNMODIFIED</tag>
108 <p>The requested object was cached but STALE. The IMS query for the object resulted in "304 not modified".
109 <tag>TCP_REFRESH_MODIFIED</tag>
110 <p>The requested object was cached but STALE. The IMS query returned the new content.
112 <p>See <url url="http://www.squid-cache.org/Doc/FAQ/FAQ-6.html#ss6.7"> for a definition of all log types.
115 <sect>Windows support
116 <P>This Squid version can run on Windows as a system service using the Cygwin emulation environment,
117 or can be compiled in Windows native mode using the MinGW + MSYS development environment. Windows NT 4 SP4 and later are supported.<newline>
118 On Windows 2000 and later the service is configured to use the Windows Service Recovery option
119 restarting automatically after 60 seconds.
124 Some new command line options were added for the Windows service support:<newline>
126 The service installation is made with -i command line switch, it's possible to use -f switch at
127 the same time for specify a different config-file settings for the Squid Service that will be
128 stored on the Windows Registry.
130 A new -n switch specify the Windows Service Name, so multiple Squid instance are allowed.
131 <em/"Squid"/ is the default when the switch is not used.
133 So, to install the service, the syntax is:
135 <verb>squid -i [-f file] [-n name]</verb>
137 Service uninstallation is made with -r command line switch with the appropriate -n switch.
139 The -k switch family must be used with the appropriate -f and -n switches, so the syntax is:
141 <verb>squid -k command [-f file] -n service-name</verb>
142 where <em/service-name/ is the name specified with -n options at service install time.
144 To use the Squid original command line, the new -O switch must be used ONCE, the syntax is:
146 <verb>squid -O cmdline [-n service-name]</verb>
147 If multiple service command line options must be specified, use quote. The -n switch is
148 needed only when a non default service name is in use.
150 Don't use the "Start parameters" in the Windows 2000/XP/2003 Service applet: they are
151 specific to Windows services functionality and Squid is not designed for understand they.
153 In the following example the command line of the "squidsvc" Squid service is set to "-D -u 3130":
155 <verb>squid -O "-D -u 3130" -n squidsvc</verb>
159 <tag>PSAPI.DLL (Process Status Helper) Considerations</tag>
161 The process status helper functions make it easier for you to obtain information about
162 processes and device drivers running on Microsoft? Windows NT?/Windows? 2000. These
163 functions are available in PSAPI.DLL, which is distributed in the Microsoft? Platform
164 Software Development Kit (SDK). The same information is generally available through the
165 performance data in the registry, but it is more difficult to get to it. PSAPI.DLL is
166 freely redistributable.
168 PSAPI.DLL is available only on Windows NT, 2000, XP and 2003. The implementation in Squid is
169 aware of this, and try to use it only on the right platform.
171 On Windows NT PSAPI.DLL can be found as component of many applications, if you need it,
172 you can find it on Windows NT Resource KIT. If you have problem, it can be
173 downloaded from here:
174 <url url="http://download.microsoft.com/download/platformsdk/Redist/4.0.1371.1/NT4/EN-US/psinst.EXE" name="http://download.microsoft.com/download/platformsdk/Redist/4.0.1371.1/NT4/EN-US/psinst.EXE">
176 On Windows 2000 and later it is available installing the Windows Support Tools, located on the
177 Support\Tools folder of the installation Windows CD-ROM.
181 <tag>Registry DNS lookup</tag>
182 On Windows platforms, if no value is specified in the <em/dns_nameservers/ option on
183 squid.conf or in the /etc/resolv.conf file, the list of DNS name servers are
184 taken from the Windows registry, both static and dynamic DHCP configurations
189 <tag>Compatibility Notes</tag>
191 <item>It's recommended to use '/' char in Squid paths instead of '\'
192 <item>Paths with spaces (like 'C:\Programs Files\Squid) are NOT supported by Squid
193 <item>When using ACL like 'acl aclname acltype "file"' the file must be in DOS text
194 format (CR+LF) and the full Windows path must be specified, for example:
196 <verb>acl blocklist url_regex -i "c:/squid/etc/blocked1.txt"</verb>
198 <item>The Windows equivalent of '/dev/null' is 'NUL'
199 <item>Squid doesn't know how to run external helpers based on scripts, like .bat, .cmd,
200 .vbs, .pl, etc. So in squid.conf the interpreter path must be always specified, for example:
202 <verb>redirect_program c:/perl/bin/perl.exe c:/squid/libexec/redir.pl
203 redirect_program c:/winnt/system32/cmd.exe /C c:/squid/libexec/redir.cmd</verb>
204 <item>When Squid runs in command line mode, the launching user account must have administrative privilege on the system
205 <item>"Start parameters" in the Windows 2000/XP/2003 Service applet cannot be used
206 <item>Building with MinGW, when the configure option --enable-truncate is used, Squid cannot run on Windows NT, only Windows 2000 and later are supported
207 <item>On Windows Vista and later, User Account Control (UAC) must be disabled before running service installation
212 <tag>Known Limitations</tag>
214 <item>Squid features not operational:<newline>
216 <item>DISKD: still needs to be ported<newline>
217 <item>WCCP: cannot work because user space GRE support on Windows is missing<newline>
218 <item>Transparent Proxy: missing Windows non commercial interception driver<newline>
220 <item>Some code sections can make blocking calls.
221 <item>Some external helpers may not work.
222 <item>File Descriptors number hard-limited to 2048 when building with MinGW.
227 <tag>Building Squid on Windows</tag>
228 A reasonably recent release of <url url="http://www.cygwin.com/" name="Cygwin"> or <url url="http://www.mingw.org/" name="MinGW"> is needed.<newline>
229 The usage of the Cygwin environment is very similar to other Unix/Linux environments, and -devel version of libraries must be installed.<newline>
230 For the MinGW environment, the packages MSYS, MinGW and msysDTK must be installed. Some additional libraries and tools must be downloaded separately:<newline><newline>
231 OpenSSL: <url url="http://www.slproweb.com/products/Win32OpenSSL.html" name="Shining Light Productions Win32 OpenSSL"><newline>
232 libcrypt: <url url="http://sourceforge.net/projects/mingwrep/" name="MinGW packages repository"><newline>
233 db-1.85: <url url="http://tinycobol.org/download.html" name="TinyCOBOL download area"><newline>
234 uudecode: <url url="http://unxutils.sourceforge.net/" name="Native Win32 ports of some GNU utilities"><newline><newline>
235 When running configure, --disable-wccp and --disable-wccpv2 options should always specified to avoid compile errors.<newline>
237 <item>New configure options:<newline>
239 <item>--enable-win32-service<newline>
241 <item>Updated configure options:<newline>
243 <item>--enable-arp-acl<newline>
244 <item>--enable-default-hostsfile<newline>
246 <item>Unsupported configure options:<newline>
248 <item>--enable-coss-aio-ops: On Windows Posix AIO is not available<newline>
249 <item>--with-large-files: No suitable build environment is available on both Cygwin and MinGW, but --enable-large-cache-files works fine<newline>
251 <item>Recommended configure minimal options for Windows:<newline>
253 <item>--prefix=c:/squid --disable-wccp --disable-wccpv2 --enable-win32-service --enable-default-hostsfile=none
257 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):
259 <item>Copy C:\OpenSSL\lib\MinGW content to C:\MinGW\lib<newline>
260 <item>Copy C:\OpenSSL\include\openssl content to C:\MinGW\include\openssl<newline>
261 <item>Rename C:\MinGW\lib\ssleay32.a to C:\MinGW\lib\libssleay32.a<newline>
267 <tag>Using cache manager on Windows:</tag>
268 On Windows, cache manager (cachemgr.cgi) can be used with Microsoft IIS or Apache.<newline>
269 Some specific configuration could be needed:<newline>
271 <item>IIS 6 (Windows 2003):<newline>
273 <item>On IIS 6.0 all CGI extensions are denied by default for security reason, so the following configuration is needed:<newline>
275 <item>Create a cgi-bin Directory
276 <item>Define the cgi-bin IIS Virtual Directory with read and CGI execute IIS
277 permissions, ASP scripts are not needed. This automatically defines a
278 cgi-bin IIS web application
279 <item>Copy cachemgr.cgi into cgi-bin directory and look to file permissions:
280 the IIS system account and SYSTEM must be able to read and execute the file
281 <item>In IIS manager go to Web Service extensions and add a new Web Service
282 Extension called <em/"Squid Cachemgr"/, add the cachemgr.cgi file and set the
283 extension status to <em/Allowed/
286 <item>Apache:<newline>
288 <item>On Windows, cachemgr.cgi needs to create a temporary file, so Apache must be instructed
289 to pass the TMP and TEMP Windows environment variables to CGI applications:<newline>
291 ScriptAlias /squid/cgi-bin/ "c:/squid/libexec/"
292 <Location /squid/cgi-bin/cachemgr.cgi>
295 Allow from workstation.example.com
304 <sect>Changes to squid.conf since Squid-2.6
305 <p>There have been many changes to Squid's configuration file since Squid-2.6.
307 <p>This section gives a detailed account of those changes in three categories:
310 <item><ref id="newtags" name="New tags">
311 <item><ref id="modifiedtags" name="Changes to existing tags">
312 <item><ref id="removedtags" name="Removed tags">
316 <sect1>New tags<label id="newtags">
319 <tag>minimum_icp_query_timeout (msec)</tag>
323 Normally the ICP query timeout is determined dynamically. But
324 sometimes it can lead to very small timeouts, even lower than
325 the normal latency variance on your link due to traffic.
326 Use this option to put an lower limit on the dynamic timeout
327 value. Do NOT use this option to always use a fixed (instead
328 of a dynamic) timeout value. To set a fixed timeout see the
329 'icp_query_timeout' directive.
332 <tag>background_ping_rate</tag>
336 Controls how often the ICP pings are sent to siblings that
337 have background-ping set.
340 <tag>httpd_accel_surrogate_id</tag>
344 Surrogates (http://www.esi.org/architecture_spec_1.0.html)
345 need an identification token to allow control targeting. Because
346 a farm of surrogates may all perform the same tasks, they may share
347 an identification token.
350 <tag>http_accel_surrogate_remote on|off</tag>
354 Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote.
355 Set this to on to have squid behave as a remote surrogate.
358 <tag>esi_parser libxml2|expat|custom</tag>
362 ESI markup is not strictly XML compatible. The custom ESI parser
363 will give higher performance, but cannot handle non ASCII character
367 <tag>email_err_data on|off</tag>
371 If enabled, information about the occurred error will be
372 included in the mailto links of the ERR pages (if %W is set)
373 so that the email body contains the data.
374 Syntax is <A HREF="mailto:%w%W">%w</A>
377 <tag>refresh_all_ims on|off</tag>
381 When you enable this option, squid will always check
382 the origin server for an update when a client sends an
383 If-Modified-Since request. Many browsers use IMS
384 requests when the user requests a reload, and this
385 ensures those clients receive the latest version.
387 By default (off), squid may return a Not Modified response
388 based on the age of the cached version.
390 <tag>request_header_access</tag>
391 <p>Replaces the header_access directive of Squid-2.6 and earlier, but applies to requests only.
392 <tag>reply_header_access</tag>
393 <p>Replaces the header_access directive of Squid-2.6 and earlier, but applies to replies only.
395 <tag>icap_enable on|off</tag>
399 If you want to enable the ICAP module support, set this to on.
401 <tag>icap_preview_enable on|off</tag>
405 Set this to 'on' if you want to enable the ICAP preview
408 <tag>icap_preview_size</tag>
412 The default size of preview data to be sent to the ICAP server.
413 -1 means no preview. This value might be overwritten on a per server
414 basis by OPTIONS requests.
416 <tag>icap_default_options_ttl (seconds)</tag>
420 The default TTL value for ICAP OPTIONS responses that don't have
421 an Options-TTL header.
423 <tag>icap_persistent_connections on|off</tag>
427 Whether or not Squid should use persistent connections to
430 <tag>icap_send_client_ip on|off</tag>
434 This adds the header "X-Client-IP" to ICAP requests.
436 <tag>icap_send_client_username on|off</tag>
440 This adds the header "X-Client-Username" to ICAP requests
441 if proxy access is authentified.
443 <tag>icap_service</tag>
447 Defines a single ICAP service
449 icap_service servicename vectoring_point bypass service_url
451 vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
452 This specifies at which point of request processing the ICAP
453 service should be plugged in.
455 If set to 1 and the ICAP server cannot be reached, the request will go
456 through without being processed by an ICAP server
457 service_url = icap://servername:port/service
459 Note: reqmod_postcache and respmod_postcache is not yet implemented
462 icap_service service_1 reqmod_precache 0 icap://icap1.mydomain.net:1344/reqmod
463 icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod
465 <tag>icap_class</tag>
469 Defines an ICAP service chain. If there are multiple services per
470 vectoring point, they are processed in the specified order.
472 icap_class classname servicename...
475 icap_class class_1 service_1 service_2
476 icap class class_2 service_1 service_3
478 <tag>icap_access</tag>
482 Redirects a request through an ICAP service class, depending
485 icap_access classname allow|deny [!]aclname...
487 The icap_access statements are processed in the order they appear in
488 this configuration file. If an access list matches, the processing stops.
489 For an "allow" rule, the specified class is used for the request. A "deny"
490 rule simply stops processing without using the class. You can also use the
491 special classname "None".
493 For backward compatibility, it is also possible to use services
497 icap_access class_1 allow all
500 <tag>accept_filter</tag>
502 The name of an accept(2) filter to install on Squid's
503 listen socket(s). This feature is perhaps specific to
504 FreeBSD and requires support in the kernel.
506 The 'httpready' filter delays delivering new connections
507 to Squid until a full HTTP request has been received.
508 See the accf_http(9) man page.
512 <p>New option to import entire secondary configuration files into squid.conf.
514 Squid will follow the files immediately and insert all their content
515 as if it was at that position in squid.conf. As per squid.conf some
516 options are order-specific within the config as a whole.
518 A few layers of include are allowed, but too many are confusing and
519 squid will enforce an include depth of 16 files.
522 include /path/to/file1 /path/to/file2
525 <tag>acl myportname</tag>
526 <p>New acl type myportname, matching the name of the http(s)_port where the request was accepted
528 acl aclname myportname 3128 ... # http(s)_port name
532 <p>Ported from 2.6. Behaviour identical.
534 Minimum umask which should be enforced while the proxy
535 is running, in addition to the umask set at startup.
537 For a traditional octal representation of umasks, start
544 <sect1>Changes to existing tags<label id="modifiedtags">
550 disable-pmtu-discovery=
551 Control Path-MTU discovery usage:
552 off lets OS decide on what to do (default).
553 transparent disable PMTU discovery when transparent support is enabled.
554 always disable always PMTU discovery.
556 In many setups of transparently intercepting proxies Path-MTU
557 discovery can not work on traffic towards the clients. This is
558 the case when the intercepting device does not fully track
559 connections and fails to forward ICMP must fragment messages
560 to the cache server. If you have such setup and experience that
561 certain clients sporadically hang or never complete requests set
562 disable-pmtu-discovery option to 'transparent'.
565 <tag>cache_peer</tag>
574 use 'basetime=n' to specify a base amount to
575 be subtracted from round trip times of parents.
576 It is subtracted before division by weight in calculating
577 which parent to fectch from. If the rtt is less than the
578 base time the rtt is set to a minimal value.
580 use 'background-ping' to only send ICP queries to this
581 neighbor infrequently. This is used to keep the neighbor
582 round trip time updated and is usually used in
583 conjunction with weighted-round-robin.
585 use 'weighted-round-robin' to define a set of parents
586 which should be used in a round-robin fashion with the
587 frequency of each parent being based on the round trip
588 time. Closer parents are used more often.
589 Usually used for background-ping parents.
593 <p>Common options <em>no-store</em>, replaces the older <em>read-only</em> option
595 <tag>auth_param</tag>
596 <p>NCSA authenticator updated in 3.0.STALE26 to alert if passwords with more
597 than 8 characters are used with DES encryption method.
598 <p>Removed Basic auth option
600 blankpasswor, not yet ported to squid-3.
601 auth_param basic concurrency 0
604 <tag>external_acl_type</tag>
605 <p>New format specifications:
609 %PATH Requested URL path
611 <p>New result keywords:
613 tag= Apply a tag to a request (for both ERR and OK results)
614 Only sets a tag, does not alter existing tags.
617 <tag>refresh_pattern</tag>
623 ignore-no-store ignores any ``Cache-control: no-store''
624 headers received from a server. Doing this VIOLATES
625 the HTTP standard. Enabling this feature could make you
626 liable for problems which it causes.
628 refresh-ims causes squid to contact the origin server
629 when a client issues an If-Modified-Since request. This
630 ensures that the client will receive an updated version
635 <p>The 'all' ACL is now provided as a built-in. Warnings will be displayed if any attempt is made to redefine it.
638 acl aclname http_status 200 301 500- 400-403 ... # status code in reply
641 <tag>short_icon_urls</tag>
647 <tag>delay_class</tag>
648 <p>New delay classes:
650 class 4 Everything in a class 3 delay pool, with an
651 additional limit on a per user basis. This
652 only takes effect if the username is established
653 in advance - by forcing authentication in your
656 class 5 Requests are grouped according their tag (see
657 external_acl's tag= reply).
661 <p>New default to require the feature to be enabled in squid.conf:
663 Default: 0 (disabled)
668 <p>New default to require the feature to be enabled in squid.conf:
670 Default: 0 (disabled)
675 <p>New default to require the feature to be enabled in squid.conf:
677 Default: 0 (disabled)
684 rp Request URL-Path excluding hostname
686 et Tag returned by external acl
688 <sH Reply high offset sent
690 <sS Upstream object size
693 <tag>reply_body_max_size</tag>
696 reply_body_max_size size [acl acl...]
698 <p>allow/deny no longer used.
700 <tag>url_rewrite_program</tag>
701 <p>No urlgroup support in either requests or response
703 <tag>auth_param</tag>
704 <p>fake_auth helper for NTLM now accepts the '-S' parameter to strip NTLM domain off the username string.
705 This is useful for class 4 Delay Pools in Squid 3.x
707 <tag>half_closed_clients</tag>
708 <p>New default value of OFF
712 <sect1>Removed tags<label id="removedtags">
715 <tag>header_access</tag>
716 <p>This has been replaced by request_header_access and reply_header_access
718 <tag>httpd_accel_no_pmtu_disc</tag>
719 <p>Replaced by disable-pmtu-discovery http_port option
721 <tag>wais_relay_*</tag>
722 <p>equivalent to cache_peer + cache_peer_access.
727 <sect>Changes to ./configure Options since Squid-2.6
728 <p>There have been some changes to Squid's build configuration since Squid-2.6.
730 <p>This section gives an account of those changes in three categories:
733 <item><ref id="newoptions" name="New options">
734 <item><ref id="modifiedoptions" name="Changes to existing options">
735 <item><ref id="removedoptions" name="Removed options">
740 <sect1>New options<label id="newoptions">
744 <tag>--enable-shared[=PKGS]</tag>
745 <p>Build shared libraries. The default is to build without.</p>
747 <tag>--enable-static[=PKGS]</tag>
748 <p>Build static libraries. The default is on.</p>
750 <tag>--enable-fast-install[=PKGS]</tag>
751 <verb>Optimize for fast installation
754 <tag>--disable-libtool-lock</tag>
755 <p>Avoid locking (might break parallel builds)</p>
757 <tag>--disable-optimizations</tag>
758 <p>Don't compile Squid with compiler optimizations enabled.
759 Optimization is good for production builds, but not
760 good for debugging. During development, use
761 --disable-optimizations to reduce compilation times
762 and allow easier debugging. This option implicitly
763 also enables --disable-inline</p>
765 <tag>--disable-inline</tag>
766 <p>Don't compile trivial methods as inline. Squid
767 is coded with much of the code able to be inlined.
768 Inlining is good for production builds, but not
769 good for development. During development, use
770 --disable-inline to reduce compilation times and
771 allow incremental builds to be quick. For
772 production builds, or load tests, use
773 --enable-inline to have squid make all trivial
774 methods inlinable by the compiler.</p>
776 <tag>--enable-debug-cbdata</tag>
777 <p>Provide some debug information in cbdata</p>
779 <tag>--enable-disk-io=\"list of modules\"</tag>
780 <p>Build support for the list of disk I/O modules.
781 The default is only to build the "Blocking" module.
782 See src/DiskIO for a list of available modules, or
783 Programmers Guide for details on how to build your
784 custom disk module.</p>
786 <tag>--enable-esi</tag>
787 <p>Enable ESI for accelerators. Requires libexpat.
788 Enabling ESI will cause squid to follow the Edge
789 Acceleration Specification (www.esi.org). This
790 causes squid to IGNORE client Cache-Control headers.</p>
791 <p><em>DO NOT</em> use this in a squid configured as a web
792 proxy, ONLY use it in a squid configured for
793 webserver acceleration.</p>
795 <tag>--enable-icap-client</tag>
796 <p>Enable the ICAP client.</p>
798 <tag>--disable-snmp</tag>
799 <p>Disable SNMP monitoring support which is now built by default.</p>
801 <tag>--disable-htcp</tag>
802 <p>Disable HTCP protocol support which is now built by default.</p>
804 <tag>--enable-kqueue</tag>
805 <p>Enable kqueue() support. Marked as experimental in 3.0.</p>
807 <tag>--enable-ipfw-transparent</tag>
808 <p>Enable Transparent Proxy support for systems
809 using FreeBSD IPFW style redirection.</p>
811 <tag>--disable-mempools</tag>
812 <p>Disable memPools. Note that this option now simply sets the
813 default behaviour. Specific classes can override this at runtime, and
814 only lib/MemPool.c needs to be altered to change the squid-wide
815 default for all classes.</p>
817 <tag>--enable-cpu-profiling</tag>
818 <p>This option allows you to see which internal functions
819 in Squid are consuming how much CPU. Compiles in probes
820 that measure time spent in probed functions. Needs
821 source modifications to add new probes. This is meant
822 for developers to assist in performance optimisations
823 of Squid internal functions.</p>
824 <p>If you are not developer and not interested in the stats
825 you shouldn't enable this, as overhead added, although
826 small, is still overhead. See lib/Profiler.c for more.</p>
828 <tag>--with-gnu-ld</tag>
829 <p>Assume the C compiler uses GNU ld. The default is to auto-detect.</p>
831 <tag>--with-pic</tag>
832 <p>Try to use only PIC/non-PIC objects. The default is to use both.</p>
834 <tag>--with-tags[=TAGS]</tag>
835 <p>Include additional configurations. The default is automatic.</p>
837 <tag>--with-default-user=USER</tag>
838 <p>Sets the default System User account for squid permissions.
839 The default is 'nobody' as in other releases of squid.</p>
841 <tag>--with-cppunit-basedir=[PATH]</tag>
842 <p>Path where the cppunit headers and libraries are found
843 for unit testing. The default is automatic detection.</p>
844 <p>NOTE: Since 3.0-PRE6 and 2.6STABLE14 squid no longer comes
845 bundled with CPPUnit. Compile-time validation will be disabled
846 if it is not installed on your system.</p>
851 <sect1>Changes to existing options<label id="modifiedoptions">
855 <tag>--enable-carp</tag>
856 <p>CARP support is now built by default.
857 --disable-carp can be used to build without it.</p>
859 <tag>--enable-htcp</tag>
860 <p>HTCP protocol support is now built by default.
861 Use --disable-htcp to build without it.</p>
863 <tag>--enable-snmp</tag>
864 <p>SNMP monitoring is now build by default.
865 Use --disable-snmp to build without it.</p>
867 <tag>--enable-heap-replacement</tag>
868 <p>Please use --enable-removal-policies directive instead.</p>
870 <tag>--with-maxfd=N</tag>
871 <p>Replaced by --with-filedescriptors=N</p>
872 <p>Override maximum number of filedescriptors. Useful
873 if you build as another user who is not privileged
874 to use the number of filedescriptors you want the
875 resulting binary to support</p>
877 <tag>--enable-select</tag>
879 Automatic checks will enable best I/O loop method available.</p>
881 <tag>--enable-epoll</tag>
883 Automatic checks will enable best I/O loop method available.</p>
885 <tag>--enable-poll</tag>
887 Automatic checks will enable best I/O loop method available.</p>
889 <tag>--enable-kqueue</tag>
890 <p>kqueue support is marked Experimental in Squid 3.0. Known to have some issues under load.</p>
896 <sect1>Removed options<label id="removedoptions">
898 <p>The following configure options have been removed.
901 <tag>--enable-dlmalloc</tag>
902 <p>Most OS:es have good malloc implementations these days, and the version we used to ship with Squid was very very old..</p>
903 <tag>--enable-mempool-debug</tag>
904 <p>Debug option, not needed and therefore removed.</p>
905 <tag>--enable-forward-log</tag>
906 <p>Rarely used extra log file. Removed.</p>
907 <tag>--enable-multicast-miss</tag>
908 <p>Rarely used feature, and multicast ICP acheives almost the same result. Removed.</p>
909 <tag>--enable-coss-aio-ops</tag>
910 <p>Specific to the COSS implementation in Squid-2</p>
911 <tag>--enable-large-cache-files</tag>
912 <p>Now enabled by default. Configure option was redundant and therefore removed.
913 <tag>--enable-truncate</tag>
914 <p>Known to cause race conditions where cache objects may get corrupted, and this for at most a marginal performance improvement. Removed.</p>
919 <sect>Regressions since Squid-2.7
921 <p>Some squid.conf and ./configure options which were available in Squid-2.7 are not yet available in Squid-3.0
923 <p>If you need something to do then porting one of these from Squid-2 to Squid-3 is most welcome.
925 <sect1>Missing squid.conf options available in Squid-2.7
929 <p><em>urllogin</em> option not yet ported from 2.6
930 <p><em>urlgroup</em> option not yet ported from 2.6
932 <tag>acl_uses_indirect_client</tag>
933 <p>Not yet ported from 2.6
935 <tag>auth_param digest</tag>
936 <p><em>concurrency</em> option not yet ported from Squid-2
938 <tag>authenticate_ip_shortcircuit_access</tag>
939 <p>Not yet ported from 2.7
941 <tag>authenticate_ip_shortcircuit_ttl</tag>
942 <p>Not yet ported from 2.7
944 <tag>broken_vary_encoding</tag>
945 <p>Not yet ported from 2.6
948 <p><em>min-size</em> option not yet ported from Squid-2
949 <p><em>COSS</em> storage type is lacking stability fixes from 2.6
950 <p>COSS <em>overwrite-percent=</em> option not yet ported from 2.6
951 <p>COSS <em>max-stripe-waste=</em> option not yet ported from 2.6
952 <p>COSS <em>membufs=</em> option not yet ported from 2.6
953 <p>COSS <em>maxfullbufs=</em> option not yet ported from 2.6
955 <tag>cache_peer</tag>
956 <p><em>multicast-siblings</em> not yet ported from 2.7
957 <p><em>idle=</em> not yet ported from 2.7
958 <p><em>http11</em> not yet ported from 2.7
959 <p><em>connection-auth=</em> not yet ported from 2.6
960 <p><em>monitorinterval=</em> not yet ported from 2.6
961 <p><em>monitorsize=</em> not yet ported from 2.6
962 <p><em>monitortimeout=</em> not yet ported from 2.6
963 <p><em>monitorurl=</em> not yet ported from 2.6
965 <tag>cache_vary</tag>
966 <p>Not yet ported from 2.6
968 <tag>collapsed_forwarding</tag>
969 <p>Not yet ported from 2.6
971 <tag>delay_pool_uses_indirect_client</tag>
972 <p>Not yet ported from 2.6
975 <p>Not yet ported from 2.6
977 <tag>external_acl_type</tag>
978 <p><em>%ACL</em> format tag not yet ported from 2.6
979 <p><em>%DATA</em> format tag not yet ported from 2.6
981 <tag>external_refresh_check</tag>
982 <p>Not yet ported from 2.7
984 <tag>follow_x_forwarded_for</tag>
985 <p>Not yet ported from 2.6
987 <tag>http_access2</tag>
988 <p>Not yet ported from 2.6
991 <p><em>act-as-origin</em> not yet ported from 2.7
992 <p><em>allow-direct</em> not yet ported from 2.7
993 <p><em>http11</em> not yet ported from 2.7
994 <p><em>urlgroup=</em> not yet ported from 2.6
995 <p><em>no-connection-auth</em> not yet ported from 2.6
997 <tag>ignore_expect_100</tag>
998 <p>Not yet ported from 2.7
1000 <tag>ignore_ims_on_miss</tag>
1001 <p>Not yet ported from 2.7
1003 <tag>location_rewrite_access</tag>
1004 <p>Not yet ported from 2.6
1006 <tag>location_rewrite_children</tag>
1007 <p>Not yet ported from 2.6
1009 <tag>location_rewrite_concurrency</tag>
1010 <p>Not yet ported from 2.6
1012 <tag>location_rewrite_program</tag>
1013 <p>Not yet ported from 2.6
1015 <tag>log_uses_indirect_client</tag>
1016 <p>Not yet ported from 2.6
1018 <tag>logfile_daemon</tag>
1019 <p>Not yet ported from 2.7
1021 <tag>logformat</tag>
1022 <p><em>%oa</em> tag not yet ported from 2.7
1023 <p><em>%sn</em> tag not yet ported from 2.7
1025 <tag>max_filedescriptors</tag>
1026 <p>Not yet ported from 2.7
1028 <tag>max_stale</tag>
1029 <p>Not yet ported from 2.7
1031 <tag>refresh_pattern</tag>
1032 <p><em>stale-while-revalidate=</em> not yet ported from 2.7
1033 <p><em>ignore-stale-while-revalidate=</em> not yet ported from 2.7
1034 <p><em>max-stale=</em> not yet ported from 2.7
1035 <p><em>negative-ttl=</em> not yet ported from 2.7
1037 <tag>refresh_stale_hit</tag>
1038 <p>Not yet ported from 2.7
1040 <tag>server_http11</tag>
1041 <p>Not yet ported from 2.7
1043 <tag>storeurl_access</tag>
1044 <p>Not yet ported from 2.7
1046 <tag>storeurl_rewrite_children</tag>
1047 <p>Not yet ported from 2.7
1049 <tag>storeurl_rewrite_concurrency</tag>
1050 <p>Not yet ported from 2.7
1052 <tag>storeurl_rewrite_program</tag>
1053 <p>Not yet ported from 2.7
1055 <tag>update_headers</tag>
1056 <p>Not yet ported from 2.7
1058 <tag>upgrade_http0.9</tag>
1059 <p>Not yet ported from 2.7
1061 <tag>zero_buffers</tag>
1062 <p>Not yet ported from 2.7
1066 <sect1>Missing ./configure options available in Squid-2.7
1069 <tag>--enable-devpoll</tag>
1070 <p>Support for Solaris /dev/poll</p>
1072 <tag>--enable-select-simple</tag>
1073 <p>Basic POSIX select() loop without any binary fd_set optimizations.</p>
1075 <tag>--enable-follow-x-forwarded-for</tag>
1076 <p>Support following the X-Forwarded-For HTTP header for determining the
1077 client IP address</p>
1079 <tag>--without-system-md5</tag>
1085 Copyright (C) 1996-2015 The Squid Software Foundation and contributors
1087 Squid software is distributed under GPLv2+ license and includes
1088 contributions from numerous individuals and organizations.
1089 Please see the COPYING and CONTRIBUTORS files for details.