File: RELEASENOTES.html

package info (click to toggle)
squid3 3.0.PRE5-5%2Betch2
  • links: PTS
  • area: main
  • in suites: etch
  • size: 21,188 kB
  • ctags: 20,388
  • sloc: cpp: 119,851; ansic: 30,259; sh: 10,465; makefile: 3,289; perl: 1,267; awk: 84; xml: 58
file content (1187 lines) | stat: -rw-r--r-- 38,890 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
 <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
 <TITLE>Squid 3.0.PRE5 release notes</TITLE>
</HEAD>
<BODY>
<H1>Squid 3.0.PRE5 release notes</H1>

<H2>Squid Developers</H2>$Id: release-3.0.html,v 1.5 2006/11/06 05:14:08 adrian Exp $
<HR>
<EM>This document contains the release notes for version 3.0 of Squid.
Squid is a WWW Cache application developed by the National Laboratory
for Applied Network Research and members of the Web Caching community.</EM>
<HR>
<H2><A NAME="s1">1. Notice</A></H2>

<P>The Squid Team are pleased to announce the release of Squid-3.0.PRE5 for pre-release testing.</P>
<P>This new release is available for download from 
<A HREF="http://www.squid-cache.org/Versions/v3/3.0/">http://www.squid-cache.org/Versions/v3/3.0/</A> or the 
<A HREF="http://www.squid-cache.org/Mirrors/http-mirrors.html">mirrors</A>.</P>
<P>A large number of the show-stopper bugs have been fixed along with general improvements to the ICAP support.
While this release is not deemed ready for production use, we believe it is ready for wider testing by the community.</P>
<P>We welcome feedback and bug reports. If you find a bug, please see 
<A HREF="http://www.squid-cache.org/Doc/FAQ/FAQ-11.html#ss11.19">http://www.squid-cache.org/Doc/FAQ/FAQ-11.html#ss11.19</A> for how to submit a report with a stack trace.</P>

<H2><A NAME="s2">2. Known issues</A></H2>

<P>Although this release is deemed good enough for testing in many setups, please note the existence of 
<A HREF="http://www.squid-cache.org/bugs/buglist.cgi?query_format=advanced&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;target_milestone=3.0&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;bug_file_loc_type=allwordssubstr&amp;bug_file_loc=&amp;status_whiteboard_type=allwordssubstr&amp;status_whiteboard=&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;emailtype1=substring&amp;email1=&amp;emailtype2=substring&amp;email2=&amp;bugidtype=include&amp;bug_id=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;cmdtype=doit&amp;order=bugs.bug_severity&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=">open bugs against Squid-3.0</A>.</P>
<P>In particular, ESI may still be too buggy for meaningful testing at this stage.</P>

<H2><A NAME="s3">3. Changes since Squid-3.0-PRE4</A></H2>

<P>The change history can be 
<A HREF="http://www.squid-cache.org/Versions/v3/3.0/changesets/">viewed here</A>.</P>

<H2><A NAME="s4">4. Changes since Squid-2.5.STABLE14</A></H2>

<H2><A NAME="ss4.1">4.1 Major new features</A>
</H2>

<P>Squid 3.0 represents a major rewrite of Squid 2.5 and has a large number of new features.</P>
<P>The most important of these are:</P>
<P>
<UL>
<LI>Edge Side Include implementation (www.esi.org)</LI>
<LI>ICAP implementation (www.i-cap.org)</LI>
<LI>Better support for reverse proxy setups. The httpd_accel_* directives are now gone, replaced by http(s)_port options and cache_peer based request forwarding</LI>
<LI>Better support for SSL</LI>
<LI>Better support for external ACLs</LI>
<LI>Finer control over cacheability (refresh_pattern)</LI>
<LI>Custom log formats and the ability to log different requests to different log files</LI>
</UL>
</P>
<P>Most user-facing changes are reflected in squid.conf (see below).</P>

<H2><A NAME="ss4.2">4.2 Logging changes</A>
</H2>

<H3>access.log</H3>

<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:</P>
<P>
<DL>
<DT><B>TCP_REFRESH_UNMODIFIED</B><DD><P>The requested object was cached but STALE. The IMS query for the object resulted in "304 not modified".</P>
<DT><B>TCP_REFRESH_MODIFIED</B><DD><P>The requested object was cached but STALE. The IMS query returned the new content.
</P>
</DL>
</P>
<P>See 
<A HREF="http://www.squid-cache.org/Doc/FAQ/FAQ-6.html#ss6.7">http://www.squid-cache.org/Doc/FAQ/FAQ-6.html#ss6.7</A> for a definition of all log types.</P>




<H2><A NAME="ss4.3">4.3 Changes to squid.conf</A>
</H2>

<P>There have been many changes to Squid's configuration file since Squid-2.5.</P>
<P>This section gives a thorough account of those changes in three categories:</P>
<P>
<UL>
<LI>
<A HREF="#newtags">New tags</A></LI>
<LI>
<A HREF="#modifiedtags">Changes to existing tags</A></LI>
<LI>
<A HREF="#removedtags">Removed tags</A></LI>
</UL>
</P>





<H3><A NAME="newtags"></A> New tags</H3>

<P>
<DL>
<DT><B>ssl_engine</B><DD><P>
<PRE>
Default: none

The openssl engine to use. You will need to set this if you
would like to use hardware SSL acceleration for example.
        
</PRE>
</P>
<DT><B>sslproxy_client_certificate</B><DD><P>
<PRE>
Default: none

Client SSL Certificate to use when proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_client_key</B><DD><P>
<PRE>
Default: none

Client SSL Key to use when proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_version</B><DD><P>
<PRE>
Default: 1

SSL version level to use when proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_options</B><DD><P>
<PRE>
Default: none

SSL engine options to use when proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_cipher</B><DD><P>
<PRE>
Default: none

SSL cipher list to use when proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_cafile</B><DD><P>
<PRE>
Default: none

file containing CA certificates to use when verifying server
certificates while proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_capath</B><DD><P>
<PRE>
Default: none

directory containing CA certificates to use when verifying
server certificates while proxying https:// URLs
        
</PRE>
</P>
<DT><B>sslproxy_flags</B><DD><P>
<PRE>
Default: none

Various flags modifying the use of SSL while proxying https:// URLs:
    DONT_VERIFY_PEER    Accept certificates even if they fail to
verify.
    NO_DEFAULT_CA       Don't use the default CA list built in
to OpenSSL.
        
</PRE>
</P>
<DT><B>sslpassword_program</B><DD><P>
<PRE>
Default: none

Specify a program used for entering SSL key passphrases
when using encrypted SSL certificate keys. If not specified
keys must either be unencrypted, or Squid started with the -N
option to allow it to query interactively for the passphrase.
        
</PRE>
</P>
<DT><B>minimum_icp_query_timeout (msec)</B><DD><P>
<PRE>
Default: 5

Normally the ICP query timeout is determined dynamically.  But
sometimes it can lead to very small timeouts, even lower than
the normal latency variance on your link due to traffic.
Use this option to put an lower limit on the dynamic timeout
value.  Do NOT use this option to always use a fixed (instead
of a dynamic) timeout value. To set a fixed timeout see the
'icp_query_timeout' directive.
        
</PRE>
</P>
<DT><B>background_ping_rate</B><DD><P>
<PRE>
Default: 10 seconds

Controls how often the ICP pings are sent to siblings that
have background-ping set.
        
</PRE>
</P>
<DT><B>logformat</B><DD><P>
<PRE>
Default: none

Usage:

logformat &lt;name> &lt;format specification>

Defines an access log format.

The &lt;format specification> is a string with embedded % format codes

% format codes all follow the same basic structure where all but
the formatcode is optional. Output strings are automatically escaped
as required according to their context and the output format
modifiers are usually not needed, but can be specified if an explicit
output format is desired.

% ["|[|'|#] [-] [[0]width] [{argument}] formatcode

"       output in quoted string format
[       output in squid text log format as used by log_mime_hdrs
#       output in URL quoted format
'       output as-is

-       left aligned
width   field width. If starting with 0 the
output is zero padded
{arg}   argument such as header name etc

Format codes:

>a      Client source IP address
>A      Client FQDN
&lt;A      Server IP address or peer name
la      Local IP address (http_port)
lp      Local port number (http_port)
ts      Seconds since epoch
tu      subsecond time (milliseconds)
tl      Local time. Optional strftime format argument
default %d/%b/%Y:%H:%M:S %z
tg      GMT time. Optional strftime format argument
default %d/%b/%Y:%H:%M:S %z
tr      Response time (milliseconds)
>h      Request header. Optional header name argument
on the format header[:[separator]element]
&lt;h      Reply header. Optional header name argument
as for >h
un      User name
ul      User login
ui      User ident
ue      User from external acl
Hs      HTTP status code
Ss      Squid request status (TCP_MISS etc)
Sh      Squid hierarchy status (DEFAULT_PARENT etc)
mt      MIME content type
rm      Request method (GET/POST etc)
ru      Request URL
rv      Request protocol version
et      Tag returned by external acl
ea      Log string returned by external acl
&lt;st     Reply size including HTTP headers
&lt;sH     Reply high offset sent
&lt;sS     Upstream object size
%       a literal % character

logformat squid  %ts.%03tu %6tr %>a %Ss/%03Hs %&lt;st %rm %ru %un %Sh/%&lt;A %mt
logformat squidmime  %ts.%03tu %6tr %>a %Ss/%03Hs %&lt;st %rm %ru %un %Sh/%&lt;A %mt [%>h] [%&lt;h]
logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %&lt;st %Ss:%Sh
logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %&lt;st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
        
</PRE>
</P>
<DT><B>check_hostnames on|off</B><DD><P>
<PRE>
Default: on

For security and stability reasons Squid by default checks
hostnames for Internet standard RFC compliance. If you do not want
Squid to perform these checks turn this directive off.
        
</PRE>
</P>
<DT><B>url_rewrite_concurrency redirect_concurrency</B><DD><P>
<PRE>
Default: 0

The number of requests each redirector helper can handle in
parallell. Defaults to 0 which indicates the redirector
is a old-style singlethreaded redirector.
        
</PRE>
</P>
<DT><B>read_ahead_gap</B><DD><P>
<PRE>
Default: 16 KB

The amount of data the cache will buffer ahead of what has been
sent to the client when retrieving an object from another server.
        
</PRE>
</P>
<DT><B>log_access allow|deny acl acl...</B><DD><P>
<PRE>
Default: none

This options allows you to control which requests gets logged
to access.log (see access_log directive). Requests denied for
logging will also not be accounted for in performance counters.
        
</PRE>
</P>
<DT><B>httpd_suppress_version_string on|off</B><DD><P>
<PRE>
Default: off

Suppress Squid version string info in HTTP headers and HTML error pages.
        
</PRE>
</P>
<DT><B>httpd_accel_surrogate_id</B><DD><P>
<PRE>
Default: unset

Surrogates (http://www.esi.org/architecture_spec_1.0.html)
need an identification token to allow control targeting. Because
a farm of surrogates may all perform the same tasks, they may share
an identification token.
        
</PRE>
</P>
<DT><B>http_accel_surrogate_remote on|off</B><DD><P>
<PRE>
Default: off

Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote.
Set this to on to have squid behave as a remote surrogate.
        
</PRE>
</P>
<DT><B>esi_parser libxml2|expat|custom</B><DD><P>
<PRE>
Default: custom

ESI markup is not strictly XML compatible. The custom ESI parser
will give higher performance, but cannot handle non ASCII character
encodings.
        
</PRE>
</P>
<DT><B>email_err_data on|off</B><DD><P>
<PRE>
Default: on

If enabled, information about the occurred error will be
included in the mailto links of the ERR pages (if %W is set)
so that the email body contains the data.
Syntax is &lt;A HREF="mailto:%w%W"&gt;%w&lt;/A&gt;
        
</PRE>
</P>
<DT><B>via on|off</B><DD><P>
<PRE>
Default: on

If set (default), Squid will include a Via header in requests and
replies as required by RFC2616.
        
</PRE>
</P>
<DT><B>refresh_all_ims on|off</B><DD><P>
<PRE>
Default: off

When you enable this option, squid will always check
the origin server for an update when a client sends an
If-Modified-Since request.  Many browsers use IMS
requests when the user requests a reload, and this
ensures those clients receive the latest version.

By default (off), squid may return a Not Modified response
based on the age of the cached version.
        
</PRE>
</P>
<DT><B>request_header_access</B><DD><P>
<PRE>
Default: none

Usage: request_header_access header_name allow|deny [!]aclname ...

WARNING: Doing this VIOLATES the HTTP standard.  Enabling
this feature could make you liable for problems which it
causes.

This option replaces the old 'anonymize_headers' and the
older 'http_anonymizer' option with something that is much
more configurable. This new method creates a list of ACLs
for each header, allowing you very fine-tuned header
mangling.

This option only applies to request headers, i.e., from the
client to the server.

You can only specify known headers for the header name.
Other headers are reclassified as 'Other'. You can also
refer to all the headers with 'All'.

For example, to achieve the same behavior as the old
'http_anonymizer standard' option, you should use:

request_header_access From deny all
request_header_access Referer deny all
request_header_access Server deny all
request_header_access User-Agent deny all
request_header_access WWW-Authenticate deny all
request_header_access Link deny all

Or, to reproduce the old 'http_anonymizer paranoid' feature
you should use:

request_header_access Allow allow all
request_header_access Authorization allow all
request_header_access WWW-Authenticate allow all
request_header_access Proxy-Authorization allow all
request_header_access Proxy-Authenticate allow all
request_header_access Cache-Control allow all
request_header_access Content-Encoding allow all
request_header_access Content-Length allow all
request_header_access Content-Type allow all
request_header_access Date allow all
request_header_access Expires allow all
request_header_access Host allow all
request_header_access If-Modified-Since allow all
request_header_access Last-Modified allow all
request_header_access Location allow all
request_header_access Pragma allow all
request_header_access Accept allow all
request_header_access Accept-Charset allow all
request_header_access Accept-Encoding allow all
request_header_access Accept-Language allow all
request_header_access Content-Language allow all
request_header_access Mime-Version allow all
request_header_access Retry-After allow all
request_header_access Title allow all
request_header_access Connection allow all
request_header_access Proxy-Connection allow all
request_header_access All deny all

although many of those are HTTP reply headers, and so should be
controlled with the reply_header_access directive.

By default, all headers are allowed (no anonymizing is
performed).
        
</PRE>
</P>
<DT><B>reply_header_access</B><DD><P>
<PRE>
Default: none

Usage: reply_header_access header_name allow|deny [!]aclname ...

WARNING: Doing this VIOLATES the HTTP standard.  Enabling
this feature could make you liable for problems which it
causes.

This option only applies to reply headers, i.e., from the
server to the client.

This is the same as request_header_access, but in the other
direction.

This option replaces the old 'anonymize_headers' and the
older 'http_anonymizer' option with something that is much
more configurable. This new method creates a list of ACLs
for each header, allowing you very fine-tuned header
mangling.

You can only specify known headers for the header name.
Other headers are reclassified as 'Other'. You can also
refer to all the headers with 'All'.

For example, to achieve the same behavior as the old
'http_anonymizer standard' option, you should use:

reply_header_access From deny all
reply_header_access Referer deny all
reply_header_access Server deny all
reply_header_access User-Agent deny all
reply_header_access WWW-Authenticate deny all
reply_header_access Link deny all

Or, to reproduce the old 'http_anonymizer paranoid' feature
you should use:

reply_header_access Allow allow all
reply_header_access Authorization allow all
reply_header_access WWW-Authenticate allow all
reply_header_access Proxy-Authorization allow all
reply_header_access Proxy-Authenticate allow all
reply_header_access Cache-Control allow all
reply_header_access Content-Encoding allow all
reply_header_access Content-Length allow all
reply_header_access Content-Type allow all
reply_header_access Date allow all
reply_header_access Expires allow all
reply_header_access Host allow all
reply_header_access If-Modified-Since allow all
reply_header_access Last-Modified allow all
reply_header_access Location allow all
reply_header_access Pragma allow all
reply_header_access Accept allow all
reply_header_access Accept-Charset allow all
reply_header_access Accept-Encoding allow all
reply_header_access Accept-Language allow all
reply_header_access Content-Language allow all
reply_header_access Mime-Version allow all
reply_header_access Retry-After allow all
reply_header_access Title allow all
reply_header_access Connection allow all
reply_header_access Proxy-Connection allow all
reply_header_access All deny all

although the HTTP request headers won't be usefully controlled
by this directive -- see request_header_access for details.

By default, all headers are allowed (no anonymizing is
performed).
        
</PRE>
</P>
<DT><B>minimum_expiry_time</B><DD><P>
<PRE>
Default: 60 seconds

The minimum caching time according to (Expires - Date)
Headers Squid honors if the object can't be revalidated
defaults to 60 seconds. In reverse proxy enorinments it
might be desirable to honor shorter object lifetimes. It
is most likely better to make your server return a
meaningful Last-Modified header however. In ESI environments
where page fragments often have short lifetimes, this will
often be best set to 0.
        
</PRE>
</P>
<DT><B>icap_enable on|off</B><DD><P>
<PRE>
Default: off

If you want to enable the ICAP module support, set this to on.
        
</PRE>
</P>
<DT><B>icap_preview_enable on|off</B><DD><P>
<PRE>
Default: off

Set this to 'on' if you want to enable the ICAP preview
feature in Squid.
        
</PRE>
</P>
<DT><B>icap_preview_size</B><DD><P>
<PRE>
Default: -1

The default size of preview data to be sent to the ICAP server.
-1 means no preview. This value might be overwritten on a per server
basis by OPTIONS requests.
        
</PRE>
</P>
<DT><B>icap_default_options_ttl (seconds)</B><DD><P>
<PRE>
Default: 60

The default TTL value for ICAP OPTIONS responses that don't have
an Options-TTL header.
        
</PRE>
</P>
<DT><B>icap_persistent_connections on|off</B><DD><P>
<PRE>
Default: on

Whether or not Squid should use persistent connections to
an ICAP server.
        
</PRE>
</P>
<DT><B>icap_send_client_ip on|off</B><DD><P>
<PRE>
Default: off

This adds the header "X-Client-IP" to ICAP requests.
        
</PRE>
</P>
<DT><B>icap_send_client_username on|off</B><DD><P>
<PRE>
Default: off

This adds the header "X-Client-Username" to ICAP requests
if proxy access is authentified.
        
</PRE>
</P>
<DT><B>icap_service</B><DD><P>
<PRE>
Default: none

Defines a single ICAP service

icap_service servicename vectoring_point bypass service_url

vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
This specifies at which point of request processing the ICAP
service should be plugged in.
bypass = 1|0
If set to 1 and the ICAP server cannot be reached, the request will go
through without being processed by an ICAP server
service_url = icap://servername:port/service

Note: reqmod_precache and respmod_postcache is not yet implemented

Example:
icap_service service_1 reqmod_precache 0 icap://icap1.mydomain.net:1344/reqmod
icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod
        
</PRE>
</P>
<DT><B>icap_class</B><DD><P>
<PRE>
Default: none

Defines an ICAP service chain. If there are multiple services per
vectoring point, they are processed in the specified order.

icap_class classname servicename...

Example:
icap_class class_1 service_1 service_2
icap class class_2 service_1 service_3
        
</PRE>
</P>
<DT><B>icap_access</B><DD><P>
<PRE>
Default: none

Redirects a request through an ICAP service class, depending
on given acls

icap_access classname allow|deny [!]aclname...

The icap_access statements are processed in the order they appear in
this configuration file. If an access list matches, the processing stops.
For an "allow" rule, the specified class is used for the request. A "deny"
rule simply stops processing without using the class. You can also use the
special classname "None".

For backward compatibility, it is also possible to use services
directly here.

Example:
icap_access class_1 allow all
        
</PRE>
</P>
</DL>
</P>


<H3><A NAME="modifiedtags"></A> Changes to existing tags</H3>

<P>
<DL>
<DT><B>http_port</B><DD><P>New options:
<PRE>
    transparent  Support for transparent proxies

    accel        Accelerator mode. Also set implicit by the other accelerator directives

    vhost        Accelerator mode using Host header for virtual domain support

    vport        Accelerator with IP based virtual host support

    vport=NN     As above, but uses specified port number rather
                 than the http_port number

    defaultsite= Main web site name for accelerators

    protocol=    Protocol to reconstruct accelerated requests with.
                 Defaults to http

    disable-pmtu-discovery=
      Control Path-MTU discovery usage:
        off          lets OS decide on what to do (default).
        transparent  disable PMTU discovery when transparent support is enabled.
        always       disable always PMTU discovery.

    In many setups of transparently intercepting proxies Path-MTU
    discovery can not work on traffic towards the clients. This is
    the case when the intercepting device does not fully track
    connections and fails to forward ICMP must fragment messages
    to the cache server. If you have such setup and experience that
    certain clients sporadically hang or never complete requests set
    disable-pmtu-discovery option to 'transparent'.
        
</PRE>
</P>
<DT><B> https_port</B><DD><P>New options:
<PRE>
    defaultsite= The name of the https site presented on this port

    protocol=    Protocol to reconstruct accelerated requests
                 with. Defaults to https

    options=     Various SSL engine options. The most important
                 being:
    NO_SSLv2  Disallow the use of SSLv2
    NO_SSLv3  Disallow the use of SSLv3
    NO_TLSv1  Disallow the use of TLSv1
    SINGLE_DH_USE Always create a new key when using
                  temporary/ephemeral DH key exchanges
    See src/ssl_support.c or OpenSSL SSL_CTX_set_options
    documentation for a complete list of options

    clientca=    File containing the list of CAs to use when
                 requesting a client certificate

    cafile=      File containing additional CA certificates to
                 use when verifying client certificates. If unset
                 clientca will be used

    capath=      Directory containing additional CA certificates
                 and CRL lists to use when verifying client certificates

    crlfile=     File of additional CRL lists to use when verifying
                 the client certificate, in addition to CRLs stored in
                 the capath. Implies VERIFY_CRL flag below.

    dhparams=    File containing DH parameters for temporary/ephemeral
                 DH key exchanges

    sslflags=    Various flags modifying the use of SSL:
                 DELAYED_AUTH
                    Don't request client certificates
                    immediately, but wait until acl processing
                    requires a certificate (not yet implemented)
                 NO_DEFAULT_CA
                    Don't use the default CA lists built in
                    to OpenSSL
                 NO_SESSION_REUSE
                    Don't allow for session reuse. Each connection
                    will result in a new SSL session.
                 VERIFY_CRL
                    Verify CRL lists when accepting client
                    certificates
                 VERIFY_CRL_ALL
                    Verify CRL lists for all certificates in the
                    client certificate chain

    sslcontext=  SSL session ID context identifier.

    accelAccelerator mode. Also set implicit by the other
    accelerator directives

    vhostAccelerator mode using Host header for virtual
    domain support

    vportAccelerator with IP based virtual host support

    vport=NN     As above, but uses specified port number rather
    than the https_port number
        
</PRE>
</P>
<DT><B>cache_peer</B><DD><P>New options:
<PRE>
     basetime=n
     background-ping
     weighted-round-robin
     carp
     htcp-oldsquid
     originserver
     name=xxx
     forceddomain=name
     ssl
     sslcert=/path/to/ssl/certificate
     sslkey=/path/to/ssl/key
     sslversion=1|2|3|4
     sslcipher=...
     ssloptions=...
     front-end-https[=on|auto]


     use 'basetime=n' to specify a base amount to
     be subtracted from round trip times of parents.
     It is subtracted before division by weight in calculating
     which parent to fectch from. If the rtt is less than the
     base time the rtt is set to a minimal value.

     use 'background-ping' to only send ICP queries to this
     neighbor infrequently. This is used to keep the neighbor
     round trip time updated and is usually used in
     conjunction with weighted-round-robin.

     use 'weighted-round-robin' to define a set of parents
     which should be used in a round-robin fashion with the
     frequency of each parent being based on the round trip
     time. Closer parents are used more often.
     Usually used for background-ping parents.

     use 'carp' to define a set of parents which should
     be used as a CARP array. The requests will be
     distributed among the parents based on the CARP load
     balancing hash function based on their weigth.

     use 'htcp-oldsquid' to send HTCP to old Squid versions

     'originserver' causes this parent peer to be contacted as
     a origin server. Meant to be used in accelerator setups.

     use 'name=xxx' if you have multiple peers on the same
     host but different ports. This name can be used to
     differentiate the peers in cache_peer_access and similar
     directives.

     use 'forceddomain=name' to forcibly set the Host header
     of requests forwarded to this peer. Useful in accelerator
     setups where the server (peer) expects a certain domain
     name and using redirectors to feed this domainname
     is not feasible.

     use 'ssl' to indicate connections to this peer should
     bs SSL/TLS encrypted.

     use 'sslcert=/path/to/ssl/certificate' to specify a client
     SSL certificate to use when connecting to this peer.

     use 'sslkey=/path/to/ssl/key' to specify the private SSL
     key corresponding to sslcert above. If 'sslkey' is not
     specified 'sslcert' is assumed to reference a
     combined file containing both the certificate and the key.

     use sslversion=1|2|3|4 to specify the SSL version to use
     when connecting to this peer
        1 = automatic (default)
        2 = SSL v2 only
        3 = SSL v3 only
        4 = TLS v1 only

     use sslcipher=... to specify the list of valid SSL chipers
     to use when connecting to this peer

     use ssloptions=... to specify various SSL engine options:
        NO_SSLv2  Disallow the use of SSLv2
        NO_SSLv3  Disallow the use of SSLv3
        NO_TLSv1  Disallow the use of TLSv1
     See src/ssl_support.c or the OpenSSL documentation for
     a more complete list.

     use cafile=... to specify a file containing additional
     CA certificates to use when verifying the peer certificate

     use capath=... to specify a directory containing additional
     CA certificates to use when verifying the peer certificate

     use sslflags=... to specify various flags modifying the
     SSL implementation:
        DONT_VERIFY_PEER
            Accept certificates even if they fail to
            verify.
        NO_DEFAULT_CA
            Don't use the default CA list built in
            to OpenSSL.
        DONT_VERIFY_DOMAIN
            Don't verify the peer certificate
            matches the server name

     use sslname= to specify the peer name as advertised
     in it's certificate. Used for verifying the correctness
     of the received peer certificate. If not specified the
     peer hostname will be used.

     use front-end-https to enable the "Front-End-Https: On"
     header needed when using Squid as a SSL frontend infront
     of Microsoft OWA. See MS KB document Q307347 for details
     on this header. If set to auto the header will
     only be added if the request is forwarded as a https://
     URL.
        
</PRE>
</P>
<P>Removed options:
<PRE>
    carp-load-factor
        
</PRE>
</P>
<DT><B>cache_dir</B><DD><P>COSS stripe file:
<PRE>
    The coss file store has changed from 2.5. Now it uses a file
    called 'stripe' in the directory names in the config - and
    this will be created by squid -z.
        
</PRE>
</P>
<DT><B>access_log cache_access_log</B><DD><P>Takes an optional log format:
<PRE>
    These files log client request activities. Has a line every HTTP or
    ICP request. The format is:
    access_log &lt;filepath> [&lt;logformat name> [acl acl ...]]
    access_log none [acl acl ...]]

    Will log to the specified file using the specified format (which
    must be defined in a logformat directive) those entries which match
    ALL the acl's specified (which must be defined in acl clauses).
    If no acl is specified, all requests will be logged to this file.

    To disable logging of a request use the filepath "none", in which case
    a logformat name should not be specified.

    To log the request via syslog specify a filepath of "syslog":

    access_log syslog[:facility|priority] [format [acl1 [acl2 ....]]]
    where facility could be any of:
        LOG_AUTHPRIV, LOG_DAEMON, LOG_LOCAL0 .. LOG_LOCAL7 or LOG_USER.

    And priority could be any of:
        LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.
        
</PRE>
</P>
<DT><B>redirect_program</B><DD><P>New alias: 'url_rewrite_program'</P>
<DT><B>redirect_children</B><DD><P>New alias: 'url_rewrite_children'</P>
<DT><B>redirect_host_header</B><DD><P>New alias: 'url_rewrite_host_header'</P>
<DT><B>auth_param</B><DD><P>New option for basic scheme:
<PRE>
    "concurrency" concurrency
    The number of concurrent requests the helper can process.
    The default of 0 is used for helpers who only supports
    one request at a time.
    auth_param basic concurrency 0
        
</PRE>
</P>
<P>Removed NTLM options:
<PRE>
    "max_challenge_reuses" number
    The maximum number of times a challenge given by a ntlm authentication
    helper can be reused. Increasing this number increases your exposure
    to replay attacks on your network. 0 (the default) means use the
    challenge is used only once. See also the max_ntlm_challenge_lifetime
    directive if enabling challenge reuses.
    auth_param ntlm max_challenge_reuses 0

    "max_challenge_lifetime" timespan
    The maximum time period a ntlm challenge is reused over. The
    actual period will be the minimum of this time AND the number of
    reused challenges.
    auth_param ntlm max_challenge_lifetime 2 minutes

    "use_ntlm_negotiate" on|off
    Enables support for NTLM NEGOTIATE packet exchanges with the helper.
    The configured ntlm authenticator must be able to handle NTLM
    NEGOTIATE packet. See the authenticator programs documentation if
    unsure. ntlm_auth from Samba-3.0.2 or later supports the use of this
    option.
    The NEGOTIATE packet is required to support NTLMv2 and a
    number of other negotiable NTLMSSP options, and also makes it
    more likely the negotiation is successful. Enabling this parameter
    will also solve problems encountered when NT domain policies
    restrict users to access only certain workstations. When this is off,
    all users must be allowed to log on the proxy servers too, or they'll
    get "invalid workstation" errors - and access denied - when trying to
    use Squid's services.
    Use of ntlm NEGOTIATE is incompatible with challenge reuse, so
    enabling this parameter will OVERRIDE the max_challenge_reuses and
    max_challenge_lifetime parameters and set them to 0.
    auth_param ntlm use_ntlm_negotiate off
        
</PRE>
</P>
<P>New NTLM option:
<PRE>
    "keep_alive" on|off
    If you experience problems with PUT/POST requests when using the
    Negotiate authentication scheme then you can try setting this to
    off. This will cause Squid to forcibly close the connection on
    the initial requests where the browser asks which schemes are
    supported by the proxy.
        
</PRE>
</P>
<DT><B>external_acl_type</B><DD><P>New options:
<PRE>
    concurrency=n concurrency level per process. Use 0 for old style
    helpers who can only process a single request at a time.
    
    grace=n       Percentage remaining of TTL where a refresh of a
    cached entry should be initiated without needing to
    wait for a new reply. (default 0 for no grace period)
    protocol=2.5  Compatibility mode for Squid-2.5 external acl helpers
        
</PRE>
</P>
<P>New format specifications:
<PRE>
    %EXT_USER     Username from external acl
    %SRCPORT      Client source port
    %PATH Requested URL path
    %METHOD       Request method
    %MYADDR       Squid interface address
    %MYPORT       Squid http_port number
    %USER_CERT    SSL User certificate in PEM format
    %USER_CERTCHAIN SSL User certificate chain in PEM format
    %USER_CERT_xx SSL User certificate subject attribute xx
    %USER_CA_xx   SSL User certificate issuer attribute xx
        
</PRE>
</P>
<P>New keywords:
<PRE>
    user= The users name (login)
    password=     The users password (for login= cache_peer option)
    message=      Message describing the reason. Available as %o
                  in error pages
     tag=  Apply a tag to a request (for both ERR and OK results)
           Only sets a tag, does not alter existing tags.
    log=  String to be logged in access.log. Available as
          %ea in logformat specifications

    Keyword values need to be URL escaped if they may contain
    contain whitespace or quotes.

    In Squid-2.5 compatibility mode quoting using " and \ is used
    instead of URL escaping.
        
</PRE>
</P>
<P>Removed option:
<PRE>
    protocol=3.0  Use URL-escaped strings instead of quoting
        
</PRE>
</P>
<DT><B>refresh_pattern</B><DD><P>New options:
<PRE>
    ignore-no-cache
    ignore-no-store
    ignore-private
    ignore-auth
    refresh-ims

    ignore-no-cache ignores any ``Pragma: no-cache'' and
    ``Cache-control: no-cache'' headers received from a server.
    The HTTP RFC never allows the use of this (Pragma) header
    from a server, only a client, though plenty of servers
    send it anyway.

    ignore-no-store ignores any ``Cache-control: no-store''
    headers received from a server. Doing this VIOLATES
    the HTTP standard. Enabling this feature could make you
    liable for problems which it causes.

    ignore-private ignores any ``Cache-control: private''
    headers received from a server. Doing this VIOLATES
    the HTTP standard. Enabling this feature could make you
    liable for problems which it causes.

    ignore-auth caches responses to requests with authorization,
    irrespective of ``Cache-control'' headers received from
    a server. Doing this VIOLATES the HTTP standard. Enabling
    this feature could make you liable for problems which
    it causes.

    refresh-ims causes squid to contact the origin server
    when a client issues an If-Modified-Since request. This
    ensures that the client will receive an updated version
    if one is available.
        
</PRE>
</P>
<DT><B>negative_dns_ttl</B><DD><P>New default:
<PRE>
    Default: 5 minutes
    (Old default: 1 minute)
        
</PRE>
</P>
<DT><B>acl</B><DD><P>New types:
<PRE>
    acl aclname http_status 200 301 500- 400-403 ...     # status code in reply

    acl aclname user_cert attribute values...
      # match against attributes in a user SSL certificate
      # attribute is one of DN/C/O/CN/L/ST

    acl aclname ca_cert attribute values...
      # match against attributes a users issuing CA SSL certificate
      # attribute is one of DN/C/O/CN/L/ST

    acl aclname ext_user username ...
    acl aclname ext_user_regex [-i] pattern ...
      # string match on username returned by external acl processing
      # use REQUIRED to accept any non-null user name.
        
</PRE>
</P>
<P>Removed types:
<PRE>
    acl aclname urllogin [-i] [^a-zA-Z0-9] ...      # regex matching on URL login field

    acl aclname req_header header-name [-i] any\.regex\.here
      # regex match against any of the known request headers.  May be
      # thought of as a superset of "browser", "referer" and "mime-type"
      # ACLs.

    acl aclname rep_header header-name [-i] any\.regex\.here
      # regex match against any of the known response headers.
      # Example:
      #
      # acl many_spaces rep_header Content-Disposition -i [[:space:]]{3,}
        
</PRE>
</P>
<DT><B>short_icon_urls</B><DD><P>New default:
<PRE>
    Default: on
    (Old default: off)
        
</PRE>
</P>
<DT><B>delay_class</B><DD><P>New delay classes:
<PRE>
    class 4 Everything in a class 3 delay pool, with an
    additional limit on a per user basis. This
    only takes effect if the username is established
    in advance - by forcing authentication in your
    http_access rules.

    class 5 Requests are grouped according their tag (see
    external_acl's tag= reply).
        
</PRE>
</P>
</DL>
</P>




<H3><A NAME="removedtags"></A> Removed tags</H3>

<P>
<DL>
<DT><B>httpd_accel_host</B><DD><P>Replaced by the defaultsite= or vport=0 (in case of virtual) http_port options</P>
<DT><B>httpd_accel_port</B><DD><P>Replaced by vport http(s)_port option</P>
<DT><B>httpd_accel_single_host on|off</B><DD><P>Replaced by cache_peer originserver based request forwarding
making this option obsolete.</P>
<DT><B>httpd_accel_with_proxy on|off</B><DD><P>Obsolete, no longer needed.</P>
<DT><B>httpd_accel_uses_host_header on|off</B><DD><P>This has been replaced by the vhost http(s)_port option</P>
<DT><B>httpd_accel_no_pmtu_disc on|off</B><DD><P>This has been replaced by the disable-pmtu-discovery=.. http_port option</P>
<DT><B>header_access</B><DD><P>This has been replaced by request_header_access and reply_header_access</P>
</DL>
</P>


</BODY>
</HTML>