squid.conf 281 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908
  1. # WELCOME TO SQUID 3.5.12
  2. # ----------------------------
  3. #
  4. # This is the documentation for the Squid configuration file.
  5. # This documentation can also be found online at:
  6. # http://www.squid-cache.org/Doc/config/
  7. #
  8. # You may wish to look at the Squid home page and wiki for the
  9. # FAQ and other documentation:
  10. # http://www.squid-cache.org/
  11. # http://wiki.squid-cache.org/SquidFaq
  12. # http://wiki.squid-cache.org/ConfigExamples
  13. #
  14. # This documentation shows what the defaults for various directives
  15. # happen to be. If you don't need to change the default, you should
  16. # leave the line out of your squid.conf in most cases.
  17. #
  18. # In some cases "none" refers to no default setting at all,
  19. # while in other cases it refers to the value of the option
  20. # - the comments for that keyword indicate if this is the case.
  21. #
  22. # Configuration options can be included using the "include" directive.
  23. # Include takes a list of files to include. Quoting and wildcards are
  24. # supported.
  25. #
  26. # For example,
  27. #
  28. # include /path/to/included/file/squid.acl.config
  29. #
  30. # Includes can be nested up to a hard-coded depth of 16 levels.
  31. # This arbitrary restriction is to prevent recursive include references
  32. # from causing Squid entering an infinite loop whilst trying to load
  33. # configuration files.
  34. #
  35. # Values with byte units
  36. #
  37. # Squid accepts size units on some size related directives. All
  38. # such directives are documented with a default value displaying
  39. # a unit.
  40. #
  41. # Units accepted by Squid are:
  42. # bytes - byte
  43. # KB - Kilobyte (1024 bytes)
  44. # MB - Megabyte
  45. # GB - Gigabyte
  46. #
  47. # Values with spaces, quotes, and other special characters
  48. #
  49. # Squid supports directive parameters with spaces, quotes, and other
  50. # special characters. Surround such parameters with "double quotes". Use
  51. # the configuration_includes_quoted_values directive to enable or
  52. # disable that support.
  53. #
  54. # Squid supports reading configuration option parameters from external
  55. # files using the syntax:
  56. # parameters("/path/filename")
  57. # For example:
  58. # acl whitelist dstdomain parameters("/etc/squid/whitelist.txt")
  59. #
  60. # Conditional configuration
  61. #
  62. # If-statements can be used to make configuration directives
  63. # depend on conditions:
  64. #
  65. # if <CONDITION>
  66. # ... regular configuration directives ...
  67. # [else
  68. # ... regular configuration directives ...]
  69. # endif
  70. #
  71. # The else part is optional. The keywords "if", "else", and "endif"
  72. # must be typed on their own lines, as if they were regular
  73. # configuration directives.
  74. #
  75. # NOTE: An else-if condition is not supported.
  76. #
  77. # These individual conditions types are supported:
  78. #
  79. # true
  80. # Always evaluates to true.
  81. # false
  82. # Always evaluates to false.
  83. # <integer> = <integer>
  84. # Equality comparison of two integer numbers.
  85. #
  86. #
  87. # SMP-Related Macros
  88. #
  89. # The following SMP-related preprocessor macros can be used.
  90. #
  91. # ${process_name} expands to the current Squid process "name"
  92. # (e.g., squid1, squid2, or cache1).
  93. #
  94. # ${process_number} expands to the current Squid process
  95. # identifier, which is an integer number (e.g., 1, 2, 3) unique
  96. # across all Squid processes of the current service instance.
  97. #
  98. # ${service_name} expands into the current Squid service instance
  99. # name identifier which is provided by -n on the command line.
  100. #
  101. # TAG: broken_vary_encoding
  102. # This option is not yet supported by Squid-3.
  103. #Default:
  104. # none
  105. # TAG: cache_vary
  106. # This option is not yet supported by Squid-3.
  107. #Default:
  108. # none
  109. # TAG: error_map
  110. # This option is not yet supported by Squid-3.
  111. #Default:
  112. # none
  113. # TAG: external_refresh_check
  114. # This option is not yet supported by Squid-3.
  115. #Default:
  116. # none
  117. # TAG: location_rewrite_program
  118. # This option is not yet supported by Squid-3.
  119. #Default:
  120. # none
  121. # TAG: refresh_stale_hit
  122. # This option is not yet supported by Squid-3.
  123. #Default:
  124. # none
  125. # TAG: hierarchy_stoplist
  126. # Remove this line. Use always_direct or cache_peer_access ACLs instead if you need to prevent cache_peer use.
  127. #Default:
  128. # none
  129. # TAG: log_access
  130. # Remove this line. Use acls with access_log directives to control access logging
  131. #Default:
  132. # none
  133. # TAG: log_icap
  134. # Remove this line. Use acls with icap_log directives to control icap logging
  135. #Default:
  136. # none
  137. # TAG: ignore_ims_on_miss
  138. # Remove this line. The HTTP/1.1 feature is now configured by 'cache_miss_revalidate'.
  139. #Default:
  140. # none
  141. # TAG: chunked_request_body_max_size
  142. # Remove this line. Squid is now HTTP/1.1 compliant.
  143. #Default:
  144. # none
  145. # TAG: dns_v4_fallback
  146. # Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant.
  147. #Default:
  148. # none
  149. # TAG: emulate_httpd_log
  150. # Replace this with an access_log directive using the format 'common' or 'combined'.
  151. #Default:
  152. # none
  153. # TAG: forward_log
  154. # Use a regular access.log with ACL limiting it to MISS events.
  155. #Default:
  156. # none
  157. # TAG: ftp_list_width
  158. # Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead.
  159. #Default:
  160. # none
  161. # TAG: ignore_expect_100
  162. # Remove this line. The HTTP/1.1 feature is now fully supported by default.
  163. #Default:
  164. # none
  165. # TAG: log_fqdn
  166. # Remove this option from your config. To log FQDN use %>A in the log format.
  167. #Default:
  168. # none
  169. # TAG: log_ip_on_direct
  170. # Remove this option from your config. To log server or peer names use %<A in the log format.
  171. #Default:
  172. # none
  173. # TAG: maximum_single_addr_tries
  174. # Replaced by connect_retries. The behaviour has changed, please read the documentation before altering.
  175. #Default:
  176. # none
  177. # TAG: referer_log
  178. # Replace this with an access_log directive using the format 'referrer'.
  179. #Default:
  180. # none
  181. # TAG: update_headers
  182. # Remove this line. The feature is supported by default in storage types where update is implemented.
  183. #Default:
  184. # none
  185. # TAG: url_rewrite_concurrency
  186. # Remove this line. Set the 'concurrency=' option of url_rewrite_children instead.
  187. #Default:
  188. # none
  189. # TAG: useragent_log
  190. # Replace this with an access_log directive using the format 'useragent'.
  191. #Default:
  192. # none
  193. # TAG: dns_testnames
  194. # Remove this line. DNS is no longer tested on startup.
  195. #Default:
  196. # none
  197. # TAG: extension_methods
  198. # Remove this line. All valid methods for HTTP are accepted by default.
  199. #Default:
  200. # none
  201. # TAG: zero_buffers
  202. #Default:
  203. # none
  204. # TAG: incoming_rate
  205. #Default:
  206. # none
  207. # TAG: server_http11
  208. # Remove this line. HTTP/1.1 is supported by default.
  209. #Default:
  210. # none
  211. # TAG: upgrade_http0.9
  212. # Remove this line. ICY/1.0 streaming protocol is supported by default.
  213. #Default:
  214. # none
  215. # TAG: zph_local
  216. # Alter these entries. Use the qos_flows directive instead.
  217. #Default:
  218. # none
  219. # TAG: header_access
  220. # Since squid-3.0 replace with request_header_access or reply_header_access
  221. # depending on whether you wish to match client requests or server replies.
  222. #Default:
  223. # none
  224. # TAG: httpd_accel_no_pmtu_disc
  225. # Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead.
  226. #Default:
  227. # none
  228. # TAG: wais_relay_host
  229. # Replace this line with 'cache_peer' configuration.
  230. #Default:
  231. # none
  232. # TAG: wais_relay_port
  233. # Replace this line with 'cache_peer' configuration.
  234. #Default:
  235. # none
  236. # OPTIONS FOR SMP
  237. # -----------------------------------------------------------------------------
  238. # TAG: workers
  239. # Number of main Squid processes or "workers" to fork and maintain.
  240. # 0: "no daemon" mode, like running "squid -N ..."
  241. # 1: "no SMP" mode, start one main Squid process daemon (default)
  242. # N: start N main Squid process daemons (i.e., SMP mode)
  243. #
  244. # In SMP mode, each worker does nearly all what a single Squid daemon
  245. # does (e.g., listen on http_port and forward HTTP requests).
  246. #Default:
  247. # SMP support disabled.
  248. # TAG: cpu_affinity_map
  249. # Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
  250. #
  251. # Sets 1:1 mapping between Squid processes and CPU cores. For example,
  252. #
  253. # cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
  254. #
  255. # affects processes 1 through 4 only and places them on the first
  256. # four even cores, starting with core #1.
  257. #
  258. # CPU cores are numbered starting from 1. Requires support for
  259. # sched_getaffinity(2) and sched_setaffinity(2) system calls.
  260. #
  261. # Multiple cpu_affinity_map options are merged.
  262. #
  263. # See also: workers
  264. #Default:
  265. # Let operating system decide.
  266. # OPTIONS FOR AUTHENTICATION
  267. # -----------------------------------------------------------------------------
  268. # TAG: auth_param
  269. # This is used to define parameters for the various authentication
  270. # schemes supported by Squid.
  271. #
  272. # format: auth_param scheme parameter [setting]
  273. #
  274. # The order in which authentication schemes are presented to the client is
  275. # dependent on the order the scheme first appears in config file. IE
  276. # has a bug (it's not RFC 2617 compliant) in that it will use the basic
  277. # scheme if basic is the first entry presented, even if more secure
  278. # schemes are presented. For now use the order in the recommended
  279. # settings section below. If other browsers have difficulties (don't
  280. # recognize the schemes offered even if you are using basic) either
  281. # put basic first, or disable the other schemes (by commenting out their
  282. # program entry).
  283. #
  284. # Once an authentication scheme is fully configured, it can only be
  285. # shutdown by shutting squid down and restarting. Changes can be made on
  286. # the fly and activated with a reconfigure. I.E. You can change to a
  287. # different helper, but not unconfigure the helper completely.
  288. #
  289. # Please note that while this directive defines how Squid processes
  290. # authentication it does not automatically activate authentication.
  291. # To use authentication you must in addition make use of ACLs based
  292. # on login name in http_access (proxy_auth, proxy_auth_regex or
  293. # external with %LOGIN used in the format tag). The browser will be
  294. # challenged for authentication on the first such acl encountered
  295. # in http_access processing and will also be re-challenged for new
  296. # login credentials if the request is being denied by a proxy_auth
  297. # type acl.
  298. #
  299. # WARNING: authentication can't be used in a transparently intercepting
  300. # proxy as the client then thinks it is talking to an origin server and
  301. # not the proxy. This is a limitation of bending the TCP/IP protocol to
  302. # transparently intercepting port 80, not a limitation in Squid.
  303. # Ports flagged 'transparent', 'intercept', or 'tproxy' have
  304. # authentication disabled.
  305. #
  306. # === Parameters common to all schemes. ===
  307. #
  308. # "program" cmdline
  309. # Specifies the command for the external authenticator.
  310. #
  311. # By default, each authentication scheme is not used unless a
  312. # program is specified.
  313. #
  314. # See http://wiki.squid-cache.org/Features/AddonHelpers for
  315. # more details on helper operations and creating your own.
  316. #
  317. # "key_extras" format
  318. # Specifies a string to be append to request line format for
  319. # the authentication helper. "Quoted" format values may contain
  320. # spaces and logformat %macros. In theory, any logformat %macro
  321. # can be used. In practice, a %macro expands as a dash (-) if
  322. # the helper request is sent before the required macro
  323. # information is available to Squid.
  324. #
  325. # By default, Squid uses request formats provided in
  326. # scheme-specific examples below (search for %credentials).
  327. #
  328. # The expanded key_extras value is added to the Squid credentials
  329. # cache and, hence, will affect authentication. It can be used to
  330. # autenticate different users with identical user names (e.g.,
  331. # when user authentication depends on http_port).
  332. #
  333. # Avoid adding frequently changing information to key_extras. For
  334. # example, if you add user source IP, and it changes frequently
  335. # in your environment, then max_user_ip ACL is going to treat
  336. # every user+IP combination as a unique "user", breaking the ACL
  337. # and wasting a lot of memory on those user records. It will also
  338. # force users to authenticate from scratch whenever their IP
  339. # changes.
  340. #
  341. # "realm" string
  342. # Specifies the protection scope (aka realm name) which is to be
  343. # reported to the client for the authentication scheme. It is
  344. # commonly part of the text the user will see when prompted for
  345. # their username and password.
  346. #
  347. # For Basic the default is "Squid proxy-caching web server".
  348. # For Digest there is no default, this parameter is mandatory.
  349. # For NTLM and Negotiate this parameter is ignored.
  350. #
  351. # "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
  352. #
  353. # The maximum number of authenticator processes to spawn. If
  354. # you start too few Squid will have to wait for them to process
  355. # a backlog of credential verifications, slowing it down. When
  356. # password verifications are done via a (slow) network you are
  357. # likely to need lots of authenticator processes.
  358. #
  359. # The startup= and idle= options permit some skew in the exact
  360. # amount run. A minimum of startup=N will begin during startup
  361. # and reconfigure. Squid will start more in groups of up to
  362. # idle=N in an attempt to meet traffic needs and to keep idle=N
  363. # free above those traffic needs up to the maximum.
  364. #
  365. # The concurrency= option sets the number of concurrent requests
  366. # the helper can process. The default of 0 is used for helpers
  367. # who only supports one request at a time. Setting this to a
  368. # number greater than 0 changes the protocol used to include a
  369. # channel ID field first on the request/response line, allowing
  370. # multiple requests to be sent to the same helper in parallel
  371. # without waiting for the response.
  372. #
  373. # Concurrency must not be set unless it's known the helper
  374. # supports the input format with channel-ID fields.
  375. #
  376. # NOTE: NTLM and Negotiate schemes do not support concurrency
  377. # in the Squid code module even though some helpers can.
  378. #
  379. #
  380. #
  381. # === Example Configuration ===
  382. #
  383. # This configuration displays the recommended authentication scheme
  384. # order from most to least secure with recommended minimum configuration
  385. # settings for each scheme:
  386. #
  387. ##auth_param negotiate program <uncomment and complete this line to activate>
  388. ##auth_param negotiate children 20 startup=0 idle=1
  389. ##auth_param negotiate keep_alive on
  390. ##
  391. ##auth_param digest program <uncomment and complete this line to activate>
  392. ##auth_param digest children 20 startup=0 idle=1
  393. ##auth_param digest realm Squid proxy-caching web server
  394. ##auth_param digest nonce_garbage_interval 5 minutes
  395. ##auth_param digest nonce_max_duration 30 minutes
  396. ##auth_param digest nonce_max_count 50
  397. ##
  398. ##auth_param ntlm program <uncomment and complete this line to activate>
  399. ##auth_param ntlm children 20 startup=0 idle=1
  400. ##auth_param ntlm keep_alive on
  401. ##
  402. ##auth_param basic program <uncomment and complete this line>
  403. ##auth_param basic children 5 startup=5 idle=1
  404. ##auth_param basic realm Squid proxy-caching web server
  405. ##auth_param basic credentialsttl 2 hours
  406. #Default:
  407. # none
  408. # TAG: authenticate_cache_garbage_interval
  409. # The time period between garbage collection across the username cache.
  410. # This is a trade-off between memory utilization (long intervals - say
  411. # 2 days) and CPU (short intervals - say 1 minute). Only change if you
  412. # have good reason to.
  413. #Default:
  414. # authenticate_cache_garbage_interval 1 hour
  415. # TAG: authenticate_ttl
  416. # The time a user & their credentials stay in the logged in
  417. # user cache since their last request. When the garbage
  418. # interval passes, all user credentials that have passed their
  419. # TTL are removed from memory.
  420. #Default:
  421. # authenticate_ttl 1 hour
  422. # TAG: authenticate_ip_ttl
  423. # If you use proxy authentication and the 'max_user_ip' ACL,
  424. # this directive controls how long Squid remembers the IP
  425. # addresses associated with each user. Use a small value
  426. # (e.g., 60 seconds) if your users might change addresses
  427. # quickly, as is the case with dialup. You might be safe
  428. # using a larger value (e.g., 2 hours) in a corporate LAN
  429. # environment with relatively static address assignments.
  430. #Default:
  431. # authenticate_ip_ttl 1 second
  432. # ACCESS CONTROLS
  433. # -----------------------------------------------------------------------------
  434. # TAG: external_acl_type
  435. # This option defines external acl classes using a helper program
  436. # to look up the status
  437. #
  438. # external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
  439. #
  440. # Options:
  441. #
  442. # ttl=n TTL in seconds for cached results (defaults to 3600
  443. # for 1 hour)
  444. #
  445. # negative_ttl=n
  446. # TTL for cached negative lookups (default same
  447. # as ttl)
  448. #
  449. # grace=n Percentage remaining of TTL where a refresh of a
  450. # cached entry should be initiated without needing to
  451. # wait for a new reply. (default is for no grace period)
  452. #
  453. # cache=n Limit the result cache size, default is 262144.
  454. # The expanded FORMAT value is used as the cache key, so
  455. # if the details in FORMAT are highly variable a larger
  456. # cache may be needed to produce reduction in helper load.
  457. #
  458. # children-max=n
  459. # Maximum number of acl helper processes spawned to service
  460. # external acl lookups of this type. (default 20)
  461. #
  462. # children-startup=n
  463. # Minimum number of acl helper processes to spawn during
  464. # startup and reconfigure to service external acl lookups
  465. # of this type. (default 0)
  466. #
  467. # children-idle=n
  468. # Number of acl helper processes to keep ahead of traffic
  469. # loads. Squid will spawn this many at once whenever load
  470. # rises above the capabilities of existing processes.
  471. # Up to the value of children-max. (default 1)
  472. #
  473. # concurrency=n concurrency level per process. Only used with helpers
  474. # capable of processing more than one query at a time.
  475. #
  476. # protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers.
  477. #
  478. # ipv4 / ipv6 IP protocol used to communicate with this helper.
  479. # The default is to auto-detect IPv6 and use it when available.
  480. #
  481. #
  482. # FORMAT specifications
  483. #
  484. # %LOGIN Authenticated user login name
  485. # %un A user name. Expands to the first available name
  486. # from the following list of information sources:
  487. # - authenticated user name, like %ul or %LOGIN
  488. # - user name sent by an external ACL, like %EXT_USER
  489. # - SSL client name, like %us in logformat
  490. # - ident user name, like %ui in logformat
  491. # %EXT_USER Username from previous external acl
  492. # %EXT_LOG Log details from previous external acl
  493. # %EXT_TAG Tag from previous external acl
  494. # %IDENT Ident user name
  495. # %SRC Client IP
  496. # %SRCPORT Client source port
  497. # %URI Requested URI
  498. # %DST Requested host
  499. # %PROTO Requested URL scheme
  500. # %PORT Requested port
  501. # %PATH Requested URL path
  502. # %METHOD Request method
  503. # %MYADDR Squid interface address
  504. # %MYPORT Squid http_port number
  505. # %PATH Requested URL-path (including query-string if any)
  506. # %USER_CERT SSL User certificate in PEM format
  507. # %USER_CERTCHAIN SSL User certificate chain in PEM format
  508. # %USER_CERT_xx SSL User certificate subject attribute xx
  509. # %USER_CA_CERT_xx SSL User certificate issuer attribute xx
  510. # %ssl::>sni SSL client SNI sent to Squid
  511. # %ssl::<cert_subject SSL server certificate DN
  512. # %ssl::<cert_issuer SSL server certificate issuer DN
  513. #
  514. # %>{Header} HTTP request header "Header"
  515. # %>{Hdr:member}
  516. # HTTP request header "Hdr" list member "member"
  517. # %>{Hdr:;member}
  518. # HTTP request header list member using ; as
  519. # list separator. ; can be any non-alphanumeric
  520. # character.
  521. #
  522. # %<{Header} HTTP reply header "Header"
  523. # %<{Hdr:member}
  524. # HTTP reply header "Hdr" list member "member"
  525. # %<{Hdr:;member}
  526. # HTTP reply header list member using ; as
  527. # list separator. ; can be any non-alphanumeric
  528. # character.
  529. #
  530. # %ACL The name of the ACL being tested.
  531. # %DATA The ACL arguments. If not used then any arguments
  532. # is automatically added at the end of the line
  533. # sent to the helper.
  534. # NOTE: this will encode the arguments as one token,
  535. # whereas the default will pass each separately.
  536. #
  537. # %% The percent sign. Useful for helpers which need
  538. # an unchanging input format.
  539. #
  540. #
  541. # General request syntax:
  542. #
  543. # [channel-ID] FORMAT-values [acl-values ...]
  544. #
  545. #
  546. # FORMAT-values consists of transaction details expanded with
  547. # whitespace separation per the config file FORMAT specification
  548. # using the FORMAT macros listed above.
  549. #
  550. # acl-values consists of any string specified in the referencing
  551. # config 'acl ... external' line. see the "acl external" directive.
  552. #
  553. # Request values sent to the helper are URL escaped to protect
  554. # each value in requests against whitespaces.
  555. #
  556. # If using protocol=2.5 then the request sent to the helper is not
  557. # URL escaped to protect against whitespace.
  558. #
  559. # NOTE: protocol=3.0 is deprecated as no longer necessary.
  560. #
  561. # When using the concurrency= option the protocol is changed by
  562. # introducing a query channel tag in front of the request/response.
  563. # The query channel tag is a number between 0 and concurrency-1.
  564. # This value must be echoed back unchanged to Squid as the first part
  565. # of the response relating to its request.
  566. #
  567. #
  568. # The helper receives lines expanded per the above format specification
  569. # and for each input line returns 1 line starting with OK/ERR/BH result
  570. # code and optionally followed by additional keywords with more details.
  571. #
  572. #
  573. # General result syntax:
  574. #
  575. # [channel-ID] result keyword=value ...
  576. #
  577. # Result consists of one of the codes:
  578. #
  579. # OK
  580. # the ACL test produced a match.
  581. #
  582. # ERR
  583. # the ACL test does not produce a match.
  584. #
  585. # BH
  586. # An internal error occurred in the helper, preventing
  587. # a result being identified.
  588. #
  589. # The meaning of 'a match' is determined by your squid.conf
  590. # access control configuration. See the Squid wiki for details.
  591. #
  592. # Defined keywords:
  593. #
  594. # user= The users name (login)
  595. #
  596. # password= The users password (for login= cache_peer option)
  597. #
  598. # message= Message describing the reason for this response.
  599. # Available as %o in error pages.
  600. # Useful on (ERR and BH results).
  601. #
  602. # tag= Apply a tag to a request. Only sets a tag once,
  603. # does not alter existing tags.
  604. #
  605. # log= String to be logged in access.log. Available as
  606. # %ea in logformat specifications.
  607. #
  608. # clt_conn_tag= Associates a TAG with the client TCP connection.
  609. # Please see url_rewrite_program related documentation
  610. # for this kv-pair.
  611. #
  612. # Any keywords may be sent on any response whether OK, ERR or BH.
  613. #
  614. # All response keyword values need to be a single token with URL
  615. # escaping, or enclosed in double quotes (") and escaped using \ on
  616. # any double quotes or \ characters within the value. The wrapping
  617. # double quotes are removed before the value is interpreted by Squid.
  618. # \r and \n are also replace by CR and LF.
  619. #
  620. # Some example key values:
  621. #
  622. # user=John%20Smith
  623. # user="John Smith"
  624. # user="J. \"Bob\" Smith"
  625. #Default:
  626. # none
  627. # TAG: acl
  628. # Defining an Access List
  629. #
  630. # Every access list definition must begin with an aclname and acltype,
  631. # followed by either type-specific arguments or a quoted filename that
  632. # they are read from.
  633. #
  634. # acl aclname acltype argument ...
  635. # acl aclname acltype "file" ...
  636. #
  637. # When using "file", the file should contain one item per line.
  638. #
  639. # Some acl types supports options which changes their default behaviour.
  640. # The available options are:
  641. #
  642. # -i,+i By default, regular expressions are CASE-SENSITIVE. To make them
  643. # case-insensitive, use the -i option. To return case-sensitive
  644. # use the +i option between patterns, or make a new ACL line
  645. # without -i.
  646. #
  647. # -n Disable lookups and address type conversions. If lookup or
  648. # conversion is required because the parameter type (IP or
  649. # domain name) does not match the message address type (domain
  650. # name or IP), then the ACL would immediately declare a mismatch
  651. # without any warnings or lookups.
  652. #
  653. # -- Used to stop processing all options, in the case the first acl
  654. # value has '-' character as first character (for example the '-'
  655. # is a valid domain name)
  656. #
  657. # Some acl types require suspending the current request in order
  658. # to access some external data source.
  659. # Those which do are marked with the tag [slow], those which
  660. # don't are marked as [fast].
  661. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl
  662. # for further information
  663. #
  664. # ***** ACL TYPES AVAILABLE *****
  665. #
  666. # acl aclname src ip-address/mask ... # clients IP address [fast]
  667. # acl aclname src addr1-addr2/mask ... # range of addresses [fast]
  668. # acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow]
  669. # acl aclname localip ip-address/mask ... # IP address the client connected to [fast]
  670. #
  671. # acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
  672. # # [fast]
  673. # # The 'arp' ACL code is not portable to all operating systems.
  674. # # It works on Linux, Solaris, Windows, FreeBSD, and some other
  675. # # BSD variants.
  676. # #
  677. # # NOTE: Squid can only determine the MAC/EUI address for IPv4
  678. # # clients that are on the same subnet. If the client is on a
  679. # # different subnet, then Squid cannot find out its address.
  680. # #
  681. # # NOTE 2: IPv6 protocol does not contain ARP. MAC/EUI is either
  682. # # encoded directly in the IPv6 address or not available.
  683. #
  684. # acl aclname srcdomain .foo.com ...
  685. # # reverse lookup, from client IP [slow]
  686. # acl aclname dstdomain [-n] .foo.com ...
  687. # # Destination server from URL [fast]
  688. # acl aclname srcdom_regex [-i] \.foo\.com ...
  689. # # regex matching client name [slow]
  690. # acl aclname dstdom_regex [-n] [-i] \.foo\.com ...
  691. # # regex matching server [fast]
  692. # #
  693. # # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
  694. # # based URL is used and no match is found. The name "none" is used
  695. # # if the reverse lookup fails.
  696. #
  697. # acl aclname src_as number ...
  698. # acl aclname dst_as number ...
  699. # # [fast]
  700. # # Except for access control, AS numbers can be used for
  701. # # routing of requests to specific caches. Here's an
  702. # # example for routing all requests for AS#1241 and only
  703. # # those to mycache.mydomain.net:
  704. # # acl asexample dst_as 1241
  705. # # cache_peer_access mycache.mydomain.net allow asexample
  706. # # cache_peer_access mycache_mydomain.net deny all
  707. #
  708. # acl aclname peername myPeer ...
  709. # # [fast]
  710. # # match against a named cache_peer entry
  711. # # set unique name= on cache_peer lines for reliable use.
  712. #
  713. # acl aclname time [day-abbrevs] [h1:m1-h2:m2]
  714. # # [fast]
  715. # # day-abbrevs:
  716. # # S - Sunday
  717. # # M - Monday
  718. # # T - Tuesday
  719. # # W - Wednesday
  720. # # H - Thursday
  721. # # F - Friday
  722. # # A - Saturday
  723. # # h1:m1 must be less than h2:m2
  724. #
  725. # acl aclname url_regex [-i] ^http:// ...
  726. # # regex matching on whole URL [fast]
  727. # acl aclname urllogin [-i] [^a-zA-Z0-9] ...
  728. # # regex matching on URL login field
  729. # acl aclname urlpath_regex [-i] \.gif$ ...
  730. # # regex matching on URL path [fast]
  731. #
  732. # acl aclname port 80 70 21 0-1024... # destination TCP port [fast]
  733. # # ranges are alloed
  734. # acl aclname localport 3128 ... # TCP port the client connected to [fast]
  735. # # NP: for interception mode this is usually '80'
  736. #
  737. # acl aclname myportname 3128 ... # *_port name [fast]
  738. #
  739. # acl aclname proto HTTP FTP ... # request protocol [fast]
  740. #
  741. # acl aclname method GET POST ... # HTTP request method [fast]
  742. #
  743. # acl aclname http_status 200 301 500- 400-403 ...
  744. # # status code in reply [fast]
  745. #
  746. # acl aclname browser [-i] regexp ...
  747. # # pattern match on User-Agent header (see also req_header below) [fast]
  748. #
  749. # acl aclname referer_regex [-i] regexp ...
  750. # # pattern match on Referer header [fast]
  751. # # Referer is highly unreliable, so use with care
  752. #
  753. # acl aclname ident username ...
  754. # acl aclname ident_regex [-i] pattern ...
  755. # # string match on ident output [slow]
  756. # # use REQUIRED to accept any non-null ident.
  757. #
  758. # acl aclname proxy_auth [-i] username ...
  759. # acl aclname proxy_auth_regex [-i] pattern ...
  760. # # perform http authentication challenge to the client and match against
  761. # # supplied credentials [slow]
  762. # #
  763. # # takes a list of allowed usernames.
  764. # # use REQUIRED to accept any valid username.
  765. # #
  766. # # Will use proxy authentication in forward-proxy scenarios, and plain
  767. # # http authenticaiton in reverse-proxy scenarios
  768. # #
  769. # # NOTE: when a Proxy-Authentication header is sent but it is not
  770. # # needed during ACL checking the username is NOT logged
  771. # # in access.log.
  772. # #
  773. # # NOTE: proxy_auth requires a EXTERNAL authentication program
  774. # # to check username/password combinations (see
  775. # # auth_param directive).
  776. # #
  777. # # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
  778. # # as the browser needs to be configured for using a proxy in order
  779. # # to respond to proxy authentication.
  780. #
  781. # acl aclname snmp_community string ...
  782. # # A community string to limit access to your SNMP Agent [fast]
  783. # # Example:
  784. # #
  785. # # acl snmppublic snmp_community public
  786. #
  787. # acl aclname maxconn number
  788. # # This will be matched when the client's IP address has
  789. # # more than <number> TCP connections established. [fast]
  790. # # NOTE: This only measures direct TCP links so X-Forwarded-For
  791. # # indirect clients are not counted.
  792. #
  793. # acl aclname max_user_ip [-s] number
  794. # # This will be matched when the user attempts to log in from more
  795. # # than <number> different ip addresses. The authenticate_ip_ttl
  796. # # parameter controls the timeout on the ip entries. [fast]
  797. # # If -s is specified the limit is strict, denying browsing
  798. # # from any further IP addresses until the ttl has expired. Without
  799. # # -s Squid will just annoy the user by "randomly" denying requests.
  800. # # (the counter is reset each time the limit is reached and a
  801. # # request is denied)
  802. # # NOTE: in acceleration mode or where there is mesh of child proxies,
  803. # # clients may appear to come from multiple addresses if they are
  804. # # going through proxy farms, so a limit of 1 may cause user problems.
  805. #
  806. # acl aclname random probability
  807. # # Pseudo-randomly match requests. Based on the probability given.
  808. # # Probability may be written as a decimal (0.333), fraction (1/3)
  809. # # or ratio of matches:non-matches (3:5).
  810. #
  811. # acl aclname req_mime_type [-i] mime-type ...
  812. # # regex match against the mime type of the request generated
  813. # # by the client. Can be used to detect file upload or some
  814. # # types HTTP tunneling requests [fast]
  815. # # NOTE: This does NOT match the reply. You cannot use this
  816. # # to match the returned file type.
  817. #
  818. # acl aclname req_header header-name [-i] any\.regex\.here
  819. # # regex match against any of the known request headers. May be
  820. # # thought of as a superset of "browser", "referer" and "mime-type"
  821. # # ACL [fast]
  822. #
  823. # acl aclname rep_mime_type [-i] mime-type ...
  824. # # regex match against the mime type of the reply received by
  825. # # squid. Can be used to detect file download or some
  826. # # types HTTP tunneling requests. [fast]
  827. # # NOTE: This has no effect in http_access rules. It only has
  828. # # effect in rules that affect the reply data stream such as
  829. # # http_reply_access.
  830. #
  831. # acl aclname rep_header header-name [-i] any\.regex\.here
  832. # # regex match against any of the known reply headers. May be
  833. # # thought of as a superset of "browser", "referer" and "mime-type"
  834. # # ACLs [fast]
  835. #
  836. # acl aclname external class_name [arguments...]
  837. # # external ACL lookup via a helper class defined by the
  838. # # external_acl_type directive [slow]
  839. #
  840. # acl aclname user_cert attribute values...
  841. # # match against attributes in a user SSL certificate
  842. # # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
  843. #
  844. # acl aclname ca_cert attribute values...
  845. # # match against attributes a users issuing CA SSL certificate
  846. # # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
  847. #
  848. # acl aclname ext_user username ...
  849. # acl aclname ext_user_regex [-i] pattern ...
  850. # # string match on username returned by external acl helper [slow]
  851. # # use REQUIRED to accept any non-null user name.
  852. #
  853. # acl aclname tag tagvalue ...
  854. # # string match on tag returned by external acl helper [fast]
  855. # # DEPRECATED. Only the first tag will match with this ACL.
  856. # # Use the 'note' ACL instead for handling multiple tag values.
  857. #
  858. # acl aclname hier_code codename ...
  859. # # string match against squid hierarchy code(s); [fast]
  860. # # e.g., DIRECT, PARENT_HIT, NONE, etc.
  861. # #
  862. # # NOTE: This has no effect in http_access rules. It only has
  863. # # effect in rules that affect the reply data stream such as
  864. # # http_reply_access.
  865. #
  866. # acl aclname note name [value ...]
  867. # # match transaction annotation [fast]
  868. # # Without values, matches any annotation with a given name.
  869. # # With value(s), matches any annotation with a given name that
  870. # # also has one of the given values.
  871. # # Names and values are compared using a string equality test.
  872. # # Annotation sources include note and adaptation_meta directives
  873. # # as well as helper and eCAP responses.
  874. #
  875. # acl aclname adaptation_service service ...
  876. # # Matches the name of any icap_service, ecap_service,
  877. # # adaptation_service_set, or adaptation_service_chain that Squid
  878. # # has used (or attempted to use) for the master transaction.
  879. # # This ACL must be defined after the corresponding adaptation
  880. # # service is named in squid.conf. This ACL is usable with
  881. # # adaptation_meta because it starts matching immediately after
  882. # # the service has been selected for adaptation.
  883. #
  884. # acl aclname any-of acl1 acl2 ...
  885. # # match any one of the acls [fast or slow]
  886. # # The first matching ACL stops further ACL evaluation.
  887. # #
  888. # # ACLs from multiple any-of lines with the same name are ORed.
  889. # # For example, A = (a1 or a2) or (a3 or a4) can be written as
  890. # # acl A any-of a1 a2
  891. # # acl A any-of a3 a4
  892. # #
  893. # # This group ACL is fast if all evaluated ACLs in the group are fast
  894. # # and slow otherwise.
  895. #
  896. # acl aclname all-of acl1 acl2 ...
  897. # # match all of the acls [fast or slow]
  898. # # The first mismatching ACL stops further ACL evaluation.
  899. # #
  900. # # ACLs from multiple all-of lines with the same name are ORed.
  901. # # For example, B = (b1 and b2) or (b3 and b4) can be written as
  902. # # acl B all-of b1 b2
  903. # # acl B all-of b3 b4
  904. # #
  905. # # This group ACL is fast if all evaluated ACLs in the group are fast
  906. # # and slow otherwise.
  907. #
  908. # Examples:
  909. # acl macaddress arp 09:00:2b:23:45:67
  910. # acl myexample dst_as 1241
  911. # acl password proxy_auth REQUIRED
  912. # acl fileupload req_mime_type -i ^multipart/form-data$
  913. # acl javascript rep_mime_type -i ^application/x-javascript$
  914. #
  915. #Default:
  916. # ACLs all, manager, localhost, and to_localhost are predefined.
  917. #
  918. #
  919. # Recommended minimum configuration:
  920. #
  921. # Example rule allowing access from your local networks.
  922. # Adapt to list your (internal) IP networks from where browsing
  923. # should be allowed
  924. #acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
  925. #acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
  926. #acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
  927. #acl localnet src fc00::/7 # RFC 4193 local private network range
  928. #acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines
  929. acl SSL_ports port 443
  930. acl Safe_ports port 80 # http
  931. acl Safe_ports port 21 # ftp
  932. acl Safe_ports port 443 # https
  933. acl Safe_ports port 70 # gopher
  934. acl Safe_ports port 210 # wais
  935. acl Safe_ports port 1025-65535 # unregistered ports
  936. acl Safe_ports port 280 # http-mgmt
  937. acl Safe_ports port 488 # gss-http
  938. acl Safe_ports port 591 # filemaker
  939. acl Safe_ports port 777 # multiling http
  940. acl CONNECT method CONNECT
  941. # TAG: proxy_protocol_access
  942. # Determine which client proxies can be trusted to provide correct
  943. # information regarding real client IP address using PROXY protocol.
  944. #
  945. # Requests may pass through a chain of several other proxies
  946. # before reaching us. The original source details may by sent in:
  947. # * HTTP message Forwarded header, or
  948. # * HTTP message X-Forwarded-For header, or
  949. # * PROXY protocol connection header.
  950. #
  951. # This directive is solely for validating new PROXY protocol
  952. # connections received from a port flagged with require-proxy-header.
  953. # It is checked only once after TCP connection setup.
  954. #
  955. # A deny match results in TCP connection closure.
  956. #
  957. # An allow match is required for Squid to permit the corresponding
  958. # TCP connection, before Squid even looks for HTTP request headers.
  959. # If there is an allow match, Squid starts using PROXY header information
  960. # to determine the source address of the connection for all future ACL
  961. # checks, logging, etc.
  962. #
  963. # SECURITY CONSIDERATIONS:
  964. #
  965. # Any host from which we accept client IP details can place
  966. # incorrect information in the relevant header, and Squid
  967. # will use the incorrect information as if it were the
  968. # source address of the request. This may enable remote
  969. # hosts to bypass any access control restrictions that are
  970. # based on the client's source addresses.
  971. #
  972. # This clause only supports fast acl types.
  973. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  974. #Default:
  975. # all TCP connections to ports with require-proxy-header will be denied
  976. # TAG: follow_x_forwarded_for
  977. # Determine which client proxies can be trusted to provide correct
  978. # information regarding real client IP address.
  979. #
  980. # Requests may pass through a chain of several other proxies
  981. # before reaching us. The original source details may by sent in:
  982. # * HTTP message Forwarded header, or
  983. # * HTTP message X-Forwarded-For header, or
  984. # * PROXY protocol connection header.
  985. #
  986. # PROXY protocol connections are controlled by the proxy_protocol_access
  987. # directive which is checked before this.
  988. #
  989. # If a request reaches us from a source that is allowed by this
  990. # directive, then we trust the information it provides regarding
  991. # the IP of the client it received from (if any).
  992. #
  993. # For the purpose of ACLs used in this directive the src ACL type always
  994. # matches the address we are testing and srcdomain matches its rDNS.
  995. #
  996. # On each HTTP request Squid checks for X-Forwarded-For header fields.
  997. # If found the header values are iterated in reverse order and an allow
  998. # match is required for Squid to continue on to the next value.
  999. # The verification ends when a value receives a deny match, cannot be
  1000. # tested, or there are no more values to test.
  1001. # NOTE: Squid does not yet follow the Forwarded HTTP header.
  1002. #
  1003. # The end result of this process is an IP address that we will
  1004. # refer to as the indirect client address. This address may
  1005. # be treated as the client address for access control, ICAP, delay
  1006. # pools and logging, depending on the acl_uses_indirect_client,
  1007. # icap_uses_indirect_client, delay_pool_uses_indirect_client,
  1008. # log_uses_indirect_client and tproxy_uses_indirect_client options.
  1009. #
  1010. # This clause only supports fast acl types.
  1011. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1012. #
  1013. # SECURITY CONSIDERATIONS:
  1014. #
  1015. # Any host from which we accept client IP details can place
  1016. # incorrect information in the relevant header, and Squid
  1017. # will use the incorrect information as if it were the
  1018. # source address of the request. This may enable remote
  1019. # hosts to bypass any access control restrictions that are
  1020. # based on the client's source addresses.
  1021. #
  1022. # For example:
  1023. #
  1024. # acl localhost src 127.0.0.1
  1025. # acl my_other_proxy srcdomain .proxy.example.com
  1026. # follow_x_forwarded_for allow localhost
  1027. # follow_x_forwarded_for allow my_other_proxy
  1028. #Default:
  1029. # X-Forwarded-For header will be ignored.
  1030. # TAG: acl_uses_indirect_client on|off
  1031. # Controls whether the indirect client address
  1032. # (see follow_x_forwarded_for) is used instead of the
  1033. # direct client address in acl matching.
  1034. #
  1035. # NOTE: maxconn ACL considers direct TCP links and indirect
  1036. # clients will always have zero. So no match.
  1037. #Default:
  1038. # acl_uses_indirect_client on
  1039. # TAG: delay_pool_uses_indirect_client on|off
  1040. # Controls whether the indirect client address
  1041. # (see follow_x_forwarded_for) is used instead of the
  1042. # direct client address in delay pools.
  1043. #Default:
  1044. # delay_pool_uses_indirect_client on
  1045. # TAG: log_uses_indirect_client on|off
  1046. # Controls whether the indirect client address
  1047. # (see follow_x_forwarded_for) is used instead of the
  1048. # direct client address in the access log.
  1049. #Default:
  1050. # log_uses_indirect_client on
  1051. # TAG: tproxy_uses_indirect_client on|off
  1052. # Controls whether the indirect client address
  1053. # (see follow_x_forwarded_for) is used instead of the
  1054. # direct client address when spoofing the outgoing client.
  1055. #
  1056. # This has no effect on requests arriving in non-tproxy
  1057. # mode ports.
  1058. #
  1059. # SECURITY WARNING: Usage of this option is dangerous
  1060. # and should not be used trivially. Correct configuration
  1061. # of follow_x_forwarded_for with a limited set of trusted
  1062. # sources is required to prevent abuse of your proxy.
  1063. #Default:
  1064. # tproxy_uses_indirect_client off
  1065. # TAG: spoof_client_ip
  1066. # Control client IP address spoofing of TPROXY traffic based on
  1067. # defined access lists.
  1068. #
  1069. # spoof_client_ip allow|deny [!]aclname ...
  1070. #
  1071. # If there are no "spoof_client_ip" lines present, the default
  1072. # is to "allow" spoofing of any suitable request.
  1073. #
  1074. # Note that the cache_peer "no-tproxy" option overrides this ACL.
  1075. #
  1076. # This clause supports fast acl types.
  1077. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1078. #Default:
  1079. # Allow spoofing on all TPROXY traffic.
  1080. # TAG: http_access
  1081. # Allowing or Denying access based on defined access lists
  1082. #
  1083. # To allow or deny a message received on an HTTP, HTTPS, or FTP port:
  1084. # http_access allow|deny [!]aclname ...
  1085. #
  1086. # NOTE on default values:
  1087. #
  1088. # If there are no "access" lines present, the default is to deny
  1089. # the request.
  1090. #
  1091. # If none of the "access" lines cause a match, the default is the
  1092. # opposite of the last line in the list. If the last line was
  1093. # deny, the default is allow. Conversely, if the last line
  1094. # is allow, the default will be deny. For these reasons, it is a
  1095. # good idea to have an "deny all" entry at the end of your access
  1096. # lists to avoid potential confusion.
  1097. #
  1098. # This clause supports both fast and slow acl types.
  1099. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1100. #
  1101. #Default:
  1102. # Deny, unless rules exist in squid.conf.
  1103. #
  1104. acl one_network src 192.168.1.0/24
  1105. http_access allow one_network
  1106. #
  1107. # Recommended minimum Access Permission configuration:
  1108. #
  1109. # Deny requests to certain unsafe ports
  1110. http_access deny !Safe_ports
  1111. # Deny CONNECT to other than secure SSL ports
  1112. http_access deny CONNECT !SSL_ports
  1113. # Only allow cachemgr access from localhost
  1114. http_access allow localhost manager
  1115. http_access deny manager
  1116. # We strongly recommend the following be uncommented to protect innocent
  1117. # web applications running on the proxy server who think the only
  1118. # one who can access services on "localhost" is a local user
  1119. #http_access deny to_localhost
  1120. #
  1121. # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
  1122. #
  1123. ## disable ads ( http://pgl.yoyo.org/adservers/ )
  1124. #acl ads dstdom_regex "/etc/squid/ad_block.txt"
  1125. acl fb dstdomain .facebook.com
  1126. acl ads dstdomain parameters("/etc/squid/ad_block.txt")
  1127. http_access deny ads fb
  1128. #deny_info TCP_RESET ads
  1129. # Example rule allowing access from your local networks.
  1130. # Adapt localnet in the ACL section to list your (internal) IP networks
  1131. # from where browsing should be allowed
  1132. #http_access allow localnet
  1133. http_access allow localhost
  1134. # And finally deny all other access to this proxy
  1135. http_access deny all
  1136. #http_access allow all
  1137. # TAG: adapted_http_access
  1138. # Allowing or Denying access based on defined access lists
  1139. #
  1140. # Essentially identical to http_access, but runs after redirectors
  1141. # and ICAP/eCAP adaptation. Allowing access control based on their
  1142. # output.
  1143. #
  1144. # If not set then only http_access is used.
  1145. #Default:
  1146. # Allow, unless rules exist in squid.conf.
  1147. # TAG: http_reply_access
  1148. # Allow replies to client requests. This is complementary to http_access.
  1149. #
  1150. # http_reply_access allow|deny [!] aclname ...
  1151. #
  1152. # NOTE: if there are no access lines present, the default is to allow
  1153. # all replies.
  1154. #
  1155. # If none of the access lines cause a match the opposite of the
  1156. # last line will apply. Thus it is good practice to end the rules
  1157. # with an "allow all" or "deny all" entry.
  1158. #
  1159. # This clause supports both fast and slow acl types.
  1160. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1161. #Default:
  1162. # Allow, unless rules exist in squid.conf.
  1163. # TAG: icp_access
  1164. # Allowing or Denying access to the ICP port based on defined
  1165. # access lists
  1166. #
  1167. # icp_access allow|deny [!]aclname ...
  1168. #
  1169. # NOTE: The default if no icp_access lines are present is to
  1170. # deny all traffic. This default may cause problems with peers
  1171. # using ICP.
  1172. #
  1173. # This clause only supports fast acl types.
  1174. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1175. #
  1176. ## Allow ICP queries from local networks only
  1177. ##icp_access allow localnet
  1178. ##icp_access deny all
  1179. #Default:
  1180. # Deny, unless rules exist in squid.conf.
  1181. # TAG: htcp_access
  1182. # Allowing or Denying access to the HTCP port based on defined
  1183. # access lists
  1184. #
  1185. # htcp_access allow|deny [!]aclname ...
  1186. #
  1187. # See also htcp_clr_access for details on access control for
  1188. # cache purge (CLR) HTCP messages.
  1189. #
  1190. # NOTE: The default if no htcp_access lines are present is to
  1191. # deny all traffic. This default may cause problems with peers
  1192. # using the htcp option.
  1193. #
  1194. # This clause only supports fast acl types.
  1195. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1196. #
  1197. ## Allow HTCP queries from local networks only
  1198. ##htcp_access allow localnet
  1199. ##htcp_access deny all
  1200. #Default:
  1201. # Deny, unless rules exist in squid.conf.
  1202. # TAG: htcp_clr_access
  1203. # Allowing or Denying access to purge content using HTCP based
  1204. # on defined access lists.
  1205. # See htcp_access for details on general HTCP access control.
  1206. #
  1207. # htcp_clr_access allow|deny [!]aclname ...
  1208. #
  1209. # This clause only supports fast acl types.
  1210. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1211. #
  1212. ## Allow HTCP CLR requests from trusted peers
  1213. #acl htcp_clr_peer src 192.0.2.2 2001:DB8::2
  1214. #htcp_clr_access allow htcp_clr_peer
  1215. #htcp_clr_access deny all
  1216. #Default:
  1217. # Deny, unless rules exist in squid.conf.
  1218. # TAG: miss_access
  1219. # Determines whether network access is permitted when satisfying a request.
  1220. #
  1221. # For example;
  1222. # to force your neighbors to use you as a sibling instead of
  1223. # a parent.
  1224. #
  1225. # acl localclients src 192.0.2.0/24 2001:DB8::a:0/64
  1226. # miss_access deny !localclients
  1227. # miss_access allow all
  1228. #
  1229. # This means only your local clients are allowed to fetch relayed/MISS
  1230. # replies from the network and all other clients can only fetch cached
  1231. # objects (HITs).
  1232. #
  1233. # The default for this setting allows all clients who passed the
  1234. # http_access rules to relay via this proxy.
  1235. #
  1236. # This clause only supports fast acl types.
  1237. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1238. #Default:
  1239. # Allow, unless rules exist in squid.conf.
  1240. # TAG: ident_lookup_access
  1241. # A list of ACL elements which, if matched, cause an ident
  1242. # (RFC 931) lookup to be performed for this request. For
  1243. # example, you might choose to always perform ident lookups
  1244. # for your main multi-user Unix boxes, but not for your Macs
  1245. # and PCs. By default, ident lookups are not performed for
  1246. # any requests.
  1247. #
  1248. # To enable ident lookups for specific client addresses, you
  1249. # can follow this example:
  1250. #
  1251. # acl ident_aware_hosts src 198.168.1.0/24
  1252. # ident_lookup_access allow ident_aware_hosts
  1253. # ident_lookup_access deny all
  1254. #
  1255. # Only src type ACL checks are fully supported. A srcdomain
  1256. # ACL might work at times, but it will not always provide
  1257. # the correct result.
  1258. #
  1259. # This clause only supports fast acl types.
  1260. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1261. #Default:
  1262. # Unless rules exist in squid.conf, IDENT is not fetched.
  1263. # TAG: reply_body_max_size size [acl acl...]
  1264. # This option specifies the maximum size of a reply body. It can be
  1265. # used to prevent users from downloading very large files, such as
  1266. # MP3's and movies. When the reply headers are received, the
  1267. # reply_body_max_size lines are processed, and the first line where
  1268. # all (if any) listed ACLs are true is used as the maximum body size
  1269. # for this reply.
  1270. #
  1271. # This size is checked twice. First when we get the reply headers,
  1272. # we check the content-length value. If the content length value exists
  1273. # and is larger than the allowed size, the request is denied and the
  1274. # user receives an error message that says "the request or reply
  1275. # is too large." If there is no content-length, and the reply
  1276. # size exceeds this limit, the client's connection is just closed
  1277. # and they will receive a partial reply.
  1278. #
  1279. # WARNING: downstream caches probably can not detect a partial reply
  1280. # if there is no content-length header, so they will cache
  1281. # partial responses and give them out as hits. You should NOT
  1282. # use this option if you have downstream caches.
  1283. #
  1284. # WARNING: A maximum size smaller than the size of squid's error messages
  1285. # will cause an infinite loop and crash squid. Ensure that the smallest
  1286. # non-zero value you use is greater that the maximum header size plus
  1287. # the size of your largest error page.
  1288. #
  1289. # If you set this parameter none (the default), there will be
  1290. # no limit imposed.
  1291. #
  1292. # Configuration Format is:
  1293. # reply_body_max_size SIZE UNITS [acl ...]
  1294. # ie.
  1295. # reply_body_max_size 10 MB
  1296. #
  1297. #Default:
  1298. # No limit is applied.
  1299. # NETWORK OPTIONS
  1300. # -----------------------------------------------------------------------------
  1301. # TAG: http_port
  1302. # Usage: port [mode] [options]
  1303. # hostname:port [mode] [options]
  1304. # 1.2.3.4:port [mode] [options]
  1305. #
  1306. # The socket addresses where Squid will listen for HTTP client
  1307. # requests. You may specify multiple socket addresses.
  1308. # There are three forms: port alone, hostname with port, and
  1309. # IP address with port. If you specify a hostname or IP
  1310. # address, Squid binds the socket to that specific
  1311. # address. Most likely, you do not need to bind to a specific
  1312. # address, so you can use the port number alone.
  1313. #
  1314. # If you are running Squid in accelerator mode, you
  1315. # probably want to listen on port 80 also, or instead.
  1316. #
  1317. # The -a command line option may be used to specify additional
  1318. # port(s) where Squid listens for proxy request. Such ports will
  1319. # be plain proxy ports with no options.
  1320. #
  1321. # You may specify multiple socket addresses on multiple lines.
  1322. #
  1323. # Modes:
  1324. #
  1325. # intercept Support for IP-Layer NAT interception delivering
  1326. # traffic to this Squid port.
  1327. # NP: disables authentication on the port.
  1328. #
  1329. # tproxy Support Linux TPROXY (or BSD divert-to) with spoofing
  1330. # of outgoing connections using the client IP address.
  1331. # NP: disables authentication on the port.
  1332. #
  1333. # accel Accelerator / reverse proxy mode
  1334. #
  1335. # ssl-bump For each CONNECT request allowed by ssl_bump ACLs,
  1336. # establish secure connection with the client and with
  1337. # the server, decrypt HTTPS messages as they pass through
  1338. # Squid, and treat them as unencrypted HTTP messages,
  1339. # becoming the man-in-the-middle.
  1340. #
  1341. # The ssl_bump option is required to fully enable
  1342. # bumping of CONNECT requests.
  1343. #
  1344. # Omitting the mode flag causes default forward proxy mode to be used.
  1345. #
  1346. #
  1347. # Accelerator Mode Options:
  1348. #
  1349. # defaultsite=domainname
  1350. # What to use for the Host: header if it is not present
  1351. # in a request. Determines what site (not origin server)
  1352. # accelerators should consider the default.
  1353. #
  1354. # no-vhost Disable using HTTP/1.1 Host header for virtual domain support.
  1355. #
  1356. # protocol= Protocol to reconstruct accelerated and intercepted
  1357. # requests with. Defaults to HTTP/1.1 for http_port and
  1358. # HTTPS/1.1 for https_port.
  1359. # When an unsupported value is configured Squid will
  1360. # produce a FATAL error.
  1361. # Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1
  1362. #
  1363. # vport Virtual host port support. Using the http_port number
  1364. # instead of the port passed on Host: headers.
  1365. #
  1366. # vport=NN Virtual host port support. Using the specified port
  1367. # number instead of the port passed on Host: headers.
  1368. #
  1369. # act-as-origin
  1370. # Act as if this Squid is the origin server.
  1371. # This currently means generate new Date: and Expires:
  1372. # headers on HIT instead of adding Age:.
  1373. #
  1374. # ignore-cc Ignore request Cache-Control headers.
  1375. #
  1376. # WARNING: This option violates HTTP specifications if
  1377. # used in non-accelerator setups.
  1378. #
  1379. # allow-direct Allow direct forwarding in accelerator mode. Normally
  1380. # accelerated requests are denied direct forwarding as if
  1381. # never_direct was used.
  1382. #
  1383. # WARNING: this option opens accelerator mode to security
  1384. # vulnerabilities usually only affecting in interception
  1385. # mode. Make sure to protect forwarding with suitable
  1386. # http_access rules when using this.
  1387. #
  1388. #
  1389. # SSL Bump Mode Options:
  1390. # In addition to these options ssl-bump requires TLS/SSL options.
  1391. #
  1392. # generate-host-certificates[=<on|off>]
  1393. # Dynamically create SSL server certificates for the
  1394. # destination hosts of bumped CONNECT requests.When
  1395. # enabled, the cert and key options are used to sign
  1396. # generated certificates. Otherwise generated
  1397. # certificate will be selfsigned.
  1398. # If there is a CA certificate lifetime of the generated
  1399. # certificate equals lifetime of the CA certificate. If
  1400. # generated certificate is selfsigned lifetime is three
  1401. # years.
  1402. # This option is enabled by default when ssl-bump is used.
  1403. # See the ssl-bump option above for more information.
  1404. #
  1405. # dynamic_cert_mem_cache_size=SIZE
  1406. # Approximate total RAM size spent on cached generated
  1407. # certificates. If set to zero, caching is disabled. The
  1408. # default value is 4MB.
  1409. #
  1410. # TLS / SSL Options:
  1411. #
  1412. # cert= Path to SSL certificate (PEM format).
  1413. #
  1414. # key= Path to SSL private key file (PEM format)
  1415. # if not specified, the certificate file is
  1416. # assumed to be a combined certificate and
  1417. # key file.
  1418. #
  1419. # version= The version of SSL/TLS supported
  1420. # 1 automatic (default)
  1421. # 2 SSLv2 only
  1422. # 3 SSLv3 only
  1423. # 4 TLSv1.0 only
  1424. # 5 TLSv1.1 only
  1425. # 6 TLSv1.2 only
  1426. #
  1427. # cipher= Colon separated list of supported ciphers.
  1428. # NOTE: some ciphers such as EDH ciphers depend on
  1429. # additional settings. If those settings are
  1430. # omitted the ciphers may be silently ignored
  1431. # by the OpenSSL library.
  1432. #
  1433. # options= Various SSL implementation options. The most important
  1434. # being:
  1435. # NO_SSLv2 Disallow the use of SSLv2
  1436. # NO_SSLv3 Disallow the use of SSLv3
  1437. # NO_TLSv1 Disallow the use of TLSv1.0
  1438. # NO_TLSv1_1 Disallow the use of TLSv1.1
  1439. # NO_TLSv1_2 Disallow the use of TLSv1.2
  1440. # SINGLE_DH_USE Always create a new key when using
  1441. # temporary/ephemeral DH key exchanges
  1442. # NO_TICKET Disables TLS tickets extension
  1443. # ALL Enable various bug workarounds
  1444. # suggested as "harmless" by OpenSSL
  1445. # Be warned that this reduces SSL/TLS
  1446. # strength to some attacks.
  1447. # See OpenSSL SSL_CTX_set_options documentation for a
  1448. # complete list of options.
  1449. #
  1450. # clientca= File containing the list of CAs to use when
  1451. # requesting a client certificate.
  1452. #
  1453. # cafile= File containing additional CA certificates to
  1454. # use when verifying client certificates. If unset
  1455. # clientca will be used.
  1456. #
  1457. # capath= Directory containing additional CA certificates
  1458. # and CRL lists to use when verifying client certificates.
  1459. #
  1460. # crlfile= File of additional CRL lists to use when verifying
  1461. # the client certificate, in addition to CRLs stored in
  1462. # the capath. Implies VERIFY_CRL flag below.
  1463. #
  1464. # dhparams= File containing DH parameters for temporary/ephemeral
  1465. # DH key exchanges. See OpenSSL documentation for details
  1466. # on how to create this file.
  1467. # WARNING: EDH ciphers will be silently disabled if this
  1468. # option is not set.
  1469. #
  1470. # sslflags= Various flags modifying the use of SSL:
  1471. # DELAYED_AUTH
  1472. # Don't request client certificates
  1473. # immediately, but wait until acl processing
  1474. # requires a certificate (not yet implemented).
  1475. # NO_DEFAULT_CA
  1476. # Don't use the default CA lists built in
  1477. # to OpenSSL.
  1478. # NO_SESSION_REUSE
  1479. # Don't allow for session reuse. Each connection
  1480. # will result in a new SSL session.
  1481. # VERIFY_CRL
  1482. # Verify CRL lists when accepting client
  1483. # certificates.
  1484. # VERIFY_CRL_ALL
  1485. # Verify CRL lists for all certificates in the
  1486. # client certificate chain.
  1487. #
  1488. # sslcontext= SSL session ID context identifier.
  1489. #
  1490. # Other Options:
  1491. #
  1492. # connection-auth[=on|off]
  1493. # use connection-auth=off to tell Squid to prevent
  1494. # forwarding Microsoft connection oriented authentication
  1495. # (NTLM, Negotiate and Kerberos)
  1496. #
  1497. # disable-pmtu-discovery=
  1498. # Control Path-MTU discovery usage:
  1499. # off lets OS decide on what to do (default).
  1500. # transparent disable PMTU discovery when transparent
  1501. # support is enabled.
  1502. # always disable always PMTU discovery.
  1503. #
  1504. # In many setups of transparently intercepting proxies
  1505. # Path-MTU discovery can not work on traffic towards the
  1506. # clients. This is the case when the intercepting device
  1507. # does not fully track connections and fails to forward
  1508. # ICMP must fragment messages to the cache server. If you
  1509. # have such setup and experience that certain clients
  1510. # sporadically hang or never complete requests set
  1511. # disable-pmtu-discovery option to 'transparent'.
  1512. #
  1513. # name= Specifies a internal name for the port. Defaults to
  1514. # the port specification (port or addr:port)
  1515. #
  1516. # tcpkeepalive[=idle,interval,timeout]
  1517. # Enable TCP keepalive probes of idle connections.
  1518. # In seconds; idle is the initial time before TCP starts
  1519. # probing the connection, interval how often to probe, and
  1520. # timeout the time before giving up.
  1521. #
  1522. # require-proxy-header
  1523. # Require PROXY protocol version 1 or 2 connections.
  1524. # The proxy_protocol_access is required to whitelist
  1525. # downstream proxies which can be trusted.
  1526. #
  1527. # If you run Squid on a dual-homed machine with an internal
  1528. # and an external interface we recommend you to specify the
  1529. # internal address:port in http_port. This way Squid will only be
  1530. # visible on the internal address.
  1531. #
  1532. #
  1533. # Squid normally listens to port 3128
  1534. http_port 3128
  1535. # TAG: https_port
  1536. # Note: This option is only available if Squid is rebuilt with the
  1537. # --with-openssl
  1538. #
  1539. # Usage: [ip:]port cert=certificate.pem [key=key.pem] [mode] [options...]
  1540. #
  1541. # The socket address where Squid will listen for client requests made
  1542. # over TLS or SSL connections. Commonly referred to as HTTPS.
  1543. #
  1544. # This is most useful for situations where you are running squid in
  1545. # accelerator mode and you want to do the SSL work at the accelerator level.
  1546. #
  1547. # You may specify multiple socket addresses on multiple lines,
  1548. # each with their own SSL certificate and/or options.
  1549. #
  1550. # Modes:
  1551. #
  1552. # accel Accelerator / reverse proxy mode
  1553. #
  1554. # intercept Support for IP-Layer interception of
  1555. # outgoing requests without browser settings.
  1556. # NP: disables authentication and IPv6 on the port.
  1557. #
  1558. # tproxy Support Linux TPROXY for spoofing outgoing
  1559. # connections using the client IP address.
  1560. # NP: disables authentication and maybe IPv6 on the port.
  1561. #
  1562. # ssl-bump For each intercepted connection allowed by ssl_bump
  1563. # ACLs, establish a secure connection with the client and with
  1564. # the server, decrypt HTTPS messages as they pass through
  1565. # Squid, and treat them as unencrypted HTTP messages,
  1566. # becoming the man-in-the-middle.
  1567. #
  1568. # An "ssl_bump server-first" match is required to
  1569. # fully enable bumping of intercepted SSL connections.
  1570. #
  1571. # Requires tproxy or intercept.
  1572. #
  1573. # Omitting the mode flag causes default forward proxy mode to be used.
  1574. #
  1575. #
  1576. # See http_port for a list of generic options
  1577. #
  1578. #
  1579. # SSL Options:
  1580. #
  1581. # cert= Path to SSL certificate (PEM format).
  1582. #
  1583. # key= Path to SSL private key file (PEM format)
  1584. # if not specified, the certificate file is
  1585. # assumed to be a combined certificate and
  1586. # key file.
  1587. #
  1588. # version= The version of SSL/TLS supported
  1589. # 1 automatic (default)
  1590. # 2 SSLv2 only
  1591. # 3 SSLv3 only
  1592. # 4 TLSv1 only
  1593. #
  1594. # cipher= Colon separated list of supported ciphers.
  1595. #
  1596. # options= Various SSL engine options. The most important
  1597. # being:
  1598. # NO_SSLv2 Disallow the use of SSLv2
  1599. # NO_SSLv3 Disallow the use of SSLv3
  1600. # NO_TLSv1 Disallow the use of TLSv1
  1601. # SINGLE_DH_USE Always create a new key when using
  1602. # temporary/ephemeral DH key exchanges
  1603. # See src/ssl_support.c or OpenSSL SSL_CTX_set_options
  1604. # documentation for a complete list of options.
  1605. #
  1606. # clientca= File containing the list of CAs to use when
  1607. # requesting a client certificate.
  1608. #
  1609. # cafile= File containing additional CA certificates to
  1610. # use when verifying client certificates. If unset
  1611. # clientca will be used.
  1612. #
  1613. # capath= Directory containing additional CA certificates
  1614. # and CRL lists to use when verifying client certificates.
  1615. #
  1616. # crlfile= File of additional CRL lists to use when verifying
  1617. # the client certificate, in addition to CRLs stored in
  1618. # the capath. Implies VERIFY_CRL flag below.
  1619. #
  1620. # dhparams= File containing DH parameters for temporary/ephemeral
  1621. # DH key exchanges.
  1622. #
  1623. # sslflags= Various flags modifying the use of SSL:
  1624. # DELAYED_AUTH
  1625. # Don't request client certificates
  1626. # immediately, but wait until acl processing
  1627. # requires a certificate (not yet implemented).
  1628. # NO_DEFAULT_CA
  1629. # Don't use the default CA lists built in
  1630. # to OpenSSL.
  1631. # NO_SESSION_REUSE
  1632. # Don't allow for session reuse. Each connection
  1633. # will result in a new SSL session.
  1634. # VERIFY_CRL
  1635. # Verify CRL lists when accepting client
  1636. # certificates.
  1637. # VERIFY_CRL_ALL
  1638. # Verify CRL lists for all certificates in the
  1639. # client certificate chain.
  1640. #
  1641. # sslcontext= SSL session ID context identifier.
  1642. #
  1643. # generate-host-certificates[=<on|off>]
  1644. # Dynamically create SSL server certificates for the
  1645. # destination hosts of bumped SSL requests.When
  1646. # enabled, the cert and key options are used to sign
  1647. # generated certificates. Otherwise generated
  1648. # certificate will be selfsigned.
  1649. # If there is CA certificate life time of generated
  1650. # certificate equals lifetime of CA certificate. If
  1651. # generated certificate is selfsigned lifetime is three
  1652. # years.
  1653. # This option is enabled by default when SslBump is used.
  1654. # See the sslBump option above for more information.
  1655. #
  1656. # dynamic_cert_mem_cache_size=SIZE
  1657. # Approximate total RAM size spent on cached generated
  1658. # certificates. If set to zero, caching is disabled. The
  1659. # default value is 4MB.
  1660. #
  1661. # See http_port for a list of available options.
  1662. #Default:
  1663. # none
  1664. # TAG: ftp_port
  1665. # Enables Native FTP proxy by specifying the socket address where Squid
  1666. # listens for FTP client requests. See http_port directive for various
  1667. # ways to specify the listening address and mode.
  1668. #
  1669. # Usage: ftp_port address [mode] [options]
  1670. #
  1671. # WARNING: This is a new, experimental, complex feature that has seen
  1672. # limited production exposure. Some Squid modules (e.g., caching) do not
  1673. # currently work with native FTP proxying, and many features have not
  1674. # even been tested for compatibility. Test well before deploying!
  1675. #
  1676. # Native FTP proxying differs substantially from proxying HTTP requests
  1677. # with ftp:// URIs because Squid works as an FTP server and receives
  1678. # actual FTP commands (rather than HTTP requests with FTP URLs).
  1679. #
  1680. # Native FTP commands accepted at ftp_port are internally converted or
  1681. # wrapped into HTTP-like messages. The same happens to Native FTP
  1682. # responses received from FTP origin servers. Those HTTP-like messages
  1683. # are shoveled through regular access control and adaptation layers
  1684. # between the FTP client and the FTP origin server. This allows Squid to
  1685. # examine, adapt, block, and log FTP exchanges. Squid reuses most HTTP
  1686. # mechanisms when shoveling wrapped FTP messages. For example,
  1687. # http_access and adaptation_access directives are used.
  1688. #
  1689. # Modes:
  1690. #
  1691. # intercept Same as http_port intercept. The FTP origin address is
  1692. # determined based on the intended destination of the
  1693. # intercepted connection.
  1694. #
  1695. # tproxy Support Linux TPROXY for spoofing outgoing
  1696. # connections using the client IP address.
  1697. # NP: disables authentication and maybe IPv6 on the port.
  1698. #
  1699. # By default (i.e., without an explicit mode option), Squid extracts the
  1700. # FTP origin address from the login@origin parameter of the FTP USER
  1701. # command. Many popular FTP clients support such native FTP proxying.
  1702. #
  1703. # Options:
  1704. #
  1705. # name=token Specifies an internal name for the port. Defaults to
  1706. # the port address. Usable with myportname ACL.
  1707. #
  1708. # ftp-track-dirs
  1709. # Enables tracking of FTP directories by injecting extra
  1710. # PWD commands and adjusting Request-URI (in wrapping
  1711. # HTTP requests) to reflect the current FTP server
  1712. # directory. Tracking is disabled by default.
  1713. #
  1714. # protocol=FTP Protocol to reconstruct accelerated and intercepted
  1715. # requests with. Defaults to FTP. No other accepted
  1716. # values have been tested with. An unsupported value
  1717. # results in a FATAL error. Accepted values are FTP,
  1718. # HTTP (or HTTP/1.1), and HTTPS (or HTTPS/1.1).
  1719. #
  1720. # Other http_port modes and options that are not specific to HTTP and
  1721. # HTTPS may also work.
  1722. #Default:
  1723. # none
  1724. # TAG: tcp_outgoing_tos
  1725. # Allows you to select a TOS/Diffserv value for packets outgoing
  1726. # on the server side, based on an ACL.
  1727. #
  1728. # tcp_outgoing_tos ds-field [!]aclname ...
  1729. #
  1730. # Example where normal_service_net uses the TOS value 0x00
  1731. # and good_service_net uses 0x20
  1732. #
  1733. # acl normal_service_net src 10.0.0.0/24
  1734. # acl good_service_net src 10.0.1.0/24
  1735. # tcp_outgoing_tos 0x00 normal_service_net
  1736. # tcp_outgoing_tos 0x20 good_service_net
  1737. #
  1738. # TOS/DSCP values really only have local significance - so you should
  1739. # know what you're specifying. For more information, see RFC2474,
  1740. # RFC2475, and RFC3260.
  1741. #
  1742. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
  1743. # "default" to use whatever default your host has.
  1744. # Note that only multiples of 4 are usable as the two rightmost bits have
  1745. # been redefined for use by ECN (RFC 3168 section 23.1).
  1746. # The squid parser will enforce this by masking away the ECN bits.
  1747. #
  1748. # Processing proceeds in the order specified, and stops at first fully
  1749. # matching line.
  1750. #
  1751. # Only fast ACLs are supported.
  1752. #Default:
  1753. # none
  1754. # TAG: clientside_tos
  1755. # Allows you to select a TOS/DSCP value for packets being transmitted
  1756. # on the client-side, based on an ACL.
  1757. #
  1758. # clientside_tos ds-field [!]aclname ...
  1759. #
  1760. # Example where normal_service_net uses the TOS value 0x00
  1761. # and good_service_net uses 0x20
  1762. #
  1763. # acl normal_service_net src 10.0.0.0/24
  1764. # acl good_service_net src 10.0.1.0/24
  1765. # clientside_tos 0x00 normal_service_net
  1766. # clientside_tos 0x20 good_service_net
  1767. #
  1768. # Note: This feature is incompatible with qos_flows. Any TOS values set here
  1769. # will be overwritten by TOS values in qos_flows.
  1770. #
  1771. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
  1772. # "default" to use whatever default your host has.
  1773. # Note that only multiples of 4 are usable as the two rightmost bits have
  1774. # been redefined for use by ECN (RFC 3168 section 23.1).
  1775. # The squid parser will enforce this by masking away the ECN bits.
  1776. #
  1777. #Default:
  1778. # none
  1779. # TAG: tcp_outgoing_mark
  1780. # Note: This option is only available if Squid is rebuilt with the
  1781. # Packet MARK (Linux)
  1782. #
  1783. # Allows you to apply a Netfilter mark value to outgoing packets
  1784. # on the server side, based on an ACL.
  1785. #
  1786. # tcp_outgoing_mark mark-value [!]aclname ...
  1787. #
  1788. # Example where normal_service_net uses the mark value 0x00
  1789. # and good_service_net uses 0x20
  1790. #
  1791. # acl normal_service_net src 10.0.0.0/24
  1792. # acl good_service_net src 10.0.1.0/24
  1793. # tcp_outgoing_mark 0x00 normal_service_net
  1794. # tcp_outgoing_mark 0x20 good_service_net
  1795. #
  1796. # Only fast ACLs are supported.
  1797. #Default:
  1798. # none
  1799. # TAG: clientside_mark
  1800. # Note: This option is only available if Squid is rebuilt with the
  1801. # Packet MARK (Linux)
  1802. #
  1803. # Allows you to apply a Netfilter mark value to packets being transmitted
  1804. # on the client-side, based on an ACL.
  1805. #
  1806. # clientside_mark mark-value [!]aclname ...
  1807. #
  1808. # Example where normal_service_net uses the mark value 0x00
  1809. # and good_service_net uses 0x20
  1810. #
  1811. # acl normal_service_net src 10.0.0.0/24
  1812. # acl good_service_net src 10.0.1.0/24
  1813. # clientside_mark 0x00 normal_service_net
  1814. # clientside_mark 0x20 good_service_net
  1815. #
  1816. # Note: This feature is incompatible with qos_flows. Any mark values set here
  1817. # will be overwritten by mark values in qos_flows.
  1818. #Default:
  1819. # none
  1820. # TAG: qos_flows
  1821. # Allows you to select a TOS/DSCP value to mark outgoing
  1822. # connections to the client, based on where the reply was sourced.
  1823. # For platforms using netfilter, allows you to set a netfilter mark
  1824. # value instead of, or in addition to, a TOS value.
  1825. #
  1826. # By default this functionality is disabled. To enable it with the default
  1827. # settings simply use "qos_flows mark" or "qos_flows tos". Default
  1828. # settings will result in the netfilter mark or TOS value being copied
  1829. # from the upstream connection to the client. Note that it is the connection
  1830. # CONNMARK value not the packet MARK value that is copied.
  1831. #
  1832. # It is not currently possible to copy the mark or TOS value from the
  1833. # client to the upstream connection request.
  1834. #
  1835. # TOS values really only have local significance - so you should
  1836. # know what you're specifying. For more information, see RFC2474,
  1837. # RFC2475, and RFC3260.
  1838. #
  1839. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255.
  1840. # Note that only multiples of 4 are usable as the two rightmost bits have
  1841. # been redefined for use by ECN (RFC 3168 section 23.1).
  1842. # The squid parser will enforce this by masking away the ECN bits.
  1843. #
  1844. # Mark values can be any unsigned 32-bit integer value.
  1845. #
  1846. # This setting is configured by setting the following values:
  1847. #
  1848. # tos|mark Whether to set TOS or netfilter mark values
  1849. #
  1850. # local-hit=0xFF Value to mark local cache hits.
  1851. #
  1852. # sibling-hit=0xFF Value to mark hits from sibling peers.
  1853. #
  1854. # parent-hit=0xFF Value to mark hits from parent peers.
  1855. #
  1856. # miss=0xFF[/mask] Value to mark cache misses. Takes precedence
  1857. # over the preserve-miss feature (see below), unless
  1858. # mask is specified, in which case only the bits
  1859. # specified in the mask are written.
  1860. #
  1861. # The TOS variant of the following features are only possible on Linux
  1862. # and require your kernel to be patched with the TOS preserving ZPH
  1863. # patch, available from http://zph.bratcheda.org
  1864. # No patch is needed to preserve the netfilter mark, which will work
  1865. # with all variants of netfilter.
  1866. #
  1867. # disable-preserve-miss
  1868. # This option disables the preservation of the TOS or netfilter
  1869. # mark. By default, the existing TOS or netfilter mark value of
  1870. # the response coming from the remote server will be retained
  1871. # and masked with miss-mark.
  1872. # NOTE: in the case of a netfilter mark, the mark must be set on
  1873. # the connection (using the CONNMARK target) not on the packet
  1874. # (MARK target).
  1875. #
  1876. # miss-mask=0xFF
  1877. # Allows you to mask certain bits in the TOS or mark value
  1878. # received from the remote server, before copying the value to
  1879. # the TOS sent towards clients.
  1880. # Default for tos: 0xFF (TOS from server is not changed).
  1881. # Default for mark: 0xFFFFFFFF (mark from server is not changed).
  1882. #
  1883. # All of these features require the --enable-zph-qos compilation flag
  1884. # (enabled by default). Netfilter marking also requires the
  1885. # libnetfilter_conntrack libraries (--with-netfilter-conntrack) and
  1886. # libcap 2.09+ (--with-libcap).
  1887. #
  1888. #Default:
  1889. # none
  1890. # TAG: tcp_outgoing_address
  1891. # Allows you to map requests to different outgoing IP addresses
  1892. # based on the username or source address of the user making
  1893. # the request.
  1894. #
  1895. # tcp_outgoing_address ipaddr [[!]aclname] ...
  1896. #
  1897. # For example;
  1898. # Forwarding clients with dedicated IPs for certain subnets.
  1899. #
  1900. # acl normal_service_net src 10.0.0.0/24
  1901. # acl good_service_net src 10.0.2.0/24
  1902. #
  1903. # tcp_outgoing_address 2001:db8::c001 good_service_net
  1904. # tcp_outgoing_address 10.1.0.2 good_service_net
  1905. #
  1906. # tcp_outgoing_address 2001:db8::beef normal_service_net
  1907. # tcp_outgoing_address 10.1.0.1 normal_service_net
  1908. #
  1909. # tcp_outgoing_address 2001:db8::1
  1910. # tcp_outgoing_address 10.1.0.3
  1911. #
  1912. # Processing proceeds in the order specified, and stops at first fully
  1913. # matching line.
  1914. #
  1915. # Squid will add an implicit IP version test to each line.
  1916. # Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses.
  1917. # Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses.
  1918. #
  1919. #
  1920. # NOTE: The use of this directive using client dependent ACLs is
  1921. # incompatible with the use of server side persistent connections. To
  1922. # ensure correct results it is best to set server_persistent_connections
  1923. # to off when using this directive in such configurations.
  1924. #
  1925. # NOTE: The use of this directive to set a local IP on outgoing TCP links
  1926. # is incompatible with using TPROXY to set client IP out outbound TCP links.
  1927. # When needing to contact peers use the no-tproxy cache_peer option and the
  1928. # client_dst_passthru directive re-enable normal forwarding such as this.
  1929. #
  1930. #Default:
  1931. # Address selection is performed by the operating system.
  1932. # TAG: host_verify_strict
  1933. # Regardless of this option setting, when dealing with intercepted
  1934. # traffic, Squid always verifies that the destination IP address matches
  1935. # the Host header domain or IP (called 'authority form URL').
  1936. #
  1937. # This enforcement is performed to satisfy a MUST-level requirement in
  1938. # RFC 2616 section 14.23: "The Host field value MUST represent the naming
  1939. # authority of the origin server or gateway given by the original URL".
  1940. #
  1941. # When set to ON:
  1942. # Squid always responds with an HTTP 409 (Conflict) error
  1943. # page and logs a security warning if there is no match.
  1944. #
  1945. # Squid verifies that the destination IP address matches
  1946. # the Host header for forward-proxy and reverse-proxy traffic
  1947. # as well. For those traffic types, Squid also enables the
  1948. # following checks, comparing the corresponding Host header
  1949. # and Request-URI components:
  1950. #
  1951. # * The host names (domain or IP) must be identical,
  1952. # but valueless or missing Host header disables all checks.
  1953. # For the two host names to match, both must be either IP
  1954. # or FQDN.
  1955. #
  1956. # * Port numbers must be identical, but if a port is missing
  1957. # the scheme-default port is assumed.
  1958. #
  1959. #
  1960. # When set to OFF (the default):
  1961. # Squid allows suspicious requests to continue but logs a
  1962. # security warning and blocks caching of the response.
  1963. #
  1964. # * Forward-proxy traffic is not checked at all.
  1965. #
  1966. # * Reverse-proxy traffic is not checked at all.
  1967. #
  1968. # * Intercepted traffic which passes verification is handled
  1969. # according to client_dst_passthru.
  1970. #
  1971. # * Intercepted requests which fail verification are sent
  1972. # to the client original destination instead of DIRECT.
  1973. # This overrides 'client_dst_passthru off'.
  1974. #
  1975. # For now suspicious intercepted CONNECT requests are always
  1976. # responded to with an HTTP 409 (Conflict) error page.
  1977. #
  1978. #
  1979. # SECURITY NOTE:
  1980. #
  1981. # As described in CVE-2009-0801 when the Host: header alone is used
  1982. # to determine the destination of a request it becomes trivial for
  1983. # malicious scripts on remote websites to bypass browser same-origin
  1984. # security policy and sandboxing protections.
  1985. #
  1986. # The cause of this is that such applets are allowed to perform their
  1987. # own HTTP stack, in which case the same-origin policy of the browser
  1988. # sandbox only verifies that the applet tries to contact the same IP
  1989. # as from where it was loaded at the IP level. The Host: header may
  1990. # be different from the connected IP and approved origin.
  1991. #
  1992. #Default:
  1993. # host_verify_strict off
  1994. # TAG: client_dst_passthru
  1995. # With NAT or TPROXY intercepted traffic Squid may pass the request
  1996. # directly to the original client destination IP or seek a faster
  1997. # source using the HTTP Host header.
  1998. #
  1999. # Using Host to locate alternative servers can provide faster
  2000. # connectivity with a range of failure recovery options.
  2001. # But can also lead to connectivity trouble when the client and
  2002. # server are attempting stateful interactions unaware of the proxy.
  2003. #
  2004. # This option (on by default) prevents alternative DNS entries being
  2005. # located to send intercepted traffic DIRECT to an origin server.
  2006. # The clients original destination IP and port will be used instead.
  2007. #
  2008. # Regardless of this option setting, when dealing with intercepted
  2009. # traffic Squid will verify the Host: header and any traffic which
  2010. # fails Host verification will be treated as if this option were ON.
  2011. #
  2012. # see host_verify_strict for details on the verification process.
  2013. #Default:
  2014. # client_dst_passthru on
  2015. # SSL OPTIONS
  2016. # -----------------------------------------------------------------------------
  2017. # TAG: ssl_unclean_shutdown
  2018. # Note: This option is only available if Squid is rebuilt with the
  2019. # --with-openssl
  2020. #
  2021. # Some browsers (especially MSIE) bugs out on SSL shutdown
  2022. # messages.
  2023. #Default:
  2024. # ssl_unclean_shutdown off
  2025. # TAG: ssl_engine
  2026. # Note: This option is only available if Squid is rebuilt with the
  2027. # --with-openssl
  2028. #
  2029. # The OpenSSL engine to use. You will need to set this if you
  2030. # would like to use hardware SSL acceleration for example.
  2031. #Default:
  2032. # none
  2033. # TAG: sslproxy_client_certificate
  2034. # Note: This option is only available if Squid is rebuilt with the
  2035. # --with-openssl
  2036. #
  2037. # Client SSL Certificate to use when proxying https:// URLs
  2038. #Default:
  2039. # none
  2040. # TAG: sslproxy_client_key
  2041. # Note: This option is only available if Squid is rebuilt with the
  2042. # --with-openssl
  2043. #
  2044. # Client SSL Key to use when proxying https:// URLs
  2045. #Default:
  2046. # none
  2047. # TAG: sslproxy_version
  2048. # Note: This option is only available if Squid is rebuilt with the
  2049. # --with-openssl
  2050. #
  2051. # SSL version level to use when proxying https:// URLs
  2052. #
  2053. # The versions of SSL/TLS supported:
  2054. #
  2055. # 1 automatic (default)
  2056. # 2 SSLv2 only
  2057. # 3 SSLv3 only
  2058. # 4 TLSv1.0 only
  2059. # 5 TLSv1.1 only
  2060. # 6 TLSv1.2 only
  2061. #Default:
  2062. # automatic SSL/TLS version negotiation
  2063. # TAG: sslproxy_options
  2064. # Note: This option is only available if Squid is rebuilt with the
  2065. # --with-openssl
  2066. #
  2067. # Colon (:) or comma (,) separated list of SSL implementation options
  2068. # to use when proxying https:// URLs
  2069. #
  2070. # The most important being:
  2071. #
  2072. # NO_SSLv2 Disallow the use of SSLv2
  2073. # NO_SSLv3 Disallow the use of SSLv3
  2074. # NO_TLSv1 Disallow the use of TLSv1.0
  2075. # NO_TLSv1_1 Disallow the use of TLSv1.1
  2076. # NO_TLSv1_2 Disallow the use of TLSv1.2
  2077. # SINGLE_DH_USE
  2078. # Always create a new key when using temporary/ephemeral
  2079. # DH key exchanges
  2080. # SSL_OP_NO_TICKET
  2081. # Disable use of RFC5077 session tickets. Some servers
  2082. # may have problems understanding the TLS extension due
  2083. # to ambiguous specification in RFC4507.
  2084. # ALL Enable various bug workarounds suggested as "harmless"
  2085. # by OpenSSL. Be warned that this may reduce SSL/TLS
  2086. # strength to some attacks.
  2087. #
  2088. # See the OpenSSL SSL_CTX_set_options documentation for a
  2089. # complete list of possible options.
  2090. #
  2091. # WARNING: This directive takes a single token. If a space is used
  2092. # the value(s) after that space are SILENTLY IGNORED.
  2093. #Default:
  2094. # none
  2095. # TAG: sslproxy_cipher
  2096. # Note: This option is only available if Squid is rebuilt with the
  2097. # --with-openssl
  2098. #
  2099. # SSL cipher list to use when proxying https:// URLs
  2100. #
  2101. # Colon separated list of supported ciphers.
  2102. #Default:
  2103. # none
  2104. # TAG: sslproxy_cafile
  2105. # Note: This option is only available if Squid is rebuilt with the
  2106. # --with-openssl
  2107. #
  2108. # file containing CA certificates to use when verifying server
  2109. # certificates while proxying https:// URLs
  2110. #Default:
  2111. # none
  2112. # TAG: sslproxy_capath
  2113. # Note: This option is only available if Squid is rebuilt with the
  2114. # --with-openssl
  2115. #
  2116. # directory containing CA certificates to use when verifying
  2117. # server certificates while proxying https:// URLs
  2118. #Default:
  2119. # none
  2120. # TAG: sslproxy_session_ttl
  2121. # Note: This option is only available if Squid is rebuilt with the
  2122. # --with-openssl
  2123. #
  2124. # Sets the timeout value for SSL sessions
  2125. #Default:
  2126. # sslproxy_session_ttl 300
  2127. # TAG: sslproxy_session_cache_size
  2128. # Note: This option is only available if Squid is rebuilt with the
  2129. # --with-openssl
  2130. #
  2131. # Sets the cache size to use for ssl session
  2132. #Default:
  2133. # sslproxy_session_cache_size 2 MB
  2134. # TAG: sslproxy_cert_sign_hash
  2135. # Note: This option is only available if Squid is rebuilt with the
  2136. # --with-openssl
  2137. #
  2138. # Sets the hashing algorithm to use when signing generated certificates.
  2139. # Valid algorithm names depend on the OpenSSL library used. The following
  2140. # names are usually available: sha1, sha256, sha512, and md5. Please see
  2141. # your OpenSSL library manual for the available hashes. By default, Squids
  2142. # that support this option use sha256 hashes.
  2143. #
  2144. # Squid does not forcefully purge cached certificates that were generated
  2145. # with an algorithm other than the currently configured one. They remain
  2146. # in the cache, subject to the regular cache eviction policy, and become
  2147. # useful if the algorithm changes again.
  2148. #Default:
  2149. # none
  2150. # TAG: ssl_bump
  2151. # Note: This option is only available if Squid is rebuilt with the
  2152. # --with-openssl
  2153. #
  2154. # This option is consulted when a CONNECT request is received on
  2155. # an http_port (or a new connection is intercepted at an
  2156. # https_port), provided that port was configured with an ssl-bump
  2157. # flag. The subsequent data on the connection is either treated as
  2158. # HTTPS and decrypted OR tunneled at TCP level without decryption,
  2159. # depending on the first matching bumping "action".
  2160. #
  2161. # ssl_bump <action> [!]acl ...
  2162. #
  2163. # The following bumping actions are currently supported:
  2164. #
  2165. # splice
  2166. # Become a TCP tunnel without decrypting proxied traffic.
  2167. # This is the default action.
  2168. #
  2169. # bump
  2170. # Establish a secure connection with the server and, using a
  2171. # mimicked server certificate, with the client.
  2172. #
  2173. # peek
  2174. # Receive client (step SslBump1) or server (step SslBump2)
  2175. # certificate while preserving the possibility of splicing the
  2176. # connection. Peeking at the server certificate (during step 2)
  2177. # usually precludes bumping of the connection at step 3.
  2178. #
  2179. # stare
  2180. # Receive client (step SslBump1) or server (step SslBump2)
  2181. # certificate while preserving the possibility of bumping the
  2182. # connection. Staring at the server certificate (during step 2)
  2183. # usually precludes splicing of the connection at step 3.
  2184. #
  2185. # terminate
  2186. # Close client and server connections.
  2187. #
  2188. # Backward compatibility actions available at step SslBump1:
  2189. #
  2190. # client-first
  2191. # Bump the connection. Establish a secure connection with the
  2192. # client first, then connect to the server. This old mode does
  2193. # not allow Squid to mimic server SSL certificate and does not
  2194. # work with intercepted SSL connections.
  2195. #
  2196. # server-first
  2197. # Bump the connection. Establish a secure connection with the
  2198. # server first, then establish a secure connection with the
  2199. # client, using a mimicked server certificate. Works with both
  2200. # CONNECT requests and intercepted SSL connections, but does
  2201. # not allow to make decisions based on SSL handshake info.
  2202. #
  2203. # peek-and-splice
  2204. # Decide whether to bump or splice the connection based on
  2205. # client-to-squid and server-to-squid SSL hello messages.
  2206. # XXX: Remove.
  2207. #
  2208. # none
  2209. # Same as the "splice" action.
  2210. #
  2211. # All ssl_bump rules are evaluated at each of the supported bumping
  2212. # steps. Rules with actions that are impossible at the current step are
  2213. # ignored. The first matching ssl_bump action wins and is applied at the
  2214. # end of the current step. If no rules match, the splice action is used.
  2215. # See the at_step ACL for a list of the supported SslBump steps.
  2216. #
  2217. # This clause supports both fast and slow acl types.
  2218. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2219. #
  2220. # See also: http_port ssl-bump, https_port ssl-bump, and acl at_step.
  2221. #
  2222. #
  2223. # # Example: Bump all requests except those originating from
  2224. # # localhost or those going to example.com.
  2225. #
  2226. # acl broken_sites dstdomain .example.com
  2227. # ssl_bump splice localhost
  2228. # ssl_bump splice broken_sites
  2229. # ssl_bump bump all
  2230. #Default:
  2231. # Become a TCP tunnel without decrypting proxied traffic.
  2232. # TAG: sslproxy_flags
  2233. # Note: This option is only available if Squid is rebuilt with the
  2234. # --with-openssl
  2235. #
  2236. # Various flags modifying the use of SSL while proxying https:// URLs:
  2237. # DONT_VERIFY_PEER Accept certificates that fail verification.
  2238. # For refined control, see sslproxy_cert_error.
  2239. # NO_DEFAULT_CA Don't use the default CA list built in
  2240. # to OpenSSL.
  2241. #Default:
  2242. # none
  2243. # TAG: sslproxy_cert_error
  2244. # Note: This option is only available if Squid is rebuilt with the
  2245. # --with-openssl
  2246. #
  2247. # Use this ACL to bypass server certificate validation errors.
  2248. #
  2249. # For example, the following lines will bypass all validation errors
  2250. # when talking to servers for example.com. All other
  2251. # validation errors will result in ERR_SECURE_CONNECT_FAIL error.
  2252. #
  2253. # acl BrokenButTrustedServers dstdomain example.com
  2254. # sslproxy_cert_error allow BrokenButTrustedServers
  2255. # sslproxy_cert_error deny all
  2256. #
  2257. # This clause only supports fast acl types.
  2258. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2259. # Using slow acl types may result in server crashes
  2260. #
  2261. # Without this option, all server certificate validation errors
  2262. # terminate the transaction to protect Squid and the client.
  2263. #
  2264. # SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed
  2265. # but should not happen unless your OpenSSL library is buggy.
  2266. #
  2267. # SECURITY WARNING:
  2268. # Bypassing validation errors is dangerous because an
  2269. # error usually implies that the server cannot be trusted
  2270. # and the connection may be insecure.
  2271. #
  2272. # See also: sslproxy_flags and DONT_VERIFY_PEER.
  2273. #Default:
  2274. # Server certificate errors terminate the transaction.
  2275. # TAG: sslproxy_cert_sign
  2276. # Note: This option is only available if Squid is rebuilt with the
  2277. # --with-openssl
  2278. #
  2279. #
  2280. # sslproxy_cert_sign <signing algorithm> acl ...
  2281. #
  2282. # The following certificate signing algorithms are supported:
  2283. #
  2284. # signTrusted
  2285. # Sign using the configured CA certificate which is usually
  2286. # placed in and trusted by end-user browsers. This is the
  2287. # default for trusted origin server certificates.
  2288. #
  2289. # signUntrusted
  2290. # Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error.
  2291. # This is the default for untrusted origin server certificates
  2292. # that are not self-signed (see ssl::certUntrusted).
  2293. #
  2294. # signSelf
  2295. # Sign using a self-signed certificate with the right CN to
  2296. # generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the
  2297. # browser. This is the default for self-signed origin server
  2298. # certificates (see ssl::certSelfSigned).
  2299. #
  2300. # This clause only supports fast acl types.
  2301. #
  2302. # When sslproxy_cert_sign acl(s) match, Squid uses the corresponding
  2303. # signing algorithm to generate the certificate and ignores all
  2304. # subsequent sslproxy_cert_sign options (the first match wins). If no
  2305. # acl(s) match, the default signing algorithm is determined by errors
  2306. # detected when obtaining and validating the origin server certificate.
  2307. #
  2308. # WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
  2309. # be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
  2310. # CONNECT request that carries a domain name. In all other cases (CONNECT
  2311. # to an IP address or an intercepted SSL connection), Squid cannot detect
  2312. # the domain mismatch at certificate generation time when
  2313. # bump-server-first is used.
  2314. #Default:
  2315. # none
  2316. # TAG: sslproxy_cert_adapt
  2317. # Note: This option is only available if Squid is rebuilt with the
  2318. # --with-openssl
  2319. #
  2320. #
  2321. # sslproxy_cert_adapt <adaptation algorithm> acl ...
  2322. #
  2323. # The following certificate adaptation algorithms are supported:
  2324. #
  2325. # setValidAfter
  2326. # Sets the "Not After" property to the "Not After" property of
  2327. # the CA certificate used to sign generated certificates.
  2328. #
  2329. # setValidBefore
  2330. # Sets the "Not Before" property to the "Not Before" property of
  2331. # the CA certificate used to sign generated certificates.
  2332. #
  2333. # setCommonName or setCommonName{CN}
  2334. # Sets Subject.CN property to the host name specified as a
  2335. # CN parameter or, if no explicit CN parameter was specified,
  2336. # extracted from the CONNECT request. It is a misconfiguration
  2337. # to use setCommonName without an explicit parameter for
  2338. # intercepted or tproxied SSL connections.
  2339. #
  2340. # This clause only supports fast acl types.
  2341. #
  2342. # Squid first groups sslproxy_cert_adapt options by adaptation algorithm.
  2343. # Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the
  2344. # corresponding adaptation algorithm to generate the certificate and
  2345. # ignores all subsequent sslproxy_cert_adapt options in that algorithm's
  2346. # group (i.e., the first match wins within each algorithm group). If no
  2347. # acl(s) match, the default mimicking action takes place.
  2348. #
  2349. # WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
  2350. # be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
  2351. # CONNECT request that carries a domain name. In all other cases (CONNECT
  2352. # to an IP address or an intercepted SSL connection), Squid cannot detect
  2353. # the domain mismatch at certificate generation time when
  2354. # bump-server-first is used.
  2355. #Default:
  2356. # none
  2357. # TAG: sslpassword_program
  2358. # Note: This option is only available if Squid is rebuilt with the
  2359. # --with-openssl
  2360. #
  2361. # Specify a program used for entering SSL key passphrases
  2362. # when using encrypted SSL certificate keys. If not specified
  2363. # keys must either be unencrypted, or Squid started with the -N
  2364. # option to allow it to query interactively for the passphrase.
  2365. #
  2366. # The key file name is given as argument to the program allowing
  2367. # selection of the right password if you have multiple encrypted
  2368. # keys.
  2369. #Default:
  2370. # none
  2371. # OPTIONS RELATING TO EXTERNAL SSL_CRTD
  2372. # -----------------------------------------------------------------------------
  2373. # TAG: sslcrtd_program
  2374. # Note: This option is only available if Squid is rebuilt with the
  2375. # --enable-ssl-crtd
  2376. #
  2377. # Specify the location and options of the executable for ssl_crtd process.
  2378. # /usr/lib/squid/ssl_crtd program requires -s and -M parameters
  2379. # For more information use:
  2380. # /usr/lib/squid/ssl_crtd -h
  2381. #Default:
  2382. # sslcrtd_program /usr/lib/squid/ssl_crtd -s /var/lib/ssl_db -M 4MB
  2383. # TAG: sslcrtd_children
  2384. # Note: This option is only available if Squid is rebuilt with the
  2385. # --enable-ssl-crtd
  2386. #
  2387. # The maximum number of processes spawn to service ssl server.
  2388. # The maximum this may be safely set to is 32.
  2389. #
  2390. # The startup= and idle= options allow some measure of skew in your
  2391. # tuning.
  2392. #
  2393. # startup=N
  2394. #
  2395. # Sets the minimum number of processes to spawn when Squid
  2396. # starts or reconfigures. When set to zero the first request will
  2397. # cause spawning of the first child process to handle it.
  2398. #
  2399. # Starting too few children temporary slows Squid under load while it
  2400. # tries to spawn enough additional processes to cope with traffic.
  2401. #
  2402. # idle=N
  2403. #
  2404. # Sets a minimum of how many processes Squid is to try and keep available
  2405. # at all times. When traffic begins to rise above what the existing
  2406. # processes can handle this many more will be spawned up to the maximum
  2407. # configured. A minimum setting of 1 is required.
  2408. #
  2409. # You must have at least one ssl_crtd process.
  2410. #Default:
  2411. # sslcrtd_children 32 startup=5 idle=1
  2412. # TAG: sslcrtvalidator_program
  2413. # Note: This option is only available if Squid is rebuilt with the
  2414. # --with-openssl
  2415. #
  2416. # Specify the location and options of the executable for ssl_crt_validator
  2417. # process.
  2418. #
  2419. # Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ...
  2420. #
  2421. # Options:
  2422. # ttl=n TTL in seconds for cached results. The default is 60 secs
  2423. # cache=n limit the result cache size. The default value is 2048
  2424. #Default:
  2425. # none
  2426. # TAG: sslcrtvalidator_children
  2427. # Note: This option is only available if Squid is rebuilt with the
  2428. # --with-openssl
  2429. #
  2430. # The maximum number of processes spawn to service SSL server.
  2431. # The maximum this may be safely set to is 32.
  2432. #
  2433. # The startup= and idle= options allow some measure of skew in your
  2434. # tuning.
  2435. #
  2436. # startup=N
  2437. #
  2438. # Sets the minimum number of processes to spawn when Squid
  2439. # starts or reconfigures. When set to zero the first request will
  2440. # cause spawning of the first child process to handle it.
  2441. #
  2442. # Starting too few children temporary slows Squid under load while it
  2443. # tries to spawn enough additional processes to cope with traffic.
  2444. #
  2445. # idle=N
  2446. #
  2447. # Sets a minimum of how many processes Squid is to try and keep available
  2448. # at all times. When traffic begins to rise above what the existing
  2449. # processes can handle this many more will be spawned up to the maximum
  2450. # configured. A minimum setting of 1 is required.
  2451. #
  2452. # concurrency=
  2453. #
  2454. # The number of requests each certificate validator helper can handle in
  2455. # parallel. A value of 0 indicates the certficate validator does not
  2456. # support concurrency. Defaults to 1.
  2457. #
  2458. # When this directive is set to a value >= 1 then the protocol
  2459. # used to communicate with the helper is modified to include
  2460. # a request ID in front of the request/response. The request
  2461. # ID from the request must be echoed back with the response
  2462. # to that request.
  2463. #
  2464. # You must have at least one ssl_crt_validator process.
  2465. #Default:
  2466. # sslcrtvalidator_children 32 startup=5 idle=1 concurrency=1
  2467. # OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
  2468. # -----------------------------------------------------------------------------
  2469. # TAG: cache_peer
  2470. # To specify other caches in a hierarchy, use the format:
  2471. #
  2472. # cache_peer hostname type http-port icp-port [options]
  2473. #
  2474. # For example,
  2475. #
  2476. # # proxy icp
  2477. # # hostname type port port options
  2478. # # -------------------- -------- ----- ----- -----------
  2479. # cache_peer parent.foo.net parent 3128 3130 default
  2480. # cache_peer sib1.foo.net sibling 3128 3130 proxy-only
  2481. # cache_peer sib2.foo.net sibling 3128 3130 proxy-only
  2482. # cache_peer example.com parent 80 0 default
  2483. # cache_peer cdn.example.com sibling 3128 0
  2484. #
  2485. # type: either 'parent', 'sibling', or 'multicast'.
  2486. #
  2487. # proxy-port: The port number where the peer accept HTTP requests.
  2488. # For other Squid proxies this is usually 3128
  2489. # For web servers this is usually 80
  2490. #
  2491. # icp-port: Used for querying neighbor caches about objects.
  2492. # Set to 0 if the peer does not support ICP or HTCP.
  2493. # See ICP and HTCP options below for additional details.
  2494. #
  2495. #
  2496. # ==== ICP OPTIONS ====
  2497. #
  2498. # You MUST also set icp_port and icp_access explicitly when using these options.
  2499. # The defaults will prevent peer traffic using ICP.
  2500. #
  2501. #
  2502. # no-query Disable ICP queries to this neighbor.
  2503. #
  2504. # multicast-responder
  2505. # Indicates the named peer is a member of a multicast group.
  2506. # ICP queries will not be sent directly to the peer, but ICP
  2507. # replies will be accepted from it.
  2508. #
  2509. # closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward
  2510. # CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
  2511. #
  2512. # background-ping
  2513. # To only send ICP queries to this neighbor infrequently.
  2514. # This is used to keep the neighbor round trip time updated
  2515. # and is usually used in conjunction with weighted-round-robin.
  2516. #
  2517. #
  2518. # ==== HTCP OPTIONS ====
  2519. #
  2520. # You MUST also set htcp_port and htcp_access explicitly when using these options.
  2521. # The defaults will prevent peer traffic using HTCP.
  2522. #
  2523. #
  2524. # htcp Send HTCP, instead of ICP, queries to the neighbor.
  2525. # You probably also want to set the "icp-port" to 4827
  2526. # instead of 3130. This directive accepts a comma separated
  2527. # list of options described below.
  2528. #
  2529. # htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier).
  2530. #
  2531. # htcp=no-clr Send HTCP to the neighbor but without
  2532. # sending any CLR requests. This cannot be used with
  2533. # only-clr.
  2534. #
  2535. # htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests.
  2536. # This cannot be used with no-clr.
  2537. #
  2538. # htcp=no-purge-clr
  2539. # Send HTCP to the neighbor including CLRs but only when
  2540. # they do not result from PURGE requests.
  2541. #
  2542. # htcp=forward-clr
  2543. # Forward any HTCP CLR requests this proxy receives to the peer.
  2544. #
  2545. #
  2546. # ==== PEER SELECTION METHODS ====
  2547. #
  2548. # The default peer selection method is ICP, with the first responding peer
  2549. # being used as source. These options can be used for better load balancing.
  2550. #
  2551. #
  2552. # default This is a parent cache which can be used as a "last-resort"
  2553. # if a peer cannot be located by any of the peer-selection methods.
  2554. # If specified more than once, only the first is used.
  2555. #
  2556. # round-robin Load-Balance parents which should be used in a round-robin
  2557. # fashion in the absence of any ICP queries.
  2558. # weight=N can be used to add bias.
  2559. #
  2560. # weighted-round-robin
  2561. # Load-Balance parents which should be used in a round-robin
  2562. # fashion with the frequency of each parent being based on the
  2563. # round trip time. Closer parents are used more often.
  2564. # Usually used for background-ping parents.
  2565. # weight=N can be used to add bias.
  2566. #
  2567. # carp Load-Balance parents which should be used as a CARP array.
  2568. # The requests will be distributed among the parents based on the
  2569. # CARP load balancing hash function based on their weight.
  2570. #
  2571. # userhash Load-balance parents based on the client proxy_auth or ident username.
  2572. #
  2573. # sourcehash Load-balance parents based on the client source IP.
  2574. #
  2575. # multicast-siblings
  2576. # To be used only for cache peers of type "multicast".
  2577. # ALL members of this multicast group have "sibling"
  2578. # relationship with it, not "parent". This is to a multicast
  2579. # group when the requested object would be fetched only from
  2580. # a "parent" cache, anyway. It's useful, e.g., when
  2581. # configuring a pool of redundant Squid proxies, being
  2582. # members of the same multicast group.
  2583. #
  2584. #
  2585. # ==== PEER SELECTION OPTIONS ====
  2586. #
  2587. # weight=N use to affect the selection of a peer during any weighted
  2588. # peer-selection mechanisms.
  2589. # The weight must be an integer; default is 1,
  2590. # larger weights are favored more.
  2591. # This option does not affect parent selection if a peering
  2592. # protocol is not in use.
  2593. #
  2594. # basetime=N Specify a base amount to be subtracted from round trip
  2595. # times of parents.
  2596. # It is subtracted before division by weight in calculating
  2597. # which parent to fectch from. If the rtt is less than the
  2598. # base time the rtt is set to a minimal value.
  2599. #
  2600. # ttl=N Specify a TTL to use when sending multicast ICP queries
  2601. # to this address.
  2602. # Only useful when sending to a multicast group.
  2603. # Because we don't accept ICP replies from random
  2604. # hosts, you must configure other group members as
  2605. # peers with the 'multicast-responder' option.
  2606. #
  2607. # no-delay To prevent access to this neighbor from influencing the
  2608. # delay pools.
  2609. #
  2610. # digest-url=URL Tell Squid to fetch the cache digest (if digests are
  2611. # enabled) for this host from the specified URL rather
  2612. # than the Squid default location.
  2613. #
  2614. #
  2615. # ==== CARP OPTIONS ====
  2616. #
  2617. # carp-key=key-specification
  2618. # use a different key than the full URL to hash against the peer.
  2619. # the key-specification is a comma-separated list of the keywords
  2620. # scheme, host, port, path, params
  2621. # Order is not important.
  2622. #
  2623. # ==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
  2624. #
  2625. # originserver Causes this parent to be contacted as an origin server.
  2626. # Meant to be used in accelerator setups when the peer
  2627. # is a web server.
  2628. #
  2629. # forceddomain=name
  2630. # Set the Host header of requests forwarded to this peer.
  2631. # Useful in accelerator setups where the server (peer)
  2632. # expects a certain domain name but clients may request
  2633. # others. ie example.com or www.example.com
  2634. #
  2635. # no-digest Disable request of cache digests.
  2636. #
  2637. # no-netdb-exchange
  2638. # Disables requesting ICMP RTT database (NetDB).
  2639. #
  2640. #
  2641. # ==== AUTHENTICATION OPTIONS ====
  2642. #
  2643. # login=user:password
  2644. # If this is a personal/workgroup proxy and your parent
  2645. # requires proxy authentication.
  2646. #
  2647. # Note: The string can include URL escapes (i.e. %20 for
  2648. # spaces). This also means % must be written as %%.
  2649. #
  2650. # login=PASSTHRU
  2651. # Send login details received from client to this peer.
  2652. # Both Proxy- and WWW-Authorization headers are passed
  2653. # without alteration to the peer.
  2654. # Authentication is not required by Squid for this to work.
  2655. #
  2656. # Note: This will pass any form of authentication but
  2657. # only Basic auth will work through a proxy unless the
  2658. # connection-auth options are also used.
  2659. #
  2660. # login=PASS Send login details received from client to this peer.
  2661. # Authentication is not required by this option.
  2662. #
  2663. # If there are no client-provided authentication headers
  2664. # to pass on, but username and password are available
  2665. # from an external ACL user= and password= result tags
  2666. # they may be sent instead.
  2667. #
  2668. # Note: To combine this with proxy_auth both proxies must
  2669. # share the same user database as HTTP only allows for
  2670. # a single login (one for proxy, one for origin server).
  2671. # Also be warned this will expose your users proxy
  2672. # password to the peer. USE WITH CAUTION
  2673. #
  2674. # login=*:password
  2675. # Send the username to the upstream cache, but with a
  2676. # fixed password. This is meant to be used when the peer
  2677. # is in another administrative domain, but it is still
  2678. # needed to identify each user.
  2679. # The star can optionally be followed by some extra
  2680. # information which is added to the username. This can
  2681. # be used to identify this proxy to the peer, similar to
  2682. # the login=username:password option above.
  2683. #
  2684. # login=NEGOTIATE
  2685. # If this is a personal/workgroup proxy and your parent
  2686. # requires a secure proxy authentication.
  2687. # The first principal from the default keytab or defined by
  2688. # the environment variable KRB5_KTNAME will be used.
  2689. #
  2690. # WARNING: The connection may transmit requests from multiple
  2691. # clients. Negotiate often assumes end-to-end authentication
  2692. # and a single-client. Which is not strictly true here.
  2693. #
  2694. # login=NEGOTIATE:principal_name
  2695. # If this is a personal/workgroup proxy and your parent
  2696. # requires a secure proxy authentication.
  2697. # The principal principal_name from the default keytab or
  2698. # defined by the environment variable KRB5_KTNAME will be
  2699. # used.
  2700. #
  2701. # WARNING: The connection may transmit requests from multiple
  2702. # clients. Negotiate often assumes end-to-end authentication
  2703. # and a single-client. Which is not strictly true here.
  2704. #
  2705. # connection-auth=on|off
  2706. # Tell Squid that this peer does or not support Microsoft
  2707. # connection oriented authentication, and any such
  2708. # challenges received from there should be ignored.
  2709. # Default is auto to automatically determine the status
  2710. # of the peer.
  2711. #
  2712. #
  2713. # ==== SSL / HTTPS / TLS OPTIONS ====
  2714. #
  2715. # ssl Encrypt connections to this peer with SSL/TLS.
  2716. #
  2717. # sslcert=/path/to/ssl/certificate
  2718. # A client SSL certificate to use when connecting to
  2719. # this peer.
  2720. #
  2721. # sslkey=/path/to/ssl/key
  2722. # The private SSL key corresponding to sslcert above.
  2723. # If 'sslkey' is not specified 'sslcert' is assumed to
  2724. # reference a combined file containing both the
  2725. # certificate and the key.
  2726. #
  2727. # Notes:
  2728. #
  2729. # On Debian/Ubuntu systems a default snakeoil certificate is
  2730. # available in /etc/ssl and users can set:
  2731. #
  2732. # cert=/etc/ssl/certs/ssl-cert-snakeoil.pem
  2733. #
  2734. # and
  2735. #
  2736. # key=/etc/ssl/private/ssl-cert-snakeoil.key
  2737. #
  2738. # for testing.
  2739. #
  2740. # sslversion=1|2|3|4|5|6
  2741. # The SSL version to use when connecting to this peer
  2742. # 1 = automatic (default)
  2743. # 2 = SSL v2 only
  2744. # 3 = SSL v3 only
  2745. # 4 = TLS v1.0 only
  2746. # 5 = TLS v1.1 only
  2747. # 6 = TLS v1.2 only
  2748. #
  2749. # sslcipher=... The list of valid SSL ciphers to use when connecting
  2750. # to this peer.
  2751. #
  2752. # ssloptions=... Specify various SSL implementation options:
  2753. #
  2754. # NO_SSLv2 Disallow the use of SSLv2
  2755. # NO_SSLv3 Disallow the use of SSLv3
  2756. # NO_TLSv1 Disallow the use of TLSv1.0
  2757. # NO_TLSv1_1 Disallow the use of TLSv1.1
  2758. # NO_TLSv1_2 Disallow the use of TLSv1.2
  2759. # SINGLE_DH_USE
  2760. # Always create a new key when using
  2761. # temporary/ephemeral DH key exchanges
  2762. # ALL Enable various bug workarounds
  2763. # suggested as "harmless" by OpenSSL
  2764. # Be warned that this reduces SSL/TLS
  2765. # strength to some attacks.
  2766. #
  2767. # See the OpenSSL SSL_CTX_set_options documentation for a
  2768. # more complete list.
  2769. #
  2770. # sslcafile=... A file containing additional CA certificates to use
  2771. # when verifying the peer certificate.
  2772. #
  2773. # sslcapath=... A directory containing additional CA certificates to
  2774. # use when verifying the peer certificate.
  2775. #
  2776. # sslcrlfile=... A certificate revocation list file to use when
  2777. # verifying the peer certificate.
  2778. #
  2779. # sslflags=... Specify various flags modifying the SSL implementation:
  2780. #
  2781. # DONT_VERIFY_PEER
  2782. # Accept certificates even if they fail to
  2783. # verify.
  2784. # NO_DEFAULT_CA
  2785. # Don't use the default CA list built in
  2786. # to OpenSSL.
  2787. # DONT_VERIFY_DOMAIN
  2788. # Don't verify the peer certificate
  2789. # matches the server name
  2790. #
  2791. # ssldomain= The peer name as advertised in it's certificate.
  2792. # Used for verifying the correctness of the received peer
  2793. # certificate. If not specified the peer hostname will be
  2794. # used.
  2795. #
  2796. # front-end-https
  2797. # Enable the "Front-End-Https: On" header needed when
  2798. # using Squid as a SSL frontend in front of Microsoft OWA.
  2799. # See MS KB document Q307347 for details on this header.
  2800. # If set to auto the header will only be added if the
  2801. # request is forwarded as a https:// URL.
  2802. #
  2803. #
  2804. # ==== GENERAL OPTIONS ====
  2805. #
  2806. # connect-timeout=N
  2807. # A peer-specific connect timeout.
  2808. # Also see the peer_connect_timeout directive.
  2809. #
  2810. # connect-fail-limit=N
  2811. # How many times connecting to a peer must fail before
  2812. # it is marked as down. Standby connection failures
  2813. # count towards this limit. Default is 10.
  2814. #
  2815. # allow-miss Disable Squid's use of only-if-cached when forwarding
  2816. # requests to siblings. This is primarily useful when
  2817. # icp_hit_stale is used by the sibling. Excessive use
  2818. # of this option may result in forwarding loops. One way
  2819. # to prevent peering loops when using this option, is to
  2820. # deny cache peer usage on requests from a peer:
  2821. # acl fromPeer ...
  2822. # cache_peer_access peerName deny fromPeer
  2823. #
  2824. # max-conn=N Limit the number of concurrent connections the Squid
  2825. # may open to this peer, including already opened idle
  2826. # and standby connections. There is no peer-specific
  2827. # connection limit by default.
  2828. #
  2829. # A peer exceeding the limit is not used for new
  2830. # requests unless a standby connection is available.
  2831. #
  2832. # max-conn currently works poorly with idle persistent
  2833. # connections: When a peer reaches its max-conn limit,
  2834. # and there are idle persistent connections to the peer,
  2835. # the peer may not be selected because the limiting code
  2836. # does not know whether Squid can reuse those idle
  2837. # connections.
  2838. #
  2839. # standby=N Maintain a pool of N "hot standby" connections to an
  2840. # UP peer, available for requests when no idle
  2841. # persistent connection is available (or safe) to use.
  2842. # By default and with zero N, no such pool is maintained.
  2843. # N must not exceed the max-conn limit (if any).
  2844. #
  2845. # At start or after reconfiguration, Squid opens new TCP
  2846. # standby connections until there are N connections
  2847. # available and then replenishes the standby pool as
  2848. # opened connections are used up for requests. A used
  2849. # connection never goes back to the standby pool, but
  2850. # may go to the regular idle persistent connection pool
  2851. # shared by all peers and origin servers.
  2852. #
  2853. # Squid never opens multiple new standby connections
  2854. # concurrently. This one-at-a-time approach minimizes
  2855. # flooding-like effect on peers. Furthermore, just a few
  2856. # standby connections should be sufficient in most cases
  2857. # to supply most new requests with a ready-to-use
  2858. # connection.
  2859. #
  2860. # Standby connections obey server_idle_pconn_timeout.
  2861. # For the feature to work as intended, the peer must be
  2862. # configured to accept and keep them open longer than
  2863. # the idle timeout at the connecting Squid, to minimize
  2864. # race conditions typical to idle used persistent
  2865. # connections. Default request_timeout and
  2866. # server_idle_pconn_timeout values ensure such a
  2867. # configuration.
  2868. #
  2869. # name=xxx Unique name for the peer.
  2870. # Required if you have multiple peers on the same host
  2871. # but different ports.
  2872. # This name can be used in cache_peer_access and similar
  2873. # directives to identify the peer.
  2874. # Can be used by outgoing access controls through the
  2875. # peername ACL type.
  2876. #
  2877. # no-tproxy Do not use the client-spoof TPROXY support when forwarding
  2878. # requests to this peer. Use normal address selection instead.
  2879. # This overrides the spoof_client_ip ACL.
  2880. #
  2881. # proxy-only objects fetched from the peer will not be stored locally.
  2882. #
  2883. #Default:
  2884. # none
  2885. # TAG: cache_peer_domain
  2886. # Use to limit the domains for which a neighbor cache will be
  2887. # queried.
  2888. #
  2889. # Usage:
  2890. # cache_peer_domain cache-host domain [domain ...]
  2891. # cache_peer_domain cache-host !domain
  2892. #
  2893. # For example, specifying
  2894. #
  2895. # cache_peer_domain parent.foo.net .edu
  2896. #
  2897. # has the effect such that UDP query packets are sent to
  2898. # 'bigserver' only when the requested object exists on a
  2899. # server in the .edu domain. Prefixing the domainname
  2900. # with '!' means the cache will be queried for objects
  2901. # NOT in that domain.
  2902. #
  2903. # NOTE: * Any number of domains may be given for a cache-host,
  2904. # either on the same or separate lines.
  2905. # * When multiple domains are given for a particular
  2906. # cache-host, the first matched domain is applied.
  2907. # * Cache hosts with no domain restrictions are queried
  2908. # for all requests.
  2909. # * There are no defaults.
  2910. # * There is also a 'cache_peer_access' tag in the ACL
  2911. # section.
  2912. #Default:
  2913. # none
  2914. # TAG: cache_peer_access
  2915. # Restricts usage of cache_peer proxies.
  2916. #
  2917. # Usage:
  2918. # cache_peer_access peer-name allow|deny [!]aclname ...
  2919. #
  2920. # For the required peer-name parameter, use either the value of the
  2921. # cache_peer name=value parameter or, if name=value is missing, the
  2922. # cache_peer hostname parameter.
  2923. #
  2924. # This directive narrows down the selection of peering candidates, but
  2925. # does not determine the order in which the selected candidates are
  2926. # contacted. That order is determined by the peer selection algorithms
  2927. # (see PEER SELECTION sections in the cache_peer documentation).
  2928. #
  2929. # If a deny rule matches, the corresponding peer will not be contacted
  2930. # for the current transaction -- Squid will not send ICP queries and
  2931. # will not forward HTTP requests to that peer. An allow match leaves
  2932. # the corresponding peer in the selection. The first match for a given
  2933. # peer wins for that peer.
  2934. #
  2935. # The relative order of cache_peer_access directives for the same peer
  2936. # matters. The relative order of any two cache_peer_access directives
  2937. # for different peers does not matter. To ease interpretation, it is a
  2938. # good idea to group cache_peer_access directives for the same peer
  2939. # together.
  2940. #
  2941. # A single cache_peer_access directive may be evaluated multiple times
  2942. # for a given transaction because individual peer selection algorithms
  2943. # may check it independently from each other. These redundant checks
  2944. # may be optimized away in future Squid versions.
  2945. #
  2946. # This clause only supports fast acl types.
  2947. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2948. #Default:
  2949. # No peer usage restrictions.
  2950. # TAG: neighbor_type_domain
  2951. # Modify the cache_peer neighbor type when passing requests
  2952. # about specific domains to the peer.
  2953. #
  2954. # Usage:
  2955. # neighbor_type_domain neighbor parent|sibling domain domain ...
  2956. #
  2957. # For example:
  2958. # cache_peer foo.example.com parent 3128 3130
  2959. # neighbor_type_domain foo.example.com sibling .au .de
  2960. #
  2961. # The above configuration treats all requests to foo.example.com as a
  2962. # parent proxy unless the request is for a .au or .de ccTLD domain name.
  2963. #Default:
  2964. # The peer type from cache_peer directive is used for all requests to that peer.
  2965. # TAG: dead_peer_timeout (seconds)
  2966. # This controls how long Squid waits to declare a peer cache
  2967. # as "dead." If there are no ICP replies received in this
  2968. # amount of time, Squid will declare the peer dead and not
  2969. # expect to receive any further ICP replies. However, it
  2970. # continues to send ICP queries, and will mark the peer as
  2971. # alive upon receipt of the first subsequent ICP reply.
  2972. #
  2973. # This timeout also affects when Squid expects to receive ICP
  2974. # replies from peers. If more than 'dead_peer' seconds have
  2975. # passed since the last ICP reply was received, Squid will not
  2976. # expect to receive an ICP reply on the next query. Thus, if
  2977. # your time between requests is greater than this timeout, you
  2978. # will see a lot of requests sent DIRECT to origin servers
  2979. # instead of to your parents.
  2980. #Default:
  2981. # dead_peer_timeout 10 seconds
  2982. # TAG: forward_max_tries
  2983. # Controls how many different forward paths Squid will try
  2984. # before giving up. See also forward_timeout.
  2985. #
  2986. # NOTE: connect_retries (default: none) can make each of these
  2987. # possible forwarding paths be tried multiple times.
  2988. #Default:
  2989. # forward_max_tries 25
  2990. # MEMORY CACHE OPTIONS
  2991. # -----------------------------------------------------------------------------
  2992. # TAG: cache_mem (bytes)
  2993. # NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
  2994. # IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
  2995. # USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
  2996. # THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
  2997. #
  2998. # 'cache_mem' specifies the ideal amount of memory to be used
  2999. # for:
  3000. # * In-Transit objects
  3001. # * Hot Objects
  3002. # * Negative-Cached objects
  3003. #
  3004. # Data for these objects are stored in 4 KB blocks. This
  3005. # parameter specifies the ideal upper limit on the total size of
  3006. # 4 KB blocks allocated. In-Transit objects take the highest
  3007. # priority.
  3008. #
  3009. # In-transit objects have priority over the others. When
  3010. # additional space is needed for incoming data, negative-cached
  3011. # and hot objects will be released. In other words, the
  3012. # negative-cached and hot objects will fill up any unused space
  3013. # not needed for in-transit objects.
  3014. #
  3015. # If circumstances require, this limit will be exceeded.
  3016. # Specifically, if your incoming request rate requires more than
  3017. # 'cache_mem' of memory to hold in-transit objects, Squid will
  3018. # exceed this limit to satisfy the new requests. When the load
  3019. # decreases, blocks will be freed until the high-water mark is
  3020. # reached. Thereafter, blocks will be used to store hot
  3021. # objects.
  3022. #
  3023. # If shared memory caching is enabled, Squid does not use the shared
  3024. # cache space for in-transit objects, but they still consume as much
  3025. # local memory as they need. For more details about the shared memory
  3026. # cache, see memory_cache_shared.
  3027. #Default:
  3028. # cache_mem 256 MB
  3029. # TAG: maximum_object_size_in_memory (bytes)
  3030. # Objects greater than this size will not be attempted to kept in
  3031. # the memory cache. This should be set high enough to keep objects
  3032. # accessed frequently in memory to improve performance whilst low
  3033. # enough to keep larger objects from hoarding cache_mem.
  3034. #Default:
  3035. # maximum_object_size_in_memory 512 KB
  3036. # TAG: memory_cache_shared on|off
  3037. # Controls whether the memory cache is shared among SMP workers.
  3038. #
  3039. # The shared memory cache is meant to occupy cache_mem bytes and replace
  3040. # the non-shared memory cache, although some entities may still be
  3041. # cached locally by workers for now (e.g., internal and in-transit
  3042. # objects may be served from a local memory cache even if shared memory
  3043. # caching is enabled).
  3044. #
  3045. # By default, the memory cache is shared if and only if all of the
  3046. # following conditions are satisfied: Squid runs in SMP mode with
  3047. # multiple workers, cache_mem is positive, and Squid environment
  3048. # supports required IPC primitives (e.g., POSIX shared memory segments
  3049. # and GCC-style atomic operations).
  3050. #
  3051. # To avoid blocking locks, shared memory uses opportunistic algorithms
  3052. # that do not guarantee that every cachable entity that could have been
  3053. # shared among SMP workers will actually be shared.
  3054. #
  3055. # Currently, entities exceeding 32KB in size cannot be shared.
  3056. #Default:
  3057. # "on" where supported if doing memory caching with multiple SMP workers.
  3058. # TAG: memory_cache_mode
  3059. # Controls which objects to keep in the memory cache (cache_mem)
  3060. #
  3061. # always Keep most recently fetched objects in memory (default)
  3062. #
  3063. # disk Only disk cache hits are kept in memory, which means
  3064. # an object must first be cached on disk and then hit
  3065. # a second time before cached in memory.
  3066. #
  3067. # network Only objects fetched from network is kept in memory
  3068. #Default:
  3069. # Keep the most recently fetched objects in memory
  3070. # TAG: memory_replacement_policy
  3071. # The memory replacement policy parameter determines which
  3072. # objects are purged from memory when memory space is needed.
  3073. #
  3074. # See cache_replacement_policy for details on algorithms.
  3075. #Default:
  3076. # memory_replacement_policy lru
  3077. # DISK CACHE OPTIONS
  3078. # -----------------------------------------------------------------------------
  3079. # TAG: cache_replacement_policy
  3080. # The cache replacement policy parameter determines which
  3081. # objects are evicted (replaced) when disk space is needed.
  3082. #
  3083. # lru : Squid's original list based LRU policy
  3084. # heap GDSF : Greedy-Dual Size Frequency
  3085. # heap LFUDA: Least Frequently Used with Dynamic Aging
  3086. # heap LRU : LRU policy implemented using a heap
  3087. #
  3088. # Applies to any cache_dir lines listed below this directive.
  3089. #
  3090. # The LRU policies keeps recently referenced objects.
  3091. #
  3092. # The heap GDSF policy optimizes object hit rate by keeping smaller
  3093. # popular objects in cache so it has a better chance of getting a
  3094. # hit. It achieves a lower byte hit rate than LFUDA though since
  3095. # it evicts larger (possibly popular) objects.
  3096. #
  3097. # The heap LFUDA policy keeps popular objects in cache regardless of
  3098. # their size and thus optimizes byte hit rate at the expense of
  3099. # hit rate since one large, popular object will prevent many
  3100. # smaller, slightly less popular objects from being cached.
  3101. #
  3102. # Both policies utilize a dynamic aging mechanism that prevents
  3103. # cache pollution that can otherwise occur with frequency-based
  3104. # replacement policies.
  3105. #
  3106. # NOTE: if using the LFUDA replacement policy you should increase
  3107. # the value of maximum_object_size above its default of 4 MB to
  3108. # to maximize the potential byte hit rate improvement of LFUDA.
  3109. #
  3110. # For more information about the GDSF and LFUDA cache replacement
  3111. # policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
  3112. # and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
  3113. #Default:
  3114. # cache_replacement_policy lru
  3115. # TAG: minimum_object_size (bytes)
  3116. # Objects smaller than this size will NOT be saved on disk. The
  3117. # value is specified in bytes, and the default is 0 KB, which
  3118. # means all responses can be stored.
  3119. #Default:
  3120. # no limit
  3121. # TAG: maximum_object_size (bytes)
  3122. # Set the default value for max-size parameter on any cache_dir.
  3123. # The value is specified in bytes, and the default is 4 MB.
  3124. #
  3125. # If you wish to get a high BYTES hit ratio, you should probably
  3126. # increase this (one 32 MB object hit counts for 3200 10KB
  3127. # hits).
  3128. #
  3129. # If you wish to increase hit ratio more than you want to
  3130. # save bandwidth you should leave this low.
  3131. #
  3132. # NOTE: if using the LFUDA replacement policy you should increase
  3133. # this value to maximize the byte hit rate improvement of LFUDA!
  3134. # See cache_replacement_policy for a discussion of this policy.
  3135. #Default:
  3136. # maximum_object_size 4 MB
  3137. # TAG: cache_dir
  3138. # Format:
  3139. # cache_dir Type Directory-Name Fs-specific-data [options]
  3140. #
  3141. # You can specify multiple cache_dir lines to spread the
  3142. # cache among different disk partitions.
  3143. #
  3144. # Type specifies the kind of storage system to use. Only "ufs"
  3145. # is built by default. To enable any of the other storage systems
  3146. # see the --enable-storeio configure option.
  3147. #
  3148. # 'Directory' is a top-level directory where cache swap
  3149. # files will be stored. If you want to use an entire disk
  3150. # for caching, this can be the mount-point directory.
  3151. # The directory must exist and be writable by the Squid
  3152. # process. Squid will NOT create this directory for you.
  3153. #
  3154. # In SMP configurations, cache_dir must not precede the workers option
  3155. # and should use configuration macros or conditionals to give each
  3156. # worker interested in disk caching a dedicated cache directory.
  3157. #
  3158. #
  3159. # ==== The ufs store type ====
  3160. #
  3161. # "ufs" is the old well-known Squid storage format that has always
  3162. # been there.
  3163. #
  3164. # Usage:
  3165. # cache_dir ufs Directory-Name Mbytes L1 L2 [options]
  3166. #
  3167. # 'Mbytes' is the amount of disk space (MB) to use under this
  3168. # directory. The default is 100 MB. Change this to suit your
  3169. # configuration. Do NOT put the size of your disk drive here.
  3170. # Instead, if you want Squid to use the entire disk drive,
  3171. # subtract 20% and use that value.
  3172. #
  3173. # 'L1' is the number of first-level subdirectories which
  3174. # will be created under the 'Directory'. The default is 16.
  3175. #
  3176. # 'L2' is the number of second-level subdirectories which
  3177. # will be created under each first-level directory. The default
  3178. # is 256.
  3179. #
  3180. #
  3181. # ==== The aufs store type ====
  3182. #
  3183. # "aufs" uses the same storage format as "ufs", utilizing
  3184. # POSIX-threads to avoid blocking the main Squid process on
  3185. # disk-I/O. This was formerly known in Squid as async-io.
  3186. #
  3187. # Usage:
  3188. # cache_dir aufs Directory-Name Mbytes L1 L2 [options]
  3189. #
  3190. # see argument descriptions under ufs above
  3191. #
  3192. #
  3193. # ==== The diskd store type ====
  3194. #
  3195. # "diskd" uses the same storage format as "ufs", utilizing a
  3196. # separate process to avoid blocking the main Squid process on
  3197. # disk-I/O.
  3198. #
  3199. # Usage:
  3200. # cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
  3201. #
  3202. # see argument descriptions under ufs above
  3203. #
  3204. # Q1 specifies the number of unacknowledged I/O requests when Squid
  3205. # stops opening new files. If this many messages are in the queues,
  3206. # Squid won't open new files. Default is 64
  3207. #
  3208. # Q2 specifies the number of unacknowledged messages when Squid
  3209. # starts blocking. If this many messages are in the queues,
  3210. # Squid blocks until it receives some replies. Default is 72
  3211. #
  3212. # When Q1 < Q2 (the default), the cache directory is optimized
  3213. # for lower response time at the expense of a decrease in hit
  3214. # ratio. If Q1 > Q2, the cache directory is optimized for
  3215. # higher hit ratio at the expense of an increase in response
  3216. # time.
  3217. #
  3218. #
  3219. # ==== The rock store type ====
  3220. #
  3221. # Usage:
  3222. # cache_dir rock Directory-Name Mbytes [options]
  3223. #
  3224. # The Rock Store type is a database-style storage. All cached
  3225. # entries are stored in a "database" file, using fixed-size slots.
  3226. # A single entry occupies one or more slots.
  3227. #
  3228. # If possible, Squid using Rock Store creates a dedicated kid
  3229. # process called "disker" to avoid blocking Squid worker(s) on disk
  3230. # I/O. One disker kid is created for each rock cache_dir. Diskers
  3231. # are created only when Squid, running in daemon mode, has support
  3232. # for the IpcIo disk I/O module.
  3233. #
  3234. # swap-timeout=msec: Squid will not start writing a miss to or
  3235. # reading a hit from disk if it estimates that the swap operation
  3236. # will take more than the specified number of milliseconds. By
  3237. # default and when set to zero, disables the disk I/O time limit
  3238. # enforcement. Ignored when using blocking I/O module because
  3239. # blocking synchronous I/O does not allow Squid to estimate the
  3240. # expected swap wait time.
  3241. #
  3242. # max-swap-rate=swaps/sec: Artificially limits disk access using
  3243. # the specified I/O rate limit. Swap out requests that
  3244. # would cause the average I/O rate to exceed the limit are
  3245. # delayed. Individual swap in requests (i.e., hits or reads) are
  3246. # not delayed, but they do contribute to measured swap rate and
  3247. # since they are placed in the same FIFO queue as swap out
  3248. # requests, they may wait longer if max-swap-rate is smaller.
  3249. # This is necessary on file systems that buffer "too
  3250. # many" writes and then start blocking Squid and other processes
  3251. # while committing those writes to disk. Usually used together
  3252. # with swap-timeout to avoid excessive delays and queue overflows
  3253. # when disk demand exceeds available disk "bandwidth". By default
  3254. # and when set to zero, disables the disk I/O rate limit
  3255. # enforcement. Currently supported by IpcIo module only.
  3256. #
  3257. # slot-size=bytes: The size of a database "record" used for
  3258. # storing cached responses. A cached response occupies at least
  3259. # one slot and all database I/O is done using individual slots so
  3260. # increasing this parameter leads to more disk space waste while
  3261. # decreasing it leads to more disk I/O overheads. Should be a
  3262. # multiple of your operating system I/O page size. Defaults to
  3263. # 16KBytes. A housekeeping header is stored with each slot and
  3264. # smaller slot-sizes will be rejected. The header is smaller than
  3265. # 100 bytes.
  3266. #
  3267. #
  3268. # ==== COMMON OPTIONS ====
  3269. #
  3270. # no-store no new objects should be stored to this cache_dir.
  3271. #
  3272. # min-size=n the minimum object size in bytes this cache_dir
  3273. # will accept. It's used to restrict a cache_dir
  3274. # to only store large objects (e.g. AUFS) while
  3275. # other stores are optimized for smaller objects
  3276. # (e.g. Rock).
  3277. # Defaults to 0.
  3278. #
  3279. # max-size=n the maximum object size in bytes this cache_dir
  3280. # supports.
  3281. # The value in maximum_object_size directive sets
  3282. # the default unless more specific details are
  3283. # available (ie a small store capacity).
  3284. #
  3285. # Note: To make optimal use of the max-size limits you should order
  3286. # the cache_dir lines with the smallest max-size value first.
  3287. #
  3288. #Default:
  3289. # No disk cache. Store cache ojects only in memory.
  3290. #
  3291. # Uncomment and adjust the following to add a disk cache directory.
  3292. cache_dir ufs /var/spool/squid 1024 16 256
  3293. # TAG: store_dir_select_algorithm
  3294. # How Squid selects which cache_dir to use when the response
  3295. # object will fit into more than one.
  3296. #
  3297. # Regardless of which algorithm is used the cache_dir min-size
  3298. # and max-size parameters are obeyed. As such they can affect
  3299. # the selection algorithm by limiting the set of considered
  3300. # cache_dir.
  3301. #
  3302. # Algorithms:
  3303. #
  3304. # least-load
  3305. #
  3306. # This algorithm is suited to caches with similar cache_dir
  3307. # sizes and disk speeds.
  3308. #
  3309. # The disk with the least I/O pending is selected.
  3310. # When there are multiple disks with the same I/O load ranking
  3311. # the cache_dir with most available capacity is selected.
  3312. #
  3313. # When a mix of cache_dir sizes are configured the faster disks
  3314. # have a naturally lower I/O loading and larger disks have more
  3315. # capacity. So space used to store objects and data throughput
  3316. # may be very unbalanced towards larger disks.
  3317. #
  3318. #
  3319. # round-robin
  3320. #
  3321. # This algorithm is suited to caches with unequal cache_dir
  3322. # disk sizes.
  3323. #
  3324. # Each cache_dir is selected in a rotation. The next suitable
  3325. # cache_dir is used.
  3326. #
  3327. # Available cache_dir capacity is only considered in relation
  3328. # to whether the object will fit and meets the min-size and
  3329. # max-size parameters.
  3330. #
  3331. # Disk I/O loading is only considered to prevent overload on slow
  3332. # disks. This algorithm does not spread objects by size, so any
  3333. # I/O loading per-disk may appear very unbalanced and volatile.
  3334. #
  3335. # If several cache_dirs use similar min-size, max-size, or other
  3336. # limits to to reject certain responses, then do not group such
  3337. # cache_dir lines together, to avoid round-robin selection bias
  3338. # towards the first cache_dir after the group. Instead, interleave
  3339. # cache_dir lines from different groups. For example:
  3340. #
  3341. # store_dir_select_algorithm round-robin
  3342. # cache_dir rock /hdd1 ... min-size=100000
  3343. # cache_dir rock /ssd1 ... max-size=99999
  3344. # cache_dir rock /hdd2 ... min-size=100000
  3345. # cache_dir rock /ssd2 ... max-size=99999
  3346. # cache_dir rock /hdd3 ... min-size=100000
  3347. # cache_dir rock /ssd3 ... max-size=99999
  3348. #Default:
  3349. # store_dir_select_algorithm least-load
  3350. # TAG: max_open_disk_fds
  3351. # To avoid having disk as the I/O bottleneck Squid can optionally
  3352. # bypass the on-disk cache if more than this amount of disk file
  3353. # descriptors are open.
  3354. #
  3355. # A value of 0 indicates no limit.
  3356. #Default:
  3357. # no limit
  3358. # TAG: cache_swap_low (percent, 0-100)
  3359. # The low-water mark for AUFS/UFS/diskd cache object eviction by
  3360. # the cache_replacement_policy algorithm.
  3361. #
  3362. # Removal begins when the swap (disk) usage of a cache_dir is
  3363. # above this low-water mark and attempts to maintain utilization
  3364. # near the low-water mark.
  3365. #
  3366. # As swap utilization increases towards the high-water mark set
  3367. # by cache_swap_high object eviction becomes more agressive.
  3368. #
  3369. # The value difference in percentages between low- and high-water
  3370. # marks represent an eviction rate of 300 objects per second and
  3371. # the rate continues to scale in agressiveness by multiples of
  3372. # this above the high-water mark.
  3373. #
  3374. # Defaults are 90% and 95%. If you have a large cache, 5% could be
  3375. # hundreds of MB. If this is the case you may wish to set these
  3376. # numbers closer together.
  3377. #
  3378. # See also cache_swap_high and cache_replacement_policy
  3379. #Default:
  3380. # cache_swap_low 90
  3381. # TAG: cache_swap_high (percent, 0-100)
  3382. # The high-water mark for AUFS/UFS/diskd cache object eviction by
  3383. # the cache_replacement_policy algorithm.
  3384. #
  3385. # Removal begins when the swap (disk) usage of a cache_dir is
  3386. # above the low-water mark set by cache_swap_low and attempts to
  3387. # maintain utilization near the low-water mark.
  3388. #
  3389. # As swap utilization increases towards this high-water mark object
  3390. # eviction becomes more agressive.
  3391. #
  3392. # The value difference in percentages between low- and high-water
  3393. # marks represent an eviction rate of 300 objects per second and
  3394. # the rate continues to scale in agressiveness by multiples of
  3395. # this above the high-water mark.
  3396. #
  3397. # Defaults are 90% and 95%. If you have a large cache, 5% could be
  3398. # hundreds of MB. If this is the case you may wish to set these
  3399. # numbers closer together.
  3400. #
  3401. # See also cache_swap_low and cache_replacement_policy
  3402. #Default:
  3403. # cache_swap_high 95
  3404. # LOGFILE OPTIONS
  3405. # -----------------------------------------------------------------------------
  3406. # TAG: logformat
  3407. # Usage:
  3408. #
  3409. # logformat <name> <format specification>
  3410. #
  3411. # Defines an access log format.
  3412. #
  3413. # The <format specification> is a string with embedded % format codes
  3414. #
  3415. # % format codes all follow the same basic structure where all but
  3416. # the formatcode is optional. Output strings are automatically escaped
  3417. # as required according to their context and the output format
  3418. # modifiers are usually not needed, but can be specified if an explicit
  3419. # output format is desired.
  3420. #
  3421. # % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
  3422. #
  3423. # " output in quoted string format
  3424. # [ output in squid text log format as used by log_mime_hdrs
  3425. # # output in URL quoted format
  3426. # ' output as-is
  3427. #
  3428. # - left aligned
  3429. #
  3430. # width minimum and/or maximum field width:
  3431. # [width_min][.width_max]
  3432. # When minimum starts with 0, the field is zero-padded.
  3433. # String values exceeding maximum width are truncated.
  3434. #
  3435. # {arg} argument such as header name etc
  3436. #
  3437. # Format codes:
  3438. #
  3439. # % a literal % character
  3440. # sn Unique sequence number per log line entry
  3441. # err_code The ID of an error response served by Squid or
  3442. # a similar internal error identifier.
  3443. # err_detail Additional err_code-dependent error information.
  3444. # note The annotation specified by the argument. Also
  3445. # logs the adaptation meta headers set by the
  3446. # adaptation_meta configuration parameter.
  3447. # If no argument given all annotations logged.
  3448. # The argument may include a separator to use with
  3449. # annotation values:
  3450. # name[:separator]
  3451. # By default, multiple note values are separated with ","
  3452. # and multiple notes are separated with "\r\n".
  3453. # When logging named notes with %{name}note, the
  3454. # explicitly configured separator is used between note
  3455. # values. When logging all notes with %note, the
  3456. # explicitly configured separator is used between
  3457. # individual notes. There is currently no way to
  3458. # specify both value and notes separators when logging
  3459. # all notes with %note.
  3460. #
  3461. # Connection related format codes:
  3462. #
  3463. # >a Client source IP address
  3464. # >A Client FQDN
  3465. # >p Client source port
  3466. # >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier)
  3467. # >la Local IP address the client connected to
  3468. # >lp Local port number the client connected to
  3469. # >qos Client connection TOS/DSCP value set by Squid
  3470. # >nfmark Client connection netfilter mark set by Squid
  3471. #
  3472. # la Local listening IP address the client connection was connected to.
  3473. # lp Local listening port number the client connection was connected to.
  3474. #
  3475. # <a Server IP address of the last server or peer connection
  3476. # <A Server FQDN or peer name
  3477. # <p Server port number of the last server or peer connection
  3478. # <la Local IP address of the last server or peer connection
  3479. # <lp Local port number of the last server or peer connection
  3480. # <qos Server connection TOS/DSCP value set by Squid
  3481. # <nfmark Server connection netfilter mark set by Squid
  3482. #
  3483. # Time related format codes:
  3484. #
  3485. # ts Seconds since epoch
  3486. # tu subsecond time (milliseconds)
  3487. # tl Local time. Optional strftime format argument
  3488. # default %d/%b/%Y:%H:%M:%S %z
  3489. # tg GMT time. Optional strftime format argument
  3490. # default %d/%b/%Y:%H:%M:%S %z
  3491. # tr Response time (milliseconds)
  3492. # dt Total time spent making DNS lookups (milliseconds)
  3493. # tS Approximate master transaction start time in
  3494. # <full seconds since epoch>.<fractional seconds> format.
  3495. # Currently, Squid considers the master transaction
  3496. # started when a complete HTTP request header initiating
  3497. # the transaction is received from the client. This is
  3498. # the same value that Squid uses to calculate transaction
  3499. # response time when logging %tr to access.log. Currently,
  3500. # Squid uses millisecond resolution for %tS values,
  3501. # similar to the default access.log "current time" field
  3502. # (%ts.%03tu).
  3503. #
  3504. # Access Control related format codes:
  3505. #
  3506. # et Tag returned by external acl
  3507. # ea Log string returned by external acl
  3508. # un User name (any available)
  3509. # ul User name from authentication
  3510. # ue User name from external acl helper
  3511. # ui User name from ident
  3512. # un A user name. Expands to the first available name
  3513. # from the following list of information sources:
  3514. # - authenticated user name, like %ul
  3515. # - user name supplied by an external ACL, like %ue
  3516. # - SSL client name, like %us
  3517. # - ident user name, like %ui
  3518. # credentials Client credentials. The exact meaning depends on
  3519. # the authentication scheme: For Basic authentication,
  3520. # it is the password; for Digest, the realm sent by the
  3521. # client; for NTLM and Negotiate, the client challenge
  3522. # or client credentials prefixed with "YR " or "KK ".
  3523. #
  3524. # HTTP related format codes:
  3525. #
  3526. # REQUEST
  3527. #
  3528. # [http::]rm Request method (GET/POST etc)
  3529. # [http::]>rm Request method from client
  3530. # [http::]<rm Request method sent to server or peer
  3531. # [http::]ru Request URL from client (historic, filtered for logging)
  3532. # [http::]>ru Request URL from client
  3533. # [http::]<ru Request URL sent to server or peer
  3534. # [http::]>rs Request URL scheme from client
  3535. # [http::]<rs Request URL scheme sent to server or peer
  3536. # [http::]>rd Request URL domain from client
  3537. # [http::]<rd Request URL domain sent to server or peer
  3538. # [http::]>rP Request URL port from client
  3539. # [http::]<rP Request URL port sent to server or peer
  3540. # [http::]rp Request URL path excluding hostname
  3541. # [http::]>rp Request URL path excluding hostname from client
  3542. # [http::]<rp Request URL path excluding hostname sent to server or peer
  3543. # [http::]rv Request protocol version
  3544. # [http::]>rv Request protocol version from client
  3545. # [http::]<rv Request protocol version sent to server or peer
  3546. #
  3547. # [http::]>h Original received request header.
  3548. # Usually differs from the request header sent by
  3549. # Squid, although most fields are often preserved.
  3550. # Accepts optional header field name/value filter
  3551. # argument using name[:[separator]element] format.
  3552. # [http::]>ha Received request header after adaptation and
  3553. # redirection (pre-cache REQMOD vectoring point).
  3554. # Usually differs from the request header sent by
  3555. # Squid, although most fields are often preserved.
  3556. # Optional header name argument as for >h
  3557. #
  3558. #
  3559. # RESPONSE
  3560. #
  3561. # [http::]<Hs HTTP status code received from the next hop
  3562. # [http::]>Hs HTTP status code sent to the client
  3563. #
  3564. # [http::]<h Reply header. Optional header name argument
  3565. # as for >h
  3566. #
  3567. # [http::]mt MIME content type
  3568. #
  3569. #
  3570. # SIZE COUNTERS
  3571. #
  3572. # [http::]st Total size of request + reply traffic with client
  3573. # [http::]>st Total size of request received from client.
  3574. # Excluding chunked encoding bytes.
  3575. # [http::]<st Total size of reply sent to client (after adaptation)
  3576. #
  3577. # [http::]>sh Size of request headers received from client
  3578. # [http::]<sh Size of reply headers sent to client (after adaptation)
  3579. #
  3580. # [http::]<sH Reply high offset sent
  3581. # [http::]<sS Upstream object size
  3582. #
  3583. # [http::]<bs Number of HTTP-equivalent message body bytes
  3584. # received from the next hop, excluding chunked
  3585. # transfer encoding and control messages.
  3586. # Generated FTP/Gopher listings are treated as
  3587. # received bodies.
  3588. #
  3589. #
  3590. # TIMING
  3591. #
  3592. # [http::]<pt Peer response time in milliseconds. The timer starts
  3593. # when the last request byte is sent to the next hop
  3594. # and stops when the last response byte is received.
  3595. # [http::]<tt Total time in milliseconds. The timer
  3596. # starts with the first connect request (or write I/O)
  3597. # sent to the first selected peer. The timer stops
  3598. # with the last I/O with the last peer.
  3599. #
  3600. # Squid handling related format codes:
  3601. #
  3602. # Ss Squid request status (TCP_MISS etc)
  3603. # Sh Squid hierarchy status (DEFAULT_PARENT etc)
  3604. #
  3605. # SSL-related format codes:
  3606. #
  3607. # ssl::bump_mode SslBump decision for the transaction:
  3608. #
  3609. # For CONNECT requests that initiated bumping of
  3610. # a connection and for any request received on
  3611. # an already bumped connection, Squid logs the
  3612. # corresponding SslBump mode ("server-first" or
  3613. # "client-first"). See the ssl_bump option for
  3614. # more information about these modes.
  3615. #
  3616. # A "none" token is logged for requests that
  3617. # triggered "ssl_bump" ACL evaluation matching
  3618. # either a "none" rule or no rules at all.
  3619. #
  3620. # In all other cases, a single dash ("-") is
  3621. # logged.
  3622. #
  3623. # ssl::>sni SSL client SNI sent to Squid. Available only
  3624. # after the peek, stare, or splice SSL bumping
  3625. # actions.
  3626. #
  3627. # If ICAP is enabled, the following code becomes available (as
  3628. # well as ICAP log codes documented with the icap_log option):
  3629. #
  3630. # icap::tt Total ICAP processing time for the HTTP
  3631. # transaction. The timer ticks when ICAP
  3632. # ACLs are checked and when ICAP
  3633. # transaction is in progress.
  3634. #
  3635. # If adaptation is enabled the following three codes become available:
  3636. #
  3637. # adapt::<last_h The header of the last ICAP response or
  3638. # meta-information from the last eCAP
  3639. # transaction related to the HTTP transaction.
  3640. # Like <h, accepts an optional header name
  3641. # argument.
  3642. #
  3643. # adapt::sum_trs Summed adaptation transaction response
  3644. # times recorded as a comma-separated list in
  3645. # the order of transaction start time. Each time
  3646. # value is recorded as an integer number,
  3647. # representing response time of one or more
  3648. # adaptation (ICAP or eCAP) transaction in
  3649. # milliseconds. When a failed transaction is
  3650. # being retried or repeated, its time is not
  3651. # logged individually but added to the
  3652. # replacement (next) transaction. See also:
  3653. # adapt::all_trs.
  3654. #
  3655. # adapt::all_trs All adaptation transaction response times.
  3656. # Same as adaptation_strs but response times of
  3657. # individual transactions are never added
  3658. # together. Instead, all transaction response
  3659. # times are recorded individually.
  3660. #
  3661. # You can prefix adapt::*_trs format codes with adaptation
  3662. # service name in curly braces to record response time(s) specific
  3663. # to that service. For example: %{my_service}adapt::sum_trs
  3664. #
  3665. # If SSL is enabled, the following formating codes become available:
  3666. #
  3667. # %ssl::>cert_subject The Subject field of the received client
  3668. # SSL certificate or a dash ('-') if Squid has
  3669. # received an invalid/malformed certificate or
  3670. # no certificate at all. Consider encoding the
  3671. # logged value because Subject often has spaces.
  3672. #
  3673. # %ssl::>cert_issuer The Issuer field of the received client
  3674. # SSL certificate or a dash ('-') if Squid has
  3675. # received an invalid/malformed certificate or
  3676. # no certificate at all. Consider encoding the
  3677. # logged value because Issuer often has spaces.
  3678. #
  3679. # The default formats available (which do not need re-defining) are:
  3680. #
  3681. #logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
  3682. #logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
  3683. #logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
  3684. #logformat referrer %ts.%03tu %>a %{Referer}>h %ru
  3685. #logformat useragent %>a [%tl] "%{User-Agent}>h"
  3686. #
  3687. # NOTE: When the log_mime_hdrs directive is set to ON.
  3688. # The squid, common and combined formats have a safely encoded copy
  3689. # of the mime headers appended to each line within a pair of brackets.
  3690. #
  3691. # NOTE: The common and combined formats are not quite true to the Apache definition.
  3692. # The logs from Squid contain an extra status and hierarchy code appended.
  3693. #
  3694. #Default:
  3695. # The format definitions squid, common, combined, referrer, useragent are built in.
  3696. # TAG: access_log
  3697. # Configures whether and how Squid logs HTTP and ICP transactions.
  3698. # If access logging is enabled, a single line is logged for every
  3699. # matching HTTP or ICP request. The recommended directive formats are:
  3700. #
  3701. # access_log <module>:<place> [option ...] [acl acl ...]
  3702. # access_log none [acl acl ...]
  3703. #
  3704. # The following directive format is accepted but may be deprecated:
  3705. # access_log <module>:<place> [<logformat name> [acl acl ...]]
  3706. #
  3707. # In most cases, the first ACL name must not contain the '=' character
  3708. # and should not be equal to an existing logformat name. You can always
  3709. # start with an 'all' ACL to work around those restrictions.
  3710. #
  3711. # Will log to the specified module:place using the specified format (which
  3712. # must be defined in a logformat directive) those entries which match
  3713. # ALL the acl's specified (which must be defined in acl clauses).
  3714. # If no acl is specified, all requests will be logged to this destination.
  3715. #
  3716. # ===== Available options for the recommended directive format =====
  3717. #
  3718. # logformat=name Names log line format (either built-in or
  3719. # defined by a logformat directive). Defaults
  3720. # to 'squid'.
  3721. #
  3722. # buffer-size=64KB Defines approximate buffering limit for log
  3723. # records (see buffered_logs). Squid should not
  3724. # keep more than the specified size and, hence,
  3725. # should flush records before the buffer becomes
  3726. # full to avoid overflows under normal
  3727. # conditions (the exact flushing algorithm is
  3728. # module-dependent though). The on-error option
  3729. # controls overflow handling.
  3730. #
  3731. # on-error=die|drop Defines action on unrecoverable errors. The
  3732. # 'drop' action ignores (i.e., does not log)
  3733. # affected log records. The default 'die' action
  3734. # kills the affected worker. The drop action
  3735. # support has not been tested for modules other
  3736. # than tcp.
  3737. #
  3738. # ===== Modules Currently available =====
  3739. #
  3740. # none Do not log any requests matching these ACL.
  3741. # Do not specify Place or logformat name.
  3742. #
  3743. # stdio Write each log line to disk immediately at the completion of
  3744. # each request.
  3745. # Place: the filename and path to be written.
  3746. #
  3747. # daemon Very similar to stdio. But instead of writing to disk the log
  3748. # line is passed to a daemon helper for asychronous handling instead.
  3749. # Place: varies depending on the daemon.
  3750. #
  3751. # log_file_daemon Place: the file name and path to be written.
  3752. #
  3753. # syslog To log each request via syslog facility.
  3754. # Place: The syslog facility and priority level for these entries.
  3755. # Place Format: facility.priority
  3756. #
  3757. # where facility could be any of:
  3758. # authpriv, daemon, local0 ... local7 or user.
  3759. #
  3760. # And priority could be any of:
  3761. # err, warning, notice, info, debug.
  3762. #
  3763. # udp To send each log line as text data to a UDP receiver.
  3764. # Place: The destination host name or IP and port.
  3765. # Place Format: //host:port
  3766. #
  3767. # tcp To send each log line as text data to a TCP receiver.
  3768. # Lines may be accumulated before sending (see buffered_logs).
  3769. # Place: The destination host name or IP and port.
  3770. # Place Format: //host:port
  3771. #
  3772. # Default:
  3773. # access_log daemon:/var/log/squid/access.log squid
  3774. #Default:
  3775. # access_log daemon:/var/log/squid/access.log squid
  3776. # TAG: icap_log
  3777. # ICAP log files record ICAP transaction summaries, one line per
  3778. # transaction.
  3779. #
  3780. # The icap_log option format is:
  3781. # icap_log <filepath> [<logformat name> [acl acl ...]]
  3782. # icap_log none [acl acl ...]]
  3783. #
  3784. # Please see access_log option documentation for details. The two
  3785. # kinds of logs share the overall configuration approach and many
  3786. # features.
  3787. #
  3788. # ICAP processing of a single HTTP message or transaction may
  3789. # require multiple ICAP transactions. In such cases, multiple
  3790. # ICAP transaction log lines will correspond to a single access
  3791. # log line.
  3792. #
  3793. # ICAP log uses logformat codes that make sense for an ICAP
  3794. # transaction. Header-related codes are applied to the HTTP header
  3795. # embedded in an ICAP server response, with the following caveats:
  3796. # For REQMOD, there is no HTTP response header unless the ICAP
  3797. # server performed request satisfaction. For RESPMOD, the HTTP
  3798. # request header is the header sent to the ICAP server. For
  3799. # OPTIONS, there are no HTTP headers.
  3800. #
  3801. # The following format codes are also available for ICAP logs:
  3802. #
  3803. # icap::<A ICAP server IP address. Similar to <A.
  3804. #
  3805. # icap::<service_name ICAP service name from the icap_service
  3806. # option in Squid configuration file.
  3807. #
  3808. # icap::ru ICAP Request-URI. Similar to ru.
  3809. #
  3810. # icap::rm ICAP request method (REQMOD, RESPMOD, or
  3811. # OPTIONS). Similar to existing rm.
  3812. #
  3813. # icap::>st Bytes sent to the ICAP server (TCP payload
  3814. # only; i.e., what Squid writes to the socket).
  3815. #
  3816. # icap::<st Bytes received from the ICAP server (TCP
  3817. # payload only; i.e., what Squid reads from
  3818. # the socket).
  3819. #
  3820. # icap::<bs Number of message body bytes received from the
  3821. # ICAP server. ICAP message body, if any, usually
  3822. # includes encapsulated HTTP message headers and
  3823. # possibly encapsulated HTTP message body. The
  3824. # HTTP body part is dechunked before its size is
  3825. # computed.
  3826. #
  3827. # icap::tr Transaction response time (in
  3828. # milliseconds). The timer starts when
  3829. # the ICAP transaction is created and
  3830. # stops when the transaction is completed.
  3831. # Similar to tr.
  3832. #
  3833. # icap::tio Transaction I/O time (in milliseconds). The
  3834. # timer starts when the first ICAP request
  3835. # byte is scheduled for sending. The timers
  3836. # stops when the last byte of the ICAP response
  3837. # is received.
  3838. #
  3839. # icap::to Transaction outcome: ICAP_ERR* for all
  3840. # transaction errors, ICAP_OPT for OPTION
  3841. # transactions, ICAP_ECHO for 204
  3842. # responses, ICAP_MOD for message
  3843. # modification, and ICAP_SAT for request
  3844. # satisfaction. Similar to Ss.
  3845. #
  3846. # icap::Hs ICAP response status code. Similar to Hs.
  3847. #
  3848. # icap::>h ICAP request header(s). Similar to >h.
  3849. #
  3850. # icap::<h ICAP response header(s). Similar to <h.
  3851. #
  3852. # The default ICAP log format, which can be used without an explicit
  3853. # definition, is called icap_squid:
  3854. #
  3855. #logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A -
  3856. #
  3857. # See also: logformat, log_icap, and %adapt::<last_h
  3858. #Default:
  3859. # none
  3860. # TAG: logfile_daemon
  3861. # Specify the path to the logfile-writing daemon. This daemon is
  3862. # used to write the access and store logs, if configured.
  3863. #
  3864. # Squid sends a number of commands to the log daemon:
  3865. # L<data>\n - logfile data
  3866. # R\n - rotate file
  3867. # T\n - truncate file
  3868. # O\n - reopen file
  3869. # F\n - flush file
  3870. # r<n>\n - set rotate count to <n>
  3871. # b<n>\n - 1 = buffer output, 0 = don't buffer output
  3872. #
  3873. # No responses is expected.
  3874. #Default:
  3875. # logfile_daemon /usr/lib/squid/log_file_daemon
  3876. # TAG: stats_collection allow|deny acl acl...
  3877. # This options allows you to control which requests gets accounted
  3878. # in performance counters.
  3879. #
  3880. # This clause only supports fast acl types.
  3881. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  3882. #Default:
  3883. # Allow logging for all transactions.
  3884. # TAG: cache_store_log
  3885. # Logs the activities of the storage manager. Shows which
  3886. # objects are ejected from the cache, and which objects are
  3887. # saved and for how long.
  3888. # There are not really utilities to analyze this data, so you can safely
  3889. # disable it (the default).
  3890. #
  3891. # Store log uses modular logging outputs. See access_log for the list
  3892. # of modules supported.
  3893. #
  3894. # Example:
  3895. # cache_store_log stdio:/var/log/squid/store.log
  3896. # cache_store_log daemon:/var/log/squid/store.log
  3897. #Default:
  3898. # none
  3899. # TAG: cache_swap_state
  3900. # Location for the cache "swap.state" file. This index file holds
  3901. # the metadata of objects saved on disk. It is used to rebuild
  3902. # the cache during startup. Normally this file resides in each
  3903. # 'cache_dir' directory, but you may specify an alternate
  3904. # pathname here. Note you must give a full filename, not just
  3905. # a directory. Since this is the index for the whole object
  3906. # list you CANNOT periodically rotate it!
  3907. #
  3908. # If %s can be used in the file name it will be replaced with a
  3909. # a representation of the cache_dir name where each / is replaced
  3910. # with '.'. This is needed to allow adding/removing cache_dir
  3911. # lines when cache_swap_log is being used.
  3912. #
  3913. # If have more than one 'cache_dir', and %s is not used in the name
  3914. # these swap logs will have names such as:
  3915. #
  3916. # cache_swap_log.00
  3917. # cache_swap_log.01
  3918. # cache_swap_log.02
  3919. #
  3920. # The numbered extension (which is added automatically)
  3921. # corresponds to the order of the 'cache_dir' lines in this
  3922. # configuration file. If you change the order of the 'cache_dir'
  3923. # lines in this file, these index files will NOT correspond to
  3924. # the correct 'cache_dir' entry (unless you manually rename
  3925. # them). We recommend you do NOT use this option. It is
  3926. # better to keep these index files in each 'cache_dir' directory.
  3927. #Default:
  3928. # Store the journal inside its cache_dir
  3929. # TAG: logfile_rotate
  3930. # Specifies the number of logfile rotations to make when you
  3931. # type 'squid -k rotate'. The default is 10, which will rotate
  3932. # with extensions 0 through 9. Setting logfile_rotate to 0 will
  3933. # disable the file name rotation, but the logfiles are still closed
  3934. # and re-opened. This will enable you to rename the logfiles
  3935. # yourself just before sending the rotate signal.
  3936. #
  3937. # Note, the 'squid -k rotate' command normally sends a USR1
  3938. # signal to the running squid process. In certain situations
  3939. # (e.g. on Linux with Async I/O), USR1 is used for other
  3940. # purposes, so -k rotate uses another signal. It is best to get
  3941. # in the habit of using 'squid -k rotate' instead of 'kill -USR1
  3942. # <pid>'.
  3943. #
  3944. # Note, from Squid-3.1 this option is only a default for cache.log,
  3945. # that log can be rotated separately by using debug_options.
  3946. #
  3947. # Note2, for Debian/Linux the default of logfile_rotate is
  3948. # zero, since it includes external logfile-rotation methods.
  3949. #Default:
  3950. # logfile_rotate 0
  3951. # TAG: mime_table
  3952. # Path to Squid's icon configuration file.
  3953. #
  3954. # You shouldn't need to change this, but the default file contains
  3955. # examples and formatting information if you do.
  3956. #Default:
  3957. # mime_table /usr/share/squid/mime.conf
  3958. # TAG: log_mime_hdrs on|off
  3959. # The Cache can record both the request and the response MIME
  3960. # headers for each HTTP transaction. The headers are encoded
  3961. # safely and will appear as two bracketed fields at the end of
  3962. # the access log (for either the native or httpd-emulated log
  3963. # formats). To enable this logging set log_mime_hdrs to 'on'.
  3964. #Default:
  3965. # log_mime_hdrs off
  3966. # TAG: pid_filename
  3967. # A filename to write the process-id to. To disable, enter "none".
  3968. #Default:
  3969. # pid_filename /var/run/squid.pid
  3970. # TAG: client_netmask
  3971. # A netmask for client addresses in logfiles and cachemgr output.
  3972. # Change this to protect the privacy of your cache clients.
  3973. # A netmask of 255.255.255.0 will log all IP's in that range with
  3974. # the last digit set to '0'.
  3975. #Default:
  3976. # Log full client IP address
  3977. # TAG: strip_query_terms
  3978. # By default, Squid strips query terms from requested URLs before
  3979. # logging. This protects your user's privacy and reduces log size.
  3980. #
  3981. # When investigating HIT/MISS or other caching behaviour you
  3982. # will need to disable this to see the full URL used by Squid.
  3983. #Default:
  3984. # strip_query_terms on
  3985. # TAG: buffered_logs on|off
  3986. # Whether to write/send access_log records ASAP or accumulate them and
  3987. # then write/send them in larger chunks. Buffering may improve
  3988. # performance because it decreases the number of I/Os. However,
  3989. # buffering increases the delay before log records become available to
  3990. # the final recipient (e.g., a disk file or logging daemon) and,
  3991. # hence, increases the risk of log records loss.
  3992. #
  3993. # Note that even when buffered_logs are off, Squid may have to buffer
  3994. # records if it cannot write/send them immediately due to pending I/Os
  3995. # (e.g., the I/O writing the previous log record) or connectivity loss.
  3996. #
  3997. # Currently honored by 'daemon' and 'tcp' access_log modules only.
  3998. #Default:
  3999. # buffered_logs off
  4000. # TAG: netdb_filename
  4001. # Where Squid stores it's netdb journal.
  4002. # When enabled this journal preserves netdb state between restarts.
  4003. #
  4004. # To disable, enter "none".
  4005. #Default:
  4006. # netdb_filename stdio:/var/log/squid/netdb.state
  4007. # OPTIONS FOR TROUBLESHOOTING
  4008. # -----------------------------------------------------------------------------
  4009. # TAG: cache_log
  4010. # Squid administrative logging file.
  4011. #
  4012. # This is where general information about Squid behavior goes. You can
  4013. # increase the amount of data logged to this file and how often it is
  4014. # rotated with "debug_options"
  4015. #Default:
  4016. # cache_log /var/log/squid/cache.log
  4017. # TAG: debug_options
  4018. # Logging options are set as section,level where each source file
  4019. # is assigned a unique section. Lower levels result in less
  4020. # output, Full debugging (level 9) can result in a very large
  4021. # log file, so be careful.
  4022. #
  4023. # The magic word "ALL" sets debugging levels for all sections.
  4024. # The default is to run with "ALL,1" to record important warnings.
  4025. #
  4026. # The rotate=N option can be used to keep more or less of these logs
  4027. # than would otherwise be kept by logfile_rotate.
  4028. # For most uses a single log should be enough to monitor current
  4029. # events affecting Squid.
  4030. #Default:
  4031. # Log all critical and important messages.
  4032. # TAG: coredump_dir
  4033. # By default Squid leaves core files in the directory from where
  4034. # it was started. If you set 'coredump_dir' to a directory
  4035. # that exists, Squid will chdir() to that directory at startup
  4036. # and coredump files will be left there.
  4037. #
  4038. #Default:
  4039. # Use the directory from where Squid was started.
  4040. #
  4041. # Leave coredumps in the first cache dir
  4042. coredump_dir /var/spool/squid
  4043. # OPTIONS FOR FTP GATEWAYING
  4044. # -----------------------------------------------------------------------------
  4045. # TAG: ftp_user
  4046. # If you want the anonymous login password to be more informative
  4047. # (and enable the use of picky FTP servers), set this to something
  4048. # reasonable for your domain, like wwwuser@somewhere.net
  4049. #
  4050. # The reason why this is domainless by default is the
  4051. # request can be made on the behalf of a user in any domain,
  4052. # depending on how the cache is used.
  4053. # Some FTP server also validate the email address is valid
  4054. # (for example perl.com).
  4055. #Default:
  4056. # ftp_user Squid@
  4057. # TAG: ftp_passive
  4058. # If your firewall does not allow Squid to use passive
  4059. # connections, turn off this option.
  4060. #
  4061. # Use of ftp_epsv_all option requires this to be ON.
  4062. #Default:
  4063. # ftp_passive on
  4064. # TAG: ftp_epsv_all
  4065. # FTP Protocol extensions permit the use of a special "EPSV ALL" command.
  4066. #
  4067. # NATs may be able to put the connection on a "fast path" through the
  4068. # translator, as the EPRT command will never be used and therefore,
  4069. # translation of the data portion of the segments will never be needed.
  4070. #
  4071. # When a client only expects to do two-way FTP transfers this may be
  4072. # useful.
  4073. # If squid finds that it must do a three-way FTP transfer after issuing
  4074. # an EPSV ALL command, the FTP session will fail.
  4075. #
  4076. # If you have any doubts about this option do not use it.
  4077. # Squid will nicely attempt all other connection methods.
  4078. #
  4079. # Requires ftp_passive to be ON (default) for any effect.
  4080. #Default:
  4081. # ftp_epsv_all off
  4082. # TAG: ftp_epsv
  4083. # FTP Protocol extensions permit the use of a special "EPSV" command.
  4084. #
  4085. # NATs may be able to put the connection on a "fast path" through the
  4086. # translator using EPSV, as the EPRT command will never be used
  4087. # and therefore, translation of the data portion of the segments
  4088. # will never be needed.
  4089. #
  4090. # EPSV is often required to interoperate with FTP servers on IPv6
  4091. # networks. On the other hand, it may break some IPv4 servers.
  4092. #
  4093. # By default, EPSV may try EPSV with any FTP server. To fine tune
  4094. # that decision, you may restrict EPSV to certain clients or servers
  4095. # using ACLs:
  4096. #
  4097. # ftp_epsv allow|deny al1 acl2 ...
  4098. #
  4099. # WARNING: Disabling EPSV may cause problems with external NAT and IPv6.
  4100. #
  4101. # Only fast ACLs are supported.
  4102. # Requires ftp_passive to be ON (default) for any effect.
  4103. #Default:
  4104. # none
  4105. # TAG: ftp_eprt
  4106. # FTP Protocol extensions permit the use of a special "EPRT" command.
  4107. #
  4108. # This extension provides a protocol neutral alternative to the
  4109. # IPv4-only PORT command. When supported it enables active FTP data
  4110. # channels over IPv6 and efficient NAT handling.
  4111. #
  4112. # Turning this OFF will prevent EPRT being attempted and will skip
  4113. # straight to using PORT for IPv4 servers.
  4114. #
  4115. # Some devices are known to not handle this extension correctly and
  4116. # may result in crashes. Devices which suport EPRT enough to fail
  4117. # cleanly will result in Squid attempting PORT anyway. This directive
  4118. # should only be disabled when EPRT results in device failures.
  4119. #
  4120. # WARNING: Doing so will convert Squid back to the old behavior with all
  4121. # the related problems with external NAT devices/layers and IPv4-only FTP.
  4122. #Default:
  4123. # ftp_eprt on
  4124. # TAG: ftp_sanitycheck
  4125. # For security and data integrity reasons Squid by default performs
  4126. # sanity checks of the addresses of FTP data connections ensure the
  4127. # data connection is to the requested server. If you need to allow
  4128. # FTP connections to servers using another IP address for the data
  4129. # connection turn this off.
  4130. #Default:
  4131. # ftp_sanitycheck on
  4132. # TAG: ftp_telnet_protocol
  4133. # The FTP protocol is officially defined to use the telnet protocol
  4134. # as transport channel for the control connection. However, many
  4135. # implementations are broken and does not respect this aspect of
  4136. # the FTP protocol.
  4137. #
  4138. # If you have trouble accessing files with ASCII code 255 in the
  4139. # path or similar problems involving this ASCII code you can
  4140. # try setting this directive to off. If that helps, report to the
  4141. # operator of the FTP server in question that their FTP server
  4142. # is broken and does not follow the FTP standard.
  4143. #Default:
  4144. # ftp_telnet_protocol on
  4145. # OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
  4146. # -----------------------------------------------------------------------------
  4147. # TAG: diskd_program
  4148. # Specify the location of the diskd executable.
  4149. # Note this is only useful if you have compiled in
  4150. # diskd as one of the store io modules.
  4151. #Default:
  4152. # diskd_program /usr/lib/squid/diskd
  4153. # TAG: unlinkd_program
  4154. # Specify the location of the executable for file deletion process.
  4155. #Default:
  4156. # unlinkd_program /usr/lib/squid/unlinkd
  4157. # TAG: pinger_program
  4158. # Specify the location of the executable for the pinger process.
  4159. #Default:
  4160. # pinger_program /usr/lib/squid/pinger
  4161. # TAG: pinger_enable
  4162. # Control whether the pinger is active at run-time.
  4163. # Enables turning ICMP pinger on and off with a simple
  4164. # squid -k reconfigure.
  4165. #Default:
  4166. # pinger_enable on
  4167. # OPTIONS FOR URL REWRITING
  4168. # -----------------------------------------------------------------------------
  4169. # TAG: url_rewrite_program
  4170. # Specify the location of the executable URL rewriter to use.
  4171. # Since they can perform almost any function there isn't one included.
  4172. #
  4173. # For each requested URL, the rewriter will receive on line with the format
  4174. #
  4175. # [channel-ID <SP>] URL [<SP> extras]<NL>
  4176. #
  4177. # See url_rewrite_extras on how to send "extras" with optional values to
  4178. # the helper.
  4179. # After processing the request the helper must reply using the following format:
  4180. #
  4181. # [channel-ID <SP>] result [<SP> kv-pairs]
  4182. #
  4183. # The result code can be:
  4184. #
  4185. # OK status=30N url="..."
  4186. # Redirect the URL to the one supplied in 'url='.
  4187. # 'status=' is optional and contains the status code to send
  4188. # the client in Squids HTTP response. It must be one of the
  4189. # HTTP redirect status codes: 301, 302, 303, 307, 308.
  4190. # When no status is given Squid will use 302.
  4191. #
  4192. # OK rewrite-url="..."
  4193. # Rewrite the URL to the one supplied in 'rewrite-url='.
  4194. # The new URL is fetched directly by Squid and returned to
  4195. # the client as the response to its request.
  4196. #
  4197. # OK
  4198. # When neither of url= and rewrite-url= are sent Squid does
  4199. # not change the URL.
  4200. #
  4201. # ERR
  4202. # Do not change the URL.
  4203. #
  4204. # BH
  4205. # An internal error occurred in the helper, preventing
  4206. # a result being identified. The 'message=' key name is
  4207. # reserved for delivering a log message.
  4208. #
  4209. #
  4210. # In addition to the above kv-pairs Squid also understands the following
  4211. # optional kv-pairs received from URL rewriters:
  4212. # clt_conn_tag=TAG
  4213. # Associates a TAG with the client TCP connection.
  4214. # The TAG is treated as a regular annotation but persists across
  4215. # future requests on the client connection rather than just the
  4216. # current request. A helper may update the TAG during subsequent
  4217. # requests be returning a new kv-pair.
  4218. #
  4219. # When using the concurrency= option the protocol is changed by
  4220. # introducing a query channel tag in front of the request/response.
  4221. # The query channel tag is a number between 0 and concurrency-1.
  4222. # This value must be echoed back unchanged to Squid as the first part
  4223. # of the response relating to its request.
  4224. #
  4225. # WARNING: URL re-writing ability should be avoided whenever possible.
  4226. # Use the URL redirect form of response instead.
  4227. #
  4228. # Re-write creates a difference in the state held by the client
  4229. # and server. Possibly causing confusion when the server response
  4230. # contains snippets of its view state. Embeded URLs, response
  4231. # and content Location headers, etc. are not re-written by this
  4232. # interface.
  4233. #
  4234. # By default, a URL rewriter is not used.
  4235. #Default:
  4236. # none
  4237. # TAG: url_rewrite_children
  4238. # The maximum number of redirector processes to spawn. If you limit
  4239. # it too few Squid will have to wait for them to process a backlog of
  4240. # URLs, slowing it down. If you allow too many they will use RAM
  4241. # and other system resources noticably.
  4242. #
  4243. # The startup= and idle= options allow some measure of skew in your
  4244. # tuning.
  4245. #
  4246. # startup=
  4247. #
  4248. # Sets a minimum of how many processes are to be spawned when Squid
  4249. # starts or reconfigures. When set to zero the first request will
  4250. # cause spawning of the first child process to handle it.
  4251. #
  4252. # Starting too few will cause an initial slowdown in traffic as Squid
  4253. # attempts to simultaneously spawn enough processes to cope.
  4254. #
  4255. # idle=
  4256. #
  4257. # Sets a minimum of how many processes Squid is to try and keep available
  4258. # at all times. When traffic begins to rise above what the existing
  4259. # processes can handle this many more will be spawned up to the maximum
  4260. # configured. A minimum setting of 1 is required.
  4261. #
  4262. # concurrency=
  4263. #
  4264. # The number of requests each redirector helper can handle in
  4265. # parallel. Defaults to 0 which indicates the redirector
  4266. # is a old-style single threaded redirector.
  4267. #
  4268. # When this directive is set to a value >= 1 then the protocol
  4269. # used to communicate with the helper is modified to include
  4270. # an ID in front of the request/response. The ID from the request
  4271. # must be echoed back with the response to that request.
  4272. #Default:
  4273. # url_rewrite_children 20 startup=0 idle=1 concurrency=0
  4274. # TAG: url_rewrite_host_header
  4275. # To preserve same-origin security policies in browsers and
  4276. # prevent Host: header forgery by redirectors Squid rewrites
  4277. # any Host: header in redirected requests.
  4278. #
  4279. # If you are running an accelerator this may not be a wanted
  4280. # effect of a redirector. This directive enables you disable
  4281. # Host: alteration in reverse-proxy traffic.
  4282. #
  4283. # WARNING: Entries are cached on the result of the URL rewriting
  4284. # process, so be careful if you have domain-virtual hosts.
  4285. #
  4286. # WARNING: Squid and other software verifies the URL and Host
  4287. # are matching, so be careful not to relay through other proxies
  4288. # or inspecting firewalls with this disabled.
  4289. #Default:
  4290. # url_rewrite_host_header on
  4291. # TAG: url_rewrite_access
  4292. # If defined, this access list specifies which requests are
  4293. # sent to the redirector processes.
  4294. #
  4295. # This clause supports both fast and slow acl types.
  4296. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4297. #Default:
  4298. # Allow, unless rules exist in squid.conf.
  4299. # TAG: url_rewrite_bypass
  4300. # When this is 'on', a request will not go through the
  4301. # redirector if all the helpers are busy. If this is 'off'
  4302. # and the redirector queue grows too large, Squid will exit
  4303. # with a FATAL error and ask you to increase the number of
  4304. # redirectors. You should only enable this if the redirectors
  4305. # are not critical to your caching system. If you use
  4306. # redirectors for access control, and you enable this option,
  4307. # users may have access to pages they should not
  4308. # be allowed to request.
  4309. #Default:
  4310. # url_rewrite_bypass off
  4311. # TAG: url_rewrite_extras
  4312. # Specifies a string to be append to request line format for the
  4313. # rewriter helper. "Quoted" format values may contain spaces and
  4314. # logformat %macros. In theory, any logformat %macro can be used.
  4315. # In practice, a %macro expands as a dash (-) if the helper request is
  4316. # sent before the required macro information is available to Squid.
  4317. #Default:
  4318. # url_rewrite_extras "%>a/%>A %un %>rm myip=%la myport=%lp"
  4319. # OPTIONS FOR STORE ID
  4320. # -----------------------------------------------------------------------------
  4321. # TAG: store_id_program
  4322. # Specify the location of the executable StoreID helper to use.
  4323. # Since they can perform almost any function there isn't one included.
  4324. #
  4325. # For each requested URL, the helper will receive one line with the format
  4326. #
  4327. # [channel-ID <SP>] URL [<SP> extras]<NL>
  4328. #
  4329. #
  4330. # After processing the request the helper must reply using the following format:
  4331. #
  4332. # [channel-ID <SP>] result [<SP> kv-pairs]
  4333. #
  4334. # The result code can be:
  4335. #
  4336. # OK store-id="..."
  4337. # Use the StoreID supplied in 'store-id='.
  4338. #
  4339. # ERR
  4340. # The default is to use HTTP request URL as the store ID.
  4341. #
  4342. # BH
  4343. # An internal error occured in the helper, preventing
  4344. # a result being identified.
  4345. #
  4346. # In addition to the above kv-pairs Squid also understands the following
  4347. # optional kv-pairs received from URL rewriters:
  4348. # clt_conn_tag=TAG
  4349. # Associates a TAG with the client TCP connection.
  4350. # Please see url_rewrite_program related documentation for this
  4351. # kv-pair
  4352. #
  4353. # Helper programs should be prepared to receive and possibly ignore
  4354. # additional whitespace-separated tokens on each input line.
  4355. #
  4356. # When using the concurrency= option the protocol is changed by
  4357. # introducing a query channel tag in front of the request/response.
  4358. # The query channel tag is a number between 0 and concurrency-1.
  4359. # This value must be echoed back unchanged to Squid as the first part
  4360. # of the response relating to its request.
  4361. #
  4362. # NOTE: when using StoreID refresh_pattern will apply to the StoreID
  4363. # returned from the helper and not the URL.
  4364. #
  4365. # WARNING: Wrong StoreID value returned by a careless helper may result
  4366. # in the wrong cached response returned to the user.
  4367. #
  4368. # By default, a StoreID helper is not used.
  4369. #Default:
  4370. # none
  4371. # TAG: store_id_extras
  4372. # Specifies a string to be append to request line format for the
  4373. # StoreId helper. "Quoted" format values may contain spaces and
  4374. # logformat %macros. In theory, any logformat %macro can be used.
  4375. # In practice, a %macro expands as a dash (-) if the helper request is
  4376. # sent before the required macro information is available to Squid.
  4377. #Default:
  4378. # store_id_extras "%>a/%>A %un %>rm myip=%la myport=%lp"
  4379. # TAG: store_id_children
  4380. # The maximum number of StoreID helper processes to spawn. If you limit
  4381. # it too few Squid will have to wait for them to process a backlog of
  4382. # requests, slowing it down. If you allow too many they will use RAM
  4383. # and other system resources noticably.
  4384. #
  4385. # The startup= and idle= options allow some measure of skew in your
  4386. # tuning.
  4387. #
  4388. # startup=
  4389. #
  4390. # Sets a minimum of how many processes are to be spawned when Squid
  4391. # starts or reconfigures. When set to zero the first request will
  4392. # cause spawning of the first child process to handle it.
  4393. #
  4394. # Starting too few will cause an initial slowdown in traffic as Squid
  4395. # attempts to simultaneously spawn enough processes to cope.
  4396. #
  4397. # idle=
  4398. #
  4399. # Sets a minimum of how many processes Squid is to try and keep available
  4400. # at all times. When traffic begins to rise above what the existing
  4401. # processes can handle this many more will be spawned up to the maximum
  4402. # configured. A minimum setting of 1 is required.
  4403. #
  4404. # concurrency=
  4405. #
  4406. # The number of requests each storeID helper can handle in
  4407. # parallel. Defaults to 0 which indicates the helper
  4408. # is a old-style single threaded program.
  4409. #
  4410. # When this directive is set to a value >= 1 then the protocol
  4411. # used to communicate with the helper is modified to include
  4412. # an ID in front of the request/response. The ID from the request
  4413. # must be echoed back with the response to that request.
  4414. #Default:
  4415. # store_id_children 20 startup=0 idle=1 concurrency=0
  4416. # TAG: store_id_access
  4417. # If defined, this access list specifies which requests are
  4418. # sent to the StoreID processes. By default all requests
  4419. # are sent.
  4420. #
  4421. # This clause supports both fast and slow acl types.
  4422. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4423. #Default:
  4424. # Allow, unless rules exist in squid.conf.
  4425. # TAG: store_id_bypass
  4426. # When this is 'on', a request will not go through the
  4427. # helper if all helpers are busy. If this is 'off'
  4428. # and the helper queue grows too large, Squid will exit
  4429. # with a FATAL error and ask you to increase the number of
  4430. # helpers. You should only enable this if the helperss
  4431. # are not critical to your caching system. If you use
  4432. # helpers for critical caching components, and you enable this
  4433. # option, users may not get objects from cache.
  4434. #Default:
  4435. # store_id_bypass on
  4436. # OPTIONS FOR TUNING THE CACHE
  4437. # -----------------------------------------------------------------------------
  4438. # TAG: cache
  4439. # Requests denied by this directive will not be served from the cache
  4440. # and their responses will not be stored in the cache. This directive
  4441. # has no effect on other transactions and on already cached responses.
  4442. #
  4443. # This clause supports both fast and slow acl types.
  4444. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4445. #
  4446. # This and the two other similar caching directives listed below are
  4447. # checked at different transaction processing stages, have different
  4448. # access to response information, affect different cache operations,
  4449. # and differ in slow ACLs support:
  4450. #
  4451. # * cache: Checked before Squid makes a hit/miss determination.
  4452. # No access to reply information!
  4453. # Denies both serving a hit and storing a miss.
  4454. # Supports both fast and slow ACLs.
  4455. # * send_hit: Checked after a hit was detected.
  4456. # Has access to reply (hit) information.
  4457. # Denies serving a hit only.
  4458. # Supports fast ACLs only.
  4459. # * store_miss: Checked before storing a cachable miss.
  4460. # Has access to reply (miss) information.
  4461. # Denies storing a miss only.
  4462. # Supports fast ACLs only.
  4463. #
  4464. # If you are not sure which of the three directives to use, apply the
  4465. # following decision logic:
  4466. #
  4467. # * If your ACL(s) are of slow type _and_ need response info, redesign.
  4468. # Squid does not support that particular combination at this time.
  4469. # Otherwise:
  4470. # * If your directive ACL(s) are of slow type, use "cache"; and/or
  4471. # * if your directive ACL(s) need no response info, use "cache".
  4472. # Otherwise:
  4473. # * If you do not want the response cached, use store_miss; and/or
  4474. # * if you do not want a hit on a cached response, use send_hit.
  4475. #Default:
  4476. # By default, this directive is unused and has no effect.
  4477. # TAG: send_hit
  4478. # Responses denied by this directive will not be served from the cache
  4479. # (but may still be cached, see store_miss). This directive has no
  4480. # effect on the responses it allows and on the cached objects.
  4481. #
  4482. # Please see the "cache" directive for a summary of differences among
  4483. # store_miss, send_hit, and cache directives.
  4484. #
  4485. # Unlike the "cache" directive, send_hit only supports fast acl
  4486. # types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4487. #
  4488. # For example:
  4489. #
  4490. # # apply custom Store ID mapping to some URLs
  4491. # acl MapMe dstdomain .c.example.com
  4492. # store_id_program ...
  4493. # store_id_access allow MapMe
  4494. #
  4495. # # but prevent caching of special responses
  4496. # # such as 302 redirects that cause StoreID loops
  4497. # acl Ordinary http_status 200-299
  4498. # store_miss deny MapMe !Ordinary
  4499. #
  4500. # # and do not serve any previously stored special responses
  4501. # # from the cache (in case they were already cached before
  4502. # # the above store_miss rule was in effect).
  4503. # send_hit deny MapMe !Ordinary
  4504. #Default:
  4505. # By default, this directive is unused and has no effect.
  4506. # TAG: store_miss
  4507. # Responses denied by this directive will not be cached (but may still
  4508. # be served from the cache, see send_hit). This directive has no
  4509. # effect on the responses it allows and on the already cached responses.
  4510. #
  4511. # Please see the "cache" directive for a summary of differences among
  4512. # store_miss, send_hit, and cache directives. See the
  4513. # send_hit directive for a usage example.
  4514. #
  4515. # Unlike the "cache" directive, store_miss only supports fast acl
  4516. # types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4517. #Default:
  4518. # By default, this directive is unused and has no effect.
  4519. # TAG: max_stale time-units
  4520. # This option puts an upper limit on how stale content Squid
  4521. # will serve from the cache if cache validation fails.
  4522. # Can be overriden by the refresh_pattern max-stale option.
  4523. #Default:
  4524. # max_stale 1 week
  4525. # TAG: refresh_pattern
  4526. # usage: refresh_pattern [-i] regex min percent max [options]
  4527. #
  4528. # By default, regular expressions are CASE-SENSITIVE. To make
  4529. # them case-insensitive, use the -i option.
  4530. #
  4531. # 'Min' is the time (in minutes) an object without an explicit
  4532. # expiry time should be considered fresh. The recommended
  4533. # value is 0, any higher values may cause dynamic applications
  4534. # to be erroneously cached unless the application designer
  4535. # has taken the appropriate actions.
  4536. #
  4537. # 'Percent' is a percentage of the objects age (time since last
  4538. # modification age) an object without explicit expiry time
  4539. # will be considered fresh.
  4540. #
  4541. # 'Max' is an upper limit on how long objects without an explicit
  4542. # expiry time will be considered fresh.
  4543. #
  4544. # options: override-expire
  4545. # override-lastmod
  4546. # reload-into-ims
  4547. # ignore-reload
  4548. # ignore-no-store
  4549. # ignore-must-revalidate
  4550. # ignore-private
  4551. # ignore-auth
  4552. # max-stale=NN
  4553. # refresh-ims
  4554. # store-stale
  4555. #
  4556. # override-expire enforces min age even if the server
  4557. # sent an explicit expiry time (e.g., with the
  4558. # Expires: header or Cache-Control: max-age). Doing this
  4559. # VIOLATES the HTTP standard. Enabling this feature
  4560. # could make you liable for problems which it causes.
  4561. #
  4562. # Note: override-expire does not enforce staleness - it only extends
  4563. # freshness / min. If the server returns a Expires time which
  4564. # is longer than your max time, Squid will still consider
  4565. # the object fresh for that period of time.
  4566. #
  4567. # override-lastmod enforces min age even on objects
  4568. # that were modified recently.
  4569. #
  4570. # reload-into-ims changes a client no-cache or ``reload''
  4571. # request for a cached entry into a conditional request using
  4572. # If-Modified-Since and/or If-None-Match headers, provided the
  4573. # cached entry has a Last-Modified and/or a strong ETag header.
  4574. # Doing this VIOLATES the HTTP standard. Enabling this feature
  4575. # could make you liable for problems which it causes.
  4576. #
  4577. # ignore-reload ignores a client no-cache or ``reload''
  4578. # header. Doing this VIOLATES the HTTP standard. Enabling
  4579. # this feature could make you liable for problems which
  4580. # it causes.
  4581. #
  4582. # ignore-no-store ignores any ``Cache-control: no-store''
  4583. # headers received from a server. Doing this VIOLATES
  4584. # the HTTP standard. Enabling this feature could make you
  4585. # liable for problems which it causes.
  4586. #
  4587. # ignore-must-revalidate ignores any ``Cache-Control: must-revalidate``
  4588. # headers received from a server. Doing this VIOLATES
  4589. # the HTTP standard. Enabling this feature could make you
  4590. # liable for problems which it causes.
  4591. #
  4592. # ignore-private ignores any ``Cache-control: private''
  4593. # headers received from a server. Doing this VIOLATES
  4594. # the HTTP standard. Enabling this feature could make you
  4595. # liable for problems which it causes.
  4596. #
  4597. # ignore-auth caches responses to requests with authorization,
  4598. # as if the originserver had sent ``Cache-control: public''
  4599. # in the response header. Doing this VIOLATES the HTTP standard.
  4600. # Enabling this feature could make you liable for problems which
  4601. # it causes.
  4602. #
  4603. # refresh-ims causes squid to contact the origin server
  4604. # when a client issues an If-Modified-Since request. This
  4605. # ensures that the client will receive an updated version
  4606. # if one is available.
  4607. #
  4608. # store-stale stores responses even if they don't have explicit
  4609. # freshness or a validator (i.e., Last-Modified or an ETag)
  4610. # present, or if they're already stale. By default, Squid will
  4611. # not cache such responses because they usually can't be
  4612. # reused. Note that such responses will be stale by default.
  4613. #
  4614. # max-stale=NN provide a maximum staleness factor. Squid won't
  4615. # serve objects more stale than this even if it failed to
  4616. # validate the object. Default: use the max_stale global limit.
  4617. #
  4618. # Basically a cached object is:
  4619. #
  4620. # FRESH if expire > now, else STALE
  4621. # STALE if age > max
  4622. # FRESH if lm-factor < percent, else STALE
  4623. # FRESH if age < min
  4624. # else STALE
  4625. #
  4626. # The refresh_pattern lines are checked in the order listed here.
  4627. # The first entry which matches is used. If none of the entries
  4628. # match the default will be used.
  4629. #
  4630. # Note, you must uncomment all the default lines if you want
  4631. # to change one. The default setting is only active if none is
  4632. # used.
  4633. #
  4634. #
  4635. #
  4636. # Add any of your own refresh_pattern entries above these.
  4637. #
  4638. refresh_pattern ^ftp: 1440 20% 10080
  4639. refresh_pattern ^gopher: 1440 0% 1440
  4640. refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
  4641. refresh_pattern (Release|Packages(.gz)*)$ 0 20% 2880
  4642. # example lin deb packages
  4643. #refresh_pattern (\.deb|\.udeb)$ 129600 100% 129600
  4644. refresh_pattern . 0 20% 4320
  4645. refresh_pattern -i \.(gif|png|jpg|jpeg|ico)$ 3600 90% 43200
  4646. # TAG: quick_abort_min (KB)
  4647. #Default:
  4648. # quick_abort_min 16 KB
  4649. # TAG: quick_abort_max (KB)
  4650. #Default:
  4651. # quick_abort_max 16 KB
  4652. # TAG: quick_abort_pct (percent)
  4653. # The cache by default continues downloading aborted requests
  4654. # which are almost completed (less than 16 KB remaining). This
  4655. # may be undesirable on slow (e.g. SLIP) links and/or very busy
  4656. # caches. Impatient users may tie up file descriptors and
  4657. # bandwidth by repeatedly requesting and immediately aborting
  4658. # downloads.
  4659. #
  4660. # When the user aborts a request, Squid will check the
  4661. # quick_abort values to the amount of data transferred until
  4662. # then.
  4663. #
  4664. # If the transfer has less than 'quick_abort_min' KB remaining,
  4665. # it will finish the retrieval.
  4666. #
  4667. # If the transfer has more than 'quick_abort_max' KB remaining,
  4668. # it will abort the retrieval.
  4669. #
  4670. # If more than 'quick_abort_pct' of the transfer has completed,
  4671. # it will finish the retrieval.
  4672. #
  4673. # If you do not want any retrieval to continue after the client
  4674. # has aborted, set both 'quick_abort_min' and 'quick_abort_max'
  4675. # to '0 KB'.
  4676. #
  4677. # If you want retrievals to always continue if they are being
  4678. # cached set 'quick_abort_min' to '-1 KB'.
  4679. #Default:
  4680. # quick_abort_pct 95
  4681. # TAG: read_ahead_gap buffer-size
  4682. # The amount of data the cache will buffer ahead of what has been
  4683. # sent to the client when retrieving an object from another server.
  4684. #Default:
  4685. # read_ahead_gap 16 KB
  4686. # TAG: negative_ttl time-units
  4687. # Set the Default Time-to-Live (TTL) for failed requests.
  4688. # Certain types of failures (such as "connection refused" and
  4689. # "404 Not Found") are able to be negatively-cached for a short time.
  4690. # Modern web servers should provide Expires: header, however if they
  4691. # do not this can provide a minimum TTL.
  4692. # The default is not to cache errors with unknown expiry details.
  4693. #
  4694. # Note that this is different from negative caching of DNS lookups.
  4695. #
  4696. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  4697. # this feature could make you liable for problems which it
  4698. # causes.
  4699. #Default:
  4700. # negative_ttl 0 seconds
  4701. # TAG: positive_dns_ttl time-units
  4702. # Upper limit on how long Squid will cache positive DNS responses.
  4703. # Default is 6 hours (360 minutes). This directive must be set
  4704. # larger than negative_dns_ttl.
  4705. #Default:
  4706. # positive_dns_ttl 6 hours
  4707. # TAG: negative_dns_ttl time-units
  4708. # Time-to-Live (TTL) for negative caching of failed DNS lookups.
  4709. # This also sets the lower cache limit on positive lookups.
  4710. # Minimum value is 1 second, and it is not recommendable to go
  4711. # much below 10 seconds.
  4712. #Default:
  4713. # negative_dns_ttl 1 minutes
  4714. # TAG: range_offset_limit size [acl acl...]
  4715. # usage: (size) [units] [[!]aclname]
  4716. #
  4717. # Sets an upper limit on how far (number of bytes) into the file
  4718. # a Range request may be to cause Squid to prefetch the whole file.
  4719. # If beyond this limit, Squid forwards the Range request as it is and
  4720. # the result is NOT cached.
  4721. #
  4722. # This is to stop a far ahead range request (lets say start at 17MB)
  4723. # from making Squid fetch the whole object up to that point before
  4724. # sending anything to the client.
  4725. #
  4726. # Multiple range_offset_limit lines may be specified, and they will
  4727. # be searched from top to bottom on each request until a match is found.
  4728. # The first match found will be used. If no line matches a request, the
  4729. # default limit of 0 bytes will be used.
  4730. #
  4731. # 'size' is the limit specified as a number of units.
  4732. #
  4733. # 'units' specifies whether to use bytes, KB, MB, etc.
  4734. # If no units are specified bytes are assumed.
  4735. #
  4736. # A size of 0 causes Squid to never fetch more than the
  4737. # client requested. (default)
  4738. #
  4739. # A size of 'none' causes Squid to always fetch the object from the
  4740. # beginning so it may cache the result. (2.0 style)
  4741. #
  4742. # 'aclname' is the name of a defined ACL.
  4743. #
  4744. # NP: Using 'none' as the byte value here will override any quick_abort settings
  4745. # that may otherwise apply to the range request. The range request will
  4746. # be fully fetched from start to finish regardless of the client
  4747. # actions. This affects bandwidth usage.
  4748. #Default:
  4749. # none
  4750. # TAG: minimum_expiry_time (seconds)
  4751. # The minimum caching time according to (Expires - Date)
  4752. # headers Squid honors if the object can't be revalidated.
  4753. # The default is 60 seconds.
  4754. #
  4755. # In reverse proxy environments it might be desirable to honor
  4756. # shorter object lifetimes. It is most likely better to make
  4757. # your server return a meaningful Last-Modified header however.
  4758. #
  4759. # In ESI environments where page fragments often have short
  4760. # lifetimes, this will often be best set to 0.
  4761. #Default:
  4762. # minimum_expiry_time 60 seconds
  4763. # TAG: store_avg_object_size (bytes)
  4764. # Average object size, used to estimate number of objects your
  4765. # cache can hold. The default is 13 KB.
  4766. #
  4767. # This is used to pre-seed the cache index memory allocation to
  4768. # reduce expensive reallocate operations while handling clients
  4769. # traffic. Too-large values may result in memory allocation during
  4770. # peak traffic, too-small values will result in wasted memory.
  4771. #
  4772. # Check the cache manager 'info' report metrics for the real
  4773. # object sizes seen by your Squid before tuning this.
  4774. #Default:
  4775. # store_avg_object_size 13 KB
  4776. # TAG: store_objects_per_bucket
  4777. # Target number of objects per bucket in the store hash table.
  4778. # Lowering this value increases the total number of buckets and
  4779. # also the storage maintenance rate. The default is 20.
  4780. #Default:
  4781. # store_objects_per_bucket 20
  4782. # HTTP OPTIONS
  4783. # -----------------------------------------------------------------------------
  4784. # TAG: request_header_max_size (KB)
  4785. # This specifies the maximum size for HTTP headers in a request.
  4786. # Request headers are usually relatively small (about 512 bytes).
  4787. # Placing a limit on the request header size will catch certain
  4788. # bugs (for example with persistent connections) and possibly
  4789. # buffer-overflow or denial-of-service attacks.
  4790. #Default:
  4791. # request_header_max_size 64 KB
  4792. # TAG: reply_header_max_size (KB)
  4793. # This specifies the maximum size for HTTP headers in a reply.
  4794. # Reply headers are usually relatively small (about 512 bytes).
  4795. # Placing a limit on the reply header size will catch certain
  4796. # bugs (for example with persistent connections) and possibly
  4797. # buffer-overflow or denial-of-service attacks.
  4798. #Default:
  4799. # reply_header_max_size 64 KB
  4800. # TAG: request_body_max_size (bytes)
  4801. # This specifies the maximum size for an HTTP request body.
  4802. # In other words, the maximum size of a PUT/POST request.
  4803. # A user who attempts to send a request with a body larger
  4804. # than this limit receives an "Invalid Request" error message.
  4805. # If you set this parameter to a zero (the default), there will
  4806. # be no limit imposed.
  4807. #
  4808. # See also client_request_buffer_max_size for an alternative
  4809. # limitation on client uploads which can be configured.
  4810. #Default:
  4811. # No limit.
  4812. # TAG: client_request_buffer_max_size (bytes)
  4813. # This specifies the maximum buffer size of a client request.
  4814. # It prevents squid eating too much memory when somebody uploads
  4815. # a large file.
  4816. #Default:
  4817. # client_request_buffer_max_size 512 KB
  4818. # TAG: broken_posts
  4819. # A list of ACL elements which, if matched, causes Squid to send
  4820. # an extra CRLF pair after the body of a PUT/POST request.
  4821. #
  4822. # Some HTTP servers has broken implementations of PUT/POST,
  4823. # and rely on an extra CRLF pair sent by some WWW clients.
  4824. #
  4825. # Quote from RFC2616 section 4.1 on this matter:
  4826. #
  4827. # Note: certain buggy HTTP/1.0 client implementations generate an
  4828. # extra CRLF's after a POST request. To restate what is explicitly
  4829. # forbidden by the BNF, an HTTP/1.1 client must not preface or follow
  4830. # a request with an extra CRLF.
  4831. #
  4832. # This clause only supports fast acl types.
  4833. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4834. #
  4835. #Example:
  4836. # acl buggy_server url_regex ^http://....
  4837. # broken_posts allow buggy_server
  4838. #Default:
  4839. # Obey RFC 2616.
  4840. # TAG: adaptation_uses_indirect_client on|off
  4841. # Controls whether the indirect client IP address (instead of the direct
  4842. # client IP address) is passed to adaptation services.
  4843. #
  4844. # See also: follow_x_forwarded_for adaptation_send_client_ip
  4845. #Default:
  4846. # adaptation_uses_indirect_client on
  4847. # TAG: via on|off
  4848. # If set (default), Squid will include a Via header in requests and
  4849. # replies as required by RFC2616.
  4850. #Default:
  4851. # via on
  4852. # TAG: ie_refresh on|off
  4853. # Microsoft Internet Explorer up until version 5.5 Service
  4854. # Pack 1 has an issue with transparent proxies, wherein it
  4855. # is impossible to force a refresh. Turning this on provides
  4856. # a partial fix to the problem, by causing all IMS-REFRESH
  4857. # requests from older IE versions to check the origin server
  4858. # for fresh content. This reduces hit ratio by some amount
  4859. # (~10% in my experience), but allows users to actually get
  4860. # fresh content when they want it. Note because Squid
  4861. # cannot tell if the user is using 5.5 or 5.5SP1, the behavior
  4862. # of 5.5 is unchanged from old versions of Squid (i.e. a
  4863. # forced refresh is impossible). Newer versions of IE will,
  4864. # hopefully, continue to have the new behavior and will be
  4865. # handled based on that assumption. This option defaults to
  4866. # the old Squid behavior, which is better for hit ratios but
  4867. # worse for clients using IE, if they need to be able to
  4868. # force fresh content.
  4869. #Default:
  4870. # ie_refresh off
  4871. # TAG: vary_ignore_expire on|off
  4872. # Many HTTP servers supporting Vary gives such objects
  4873. # immediate expiry time with no cache-control header
  4874. # when requested by a HTTP/1.0 client. This option
  4875. # enables Squid to ignore such expiry times until
  4876. # HTTP/1.1 is fully implemented.
  4877. #
  4878. # WARNING: If turned on this may eventually cause some
  4879. # varying objects not intended for caching to get cached.
  4880. #Default:
  4881. # vary_ignore_expire off
  4882. # TAG: request_entities
  4883. # Squid defaults to deny GET and HEAD requests with request entities,
  4884. # as the meaning of such requests are undefined in the HTTP standard
  4885. # even if not explicitly forbidden.
  4886. #
  4887. # Set this directive to on if you have clients which insists
  4888. # on sending request entities in GET or HEAD requests. But be warned
  4889. # that there is server software (both proxies and web servers) which
  4890. # can fail to properly process this kind of request which may make you
  4891. # vulnerable to cache pollution attacks if enabled.
  4892. #Default:
  4893. # request_entities off
  4894. # TAG: request_header_access
  4895. # Usage: request_header_access header_name allow|deny [!]aclname ...
  4896. #
  4897. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  4898. # this feature could make you liable for problems which it
  4899. # causes.
  4900. #
  4901. # This option replaces the old 'anonymize_headers' and the
  4902. # older 'http_anonymizer' option with something that is much
  4903. # more configurable. A list of ACLs for each header name allows
  4904. # removal of specific header fields under specific conditions.
  4905. #
  4906. # This option only applies to outgoing HTTP request headers (i.e.,
  4907. # headers sent by Squid to the next HTTP hop such as a cache peer
  4908. # or an origin server). The option has no effect during cache hit
  4909. # detection. The equivalent adaptation vectoring point in ICAP
  4910. # terminology is post-cache REQMOD.
  4911. #
  4912. # The option is applied to individual outgoing request header
  4913. # fields. For each request header field F, Squid uses the first
  4914. # qualifying sets of request_header_access rules:
  4915. #
  4916. # 1. Rules with header_name equal to F's name.
  4917. # 2. Rules with header_name 'Other', provided F's name is not
  4918. # on the hard-coded list of commonly used HTTP header names.
  4919. # 3. Rules with header_name 'All'.
  4920. #
  4921. # Within that qualifying rule set, rule ACLs are checked as usual.
  4922. # If ACLs of an "allow" rule match, the header field is allowed to
  4923. # go through as is. If ACLs of a "deny" rule match, the header is
  4924. # removed and request_header_replace is then checked to identify
  4925. # if the removed header has a replacement. If no rules within the
  4926. # set have matching ACLs, the header field is left as is.
  4927. #
  4928. # For example, to achieve the same behavior as the old
  4929. # 'http_anonymizer standard' option, you should use:
  4930. #
  4931. # request_header_access From deny all
  4932. # request_header_access Referer deny all
  4933. # request_header_access User-Agent deny all
  4934. #
  4935. # Or, to reproduce the old 'http_anonymizer paranoid' feature
  4936. # you should use:
  4937. #
  4938. # request_header_access Authorization allow all
  4939. # request_header_access Proxy-Authorization allow all
  4940. # request_header_access Cache-Control allow all
  4941. # request_header_access Content-Length allow all
  4942. # request_header_access Content-Type allow all
  4943. # request_header_access Date allow all
  4944. # request_header_access Host allow all
  4945. # request_header_access If-Modified-Since allow all
  4946. # request_header_access Pragma allow all
  4947. # request_header_access Accept allow all
  4948. # request_header_access Accept-Charset allow all
  4949. # request_header_access Accept-Encoding allow all
  4950. # request_header_access Accept-Language allow all
  4951. # request_header_access Connection allow all
  4952. # request_header_access All deny all
  4953. #
  4954. # HTTP reply headers are controlled with the reply_header_access directive.
  4955. #
  4956. # By default, all headers are allowed (no anonymizing is performed).
  4957. #Default:
  4958. # No limits.
  4959. # TAG: reply_header_access
  4960. # Usage: reply_header_access header_name allow|deny [!]aclname ...
  4961. #
  4962. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  4963. # this feature could make you liable for problems which it
  4964. # causes.
  4965. #
  4966. # This option only applies to reply headers, i.e., from the
  4967. # server to the client.
  4968. #
  4969. # This is the same as request_header_access, but in the other
  4970. # direction. Please see request_header_access for detailed
  4971. # documentation.
  4972. #
  4973. # For example, to achieve the same behavior as the old
  4974. # 'http_anonymizer standard' option, you should use:
  4975. #
  4976. # reply_header_access Server deny all
  4977. # reply_header_access WWW-Authenticate deny all
  4978. # reply_header_access Link deny all
  4979. #
  4980. # Or, to reproduce the old 'http_anonymizer paranoid' feature
  4981. # you should use:
  4982. #
  4983. # reply_header_access Allow allow all
  4984. # reply_header_access WWW-Authenticate allow all
  4985. # reply_header_access Proxy-Authenticate allow all
  4986. # reply_header_access Cache-Control allow all
  4987. # reply_header_access Content-Encoding allow all
  4988. # reply_header_access Content-Length allow all
  4989. # reply_header_access Content-Type allow all
  4990. # reply_header_access Date allow all
  4991. # reply_header_access Expires allow all
  4992. # reply_header_access Last-Modified allow all
  4993. # reply_header_access Location allow all
  4994. # reply_header_access Pragma allow all
  4995. # reply_header_access Content-Language allow all
  4996. # reply_header_access Retry-After allow all
  4997. # reply_header_access Title allow all
  4998. # reply_header_access Content-Disposition allow all
  4999. # reply_header_access Connection allow all
  5000. # reply_header_access All deny all
  5001. #
  5002. # HTTP request headers are controlled with the request_header_access directive.
  5003. #
  5004. # By default, all headers are allowed (no anonymizing is
  5005. # performed).
  5006. #Default:
  5007. # No limits.
  5008. # TAG: request_header_replace
  5009. # Usage: request_header_replace header_name message
  5010. # Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
  5011. #
  5012. # This option allows you to change the contents of headers
  5013. # denied with request_header_access above, by replacing them
  5014. # with some fixed string.
  5015. #
  5016. # This only applies to request headers, not reply headers.
  5017. #
  5018. # By default, headers are removed if denied.
  5019. #Default:
  5020. # none
  5021. # TAG: reply_header_replace
  5022. # Usage: reply_header_replace header_name message
  5023. # Example: reply_header_replace Server Foo/1.0
  5024. #
  5025. # This option allows you to change the contents of headers
  5026. # denied with reply_header_access above, by replacing them
  5027. # with some fixed string.
  5028. #
  5029. # This only applies to reply headers, not request headers.
  5030. #
  5031. # By default, headers are removed if denied.
  5032. #Default:
  5033. # none
  5034. # TAG: request_header_add
  5035. # Usage: request_header_add field-name field-value acl1 [acl2] ...
  5036. # Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
  5037. #
  5038. # This option adds header fields to outgoing HTTP requests (i.e.,
  5039. # request headers sent by Squid to the next HTTP hop such as a
  5040. # cache peer or an origin server). The option has no effect during
  5041. # cache hit detection. The equivalent adaptation vectoring point
  5042. # in ICAP terminology is post-cache REQMOD.
  5043. #
  5044. # Field-name is a token specifying an HTTP header name. If a
  5045. # standard HTTP header name is used, Squid does not check whether
  5046. # the new header conflicts with any existing headers or violates
  5047. # HTTP rules. If the request to be modified already contains a
  5048. # field with the same name, the old field is preserved but the
  5049. # header field values are not merged.
  5050. #
  5051. # Field-value is either a token or a quoted string. If quoted
  5052. # string format is used, then the surrounding quotes are removed
  5053. # while escape sequences and %macros are processed.
  5054. #
  5055. # In theory, all of the logformat codes can be used as %macros.
  5056. # However, unlike logging (which happens at the very end of
  5057. # transaction lifetime), the transaction may not yet have enough
  5058. # information to expand a macro when the new header value is needed.
  5059. # And some information may already be available to Squid but not yet
  5060. # committed where the macro expansion code can access it (report
  5061. # such instances!). The macro will be expanded into a single dash
  5062. # ('-') in such cases. Not all macros have been tested.
  5063. #
  5064. # One or more Squid ACLs may be specified to restrict header
  5065. # injection to matching requests. As always in squid.conf, all
  5066. # ACLs in an option ACL list must be satisfied for the insertion
  5067. # to happen. The request_header_add option supports fast ACLs
  5068. # only.
  5069. #Default:
  5070. # none
  5071. # TAG: note
  5072. # This option used to log custom information about the master
  5073. # transaction. For example, an admin may configure Squid to log
  5074. # which "user group" the transaction belongs to, where "user group"
  5075. # will be determined based on a set of ACLs and not [just]
  5076. # authentication information.
  5077. # Values of key/value pairs can be logged using %{key}note macros:
  5078. #
  5079. # note key value acl ...
  5080. # logformat myFormat ... %{key}note ...
  5081. #Default:
  5082. # none
  5083. # TAG: relaxed_header_parser on|off|warn
  5084. # In the default "on" setting Squid accepts certain forms
  5085. # of non-compliant HTTP messages where it is unambiguous
  5086. # what the sending application intended even if the message
  5087. # is not correctly formatted. The messages is then normalized
  5088. # to the correct form when forwarded by Squid.
  5089. #
  5090. # If set to "warn" then a warning will be emitted in cache.log
  5091. # each time such HTTP error is encountered.
  5092. #
  5093. # If set to "off" then such HTTP errors will cause the request
  5094. # or response to be rejected.
  5095. #Default:
  5096. # relaxed_header_parser on
  5097. # TAG: collapsed_forwarding (on|off)
  5098. # This option controls whether Squid is allowed to merge multiple
  5099. # potentially cachable requests for the same URI before Squid knows
  5100. # whether the response is going to be cachable.
  5101. #
  5102. # This feature is disabled by default: Enabling collapsed forwarding
  5103. # needlessly delays forwarding requests that look cachable (when they are
  5104. # collapsed) but then need to be forwarded individually anyway because
  5105. # they end up being for uncachable content. However, in some cases, such
  5106. # as accelleration of highly cachable content with periodic or groupped
  5107. # expiration times, the gains from collapsing [large volumes of
  5108. # simultenous refresh requests] outweigh losses from such delays.
  5109. #Default:
  5110. # collapsed_forwarding off
  5111. # TIMEOUTS
  5112. # -----------------------------------------------------------------------------
  5113. # TAG: forward_timeout time-units
  5114. # This parameter specifies how long Squid should at most attempt in
  5115. # finding a forwarding path for the request before giving up.
  5116. #Default:
  5117. # forward_timeout 4 minutes
  5118. # TAG: connect_timeout time-units
  5119. # This parameter specifies how long to wait for the TCP connect to
  5120. # the requested server or peer to complete before Squid should
  5121. # attempt to find another path where to forward the request.
  5122. #Default:
  5123. # connect_timeout 1 minute
  5124. # TAG: peer_connect_timeout time-units
  5125. # This parameter specifies how long to wait for a pending TCP
  5126. # connection to a peer cache. The default is 30 seconds. You
  5127. # may also set different timeout values for individual neighbors
  5128. # with the 'connect-timeout' option on a 'cache_peer' line.
  5129. #Default:
  5130. # peer_connect_timeout 30 seconds
  5131. # TAG: read_timeout time-units
  5132. # Applied on peer server connections.
  5133. #
  5134. # After each successful read(), the timeout will be extended by this
  5135. # amount. If no data is read again after this amount of time,
  5136. # the request is aborted and logged with ERR_READ_TIMEOUT.
  5137. #
  5138. # The default is 15 minutes.
  5139. #Default:
  5140. # read_timeout 15 minutes
  5141. # TAG: write_timeout time-units
  5142. # This timeout is tracked for all connections that have data
  5143. # available for writing and are waiting for the socket to become
  5144. # ready. After each successful write, the timeout is extended by
  5145. # the configured amount. If Squid has data to write but the
  5146. # connection is not ready for the configured duration, the
  5147. # transaction associated with the connection is terminated. The
  5148. # default is 15 minutes.
  5149. #Default:
  5150. # write_timeout 15 minutes
  5151. # TAG: request_timeout
  5152. # How long to wait for complete HTTP request headers after initial
  5153. # connection establishment.
  5154. #Default:
  5155. # request_timeout 5 minutes
  5156. # TAG: client_idle_pconn_timeout
  5157. # How long to wait for the next HTTP request on a persistent
  5158. # client connection after the previous request completes.
  5159. #Default:
  5160. # client_idle_pconn_timeout 2 minutes
  5161. # TAG: ftp_client_idle_timeout
  5162. # How long to wait for an FTP request on a connection to Squid ftp_port.
  5163. # Many FTP clients do not deal with idle connection closures well,
  5164. # necessitating a longer default timeout than client_idle_pconn_timeout
  5165. # used for incoming HTTP requests.
  5166. #Default:
  5167. # ftp_client_idle_timeout 30 minutes
  5168. # TAG: client_lifetime time-units
  5169. # The maximum amount of time a client (browser) is allowed to
  5170. # remain connected to the cache process. This protects the Cache
  5171. # from having a lot of sockets (and hence file descriptors) tied up
  5172. # in a CLOSE_WAIT state from remote clients that go away without
  5173. # properly shutting down (either because of a network failure or
  5174. # because of a poor client implementation). The default is one
  5175. # day, 1440 minutes.
  5176. #
  5177. # NOTE: The default value is intended to be much larger than any
  5178. # client would ever need to be connected to your cache. You
  5179. # should probably change client_lifetime only as a last resort.
  5180. # If you seem to have many client connections tying up
  5181. # filedescriptors, we recommend first tuning the read_timeout,
  5182. # request_timeout, persistent_request_timeout and quick_abort values.
  5183. #Default:
  5184. # client_lifetime 1 day
  5185. # TAG: half_closed_clients
  5186. # Some clients may shutdown the sending side of their TCP
  5187. # connections, while leaving their receiving sides open. Sometimes,
  5188. # Squid can not tell the difference between a half-closed and a
  5189. # fully-closed TCP connection.
  5190. #
  5191. # By default, Squid will immediately close client connections when
  5192. # read(2) returns "no more data to read."
  5193. #
  5194. # Change this option to 'on' and Squid will keep open connections
  5195. # until a read(2) or write(2) on the socket returns an error.
  5196. # This may show some benefits for reverse proxies. But if not
  5197. # it is recommended to leave OFF.
  5198. #Default:
  5199. # half_closed_clients off
  5200. # TAG: server_idle_pconn_timeout
  5201. # Timeout for idle persistent connections to servers and other
  5202. # proxies.
  5203. #Default:
  5204. # server_idle_pconn_timeout 1 minute
  5205. # TAG: ident_timeout
  5206. # Maximum time to wait for IDENT lookups to complete.
  5207. #
  5208. # If this is too high, and you enabled IDENT lookups from untrusted
  5209. # users, you might be susceptible to denial-of-service by having
  5210. # many ident requests going at once.
  5211. #Default:
  5212. # ident_timeout 10 seconds
  5213. # TAG: shutdown_lifetime time-units
  5214. # When SIGTERM or SIGHUP is received, the cache is put into
  5215. # "shutdown pending" mode until all active sockets are closed.
  5216. # This value is the lifetime to set for all open descriptors
  5217. # during shutdown mode. Any active clients after this many
  5218. # seconds will receive a 'timeout' message.
  5219. #Default:
  5220. # shutdown_lifetime 30 seconds
  5221. # ADMINISTRATIVE PARAMETERS
  5222. # -----------------------------------------------------------------------------
  5223. # TAG: cache_mgr
  5224. # Email-address of local cache manager who will receive
  5225. # mail if the cache dies. The default is "webmaster".
  5226. #Default:
  5227. # cache_mgr webmaster
  5228. # TAG: mail_from
  5229. # From: email-address for mail sent when the cache dies.
  5230. # The default is to use 'squid@unique_hostname'.
  5231. #
  5232. # See also: unique_hostname directive.
  5233. #Default:
  5234. # none
  5235. # TAG: mail_program
  5236. # Email program used to send mail if the cache dies.
  5237. # The default is "mail". The specified program must comply
  5238. # with the standard Unix mail syntax:
  5239. # mail-program recipient < mailfile
  5240. #
  5241. # Optional command line options can be specified.
  5242. #Default:
  5243. # mail_program mail
  5244. # TAG: cache_effective_user
  5245. # If you start Squid as root, it will change its effective/real
  5246. # UID/GID to the user specified below. The default is to change
  5247. # to UID of proxy.
  5248. # see also; cache_effective_group
  5249. #Default:
  5250. # cache_effective_user proxy
  5251. # TAG: cache_effective_group
  5252. # Squid sets the GID to the effective user's default group ID
  5253. # (taken from the password file) and supplementary group list
  5254. # from the groups membership.
  5255. #
  5256. # If you want Squid to run with a specific GID regardless of
  5257. # the group memberships of the effective user then set this
  5258. # to the group (or GID) you want Squid to run as. When set
  5259. # all other group privileges of the effective user are ignored
  5260. # and only this GID is effective. If Squid is not started as
  5261. # root the user starting Squid MUST be member of the specified
  5262. # group.
  5263. #
  5264. # This option is not recommended by the Squid Team.
  5265. # Our preference is for administrators to configure a secure
  5266. # user account for squid with UID/GID matching system policies.
  5267. #Default:
  5268. # Use system group memberships of the cache_effective_user account
  5269. # TAG: httpd_suppress_version_string on|off
  5270. # Suppress Squid version string info in HTTP headers and HTML error pages.
  5271. #Default:
  5272. # httpd_suppress_version_string off
  5273. # TAG: visible_hostname
  5274. # If you want to present a special hostname in error messages, etc,
  5275. # define this. Otherwise, the return value of gethostname()
  5276. # will be used. If you have multiple caches in a cluster and
  5277. # get errors about IP-forwarding you must set them to have individual
  5278. # names with this setting.
  5279. #Default:
  5280. # Automatically detect the system host name
  5281. # TAG: unique_hostname
  5282. # If you want to have multiple machines with the same
  5283. # 'visible_hostname' you must give each machine a different
  5284. # 'unique_hostname' so forwarding loops can be detected.
  5285. #Default:
  5286. # Copy the value from visible_hostname
  5287. # TAG: hostname_aliases
  5288. # A list of other DNS names your cache has.
  5289. #Default:
  5290. # none
  5291. # TAG: umask
  5292. # Minimum umask which should be enforced while the proxy
  5293. # is running, in addition to the umask set at startup.
  5294. #
  5295. # For a traditional octal representation of umasks, start
  5296. # your value with 0.
  5297. #Default:
  5298. # umask 027
  5299. # OPTIONS FOR THE CACHE REGISTRATION SERVICE
  5300. # -----------------------------------------------------------------------------
  5301. #
  5302. # This section contains parameters for the (optional) cache
  5303. # announcement service. This service is provided to help
  5304. # cache administrators locate one another in order to join or
  5305. # create cache hierarchies.
  5306. #
  5307. # An 'announcement' message is sent (via UDP) to the registration
  5308. # service by Squid. By default, the announcement message is NOT
  5309. # SENT unless you enable it with 'announce_period' below.
  5310. #
  5311. # The announcement message includes your hostname, plus the
  5312. # following information from this configuration file:
  5313. #
  5314. # http_port
  5315. # icp_port
  5316. # cache_mgr
  5317. #
  5318. # All current information is processed regularly and made
  5319. # available on the Web at http://www.ircache.net/Cache/Tracker/.
  5320. # TAG: announce_period
  5321. # This is how frequently to send cache announcements.
  5322. #
  5323. # To enable announcing your cache, just set an announce period.
  5324. #
  5325. # Example:
  5326. # announce_period 1 day
  5327. #Default:
  5328. # Announcement messages disabled.
  5329. # TAG: announce_host
  5330. # Set the hostname where announce registration messages will be sent.
  5331. #
  5332. # See also announce_port and announce_file
  5333. #Default:
  5334. # announce_host tracker.ircache.net
  5335. # TAG: announce_file
  5336. # The contents of this file will be included in the announce
  5337. # registration messages.
  5338. #Default:
  5339. # none
  5340. # TAG: announce_port
  5341. # Set the port where announce registration messages will be sent.
  5342. #
  5343. # See also announce_host and announce_file
  5344. #Default:
  5345. # announce_port 3131
  5346. # HTTPD-ACCELERATOR OPTIONS
  5347. # -----------------------------------------------------------------------------
  5348. # TAG: httpd_accel_surrogate_id
  5349. # Surrogates (http://www.esi.org/architecture_spec_1.0.html)
  5350. # need an identification token to allow control targeting. Because
  5351. # a farm of surrogates may all perform the same tasks, they may share
  5352. # an identification token.
  5353. #Default:
  5354. # visible_hostname is used if no specific ID is set.
  5355. # TAG: http_accel_surrogate_remote on|off
  5356. # Remote surrogates (such as those in a CDN) honour the header
  5357. # "Surrogate-Control: no-store-remote".
  5358. #
  5359. # Set this to on to have squid behave as a remote surrogate.
  5360. #Default:
  5361. # http_accel_surrogate_remote off
  5362. # TAG: esi_parser libxml2|expat|custom
  5363. # ESI markup is not strictly XML compatible. The custom ESI parser
  5364. # will give higher performance, but cannot handle non ASCII character
  5365. # encodings.
  5366. #Default:
  5367. # esi_parser custom
  5368. # DELAY POOL PARAMETERS
  5369. # -----------------------------------------------------------------------------
  5370. # TAG: delay_pools
  5371. # This represents the number of delay pools to be used. For example,
  5372. # if you have one class 2 delay pool and one class 3 delays pool, you
  5373. # have a total of 2 delay pools.
  5374. #
  5375. # See also delay_parameters, delay_class, delay_access for pool
  5376. # configuration details.
  5377. #Default:
  5378. # delay_pools 0
  5379. # TAG: delay_class
  5380. # This defines the class of each delay pool. There must be exactly one
  5381. # delay_class line for each delay pool. For example, to define two
  5382. # delay pools, one of class 2 and one of class 3, the settings above
  5383. # and here would be:
  5384. #
  5385. # Example:
  5386. # delay_pools 4 # 4 delay pools
  5387. # delay_class 1 2 # pool 1 is a class 2 pool
  5388. # delay_class 2 3 # pool 2 is a class 3 pool
  5389. # delay_class 3 4 # pool 3 is a class 4 pool
  5390. # delay_class 4 5 # pool 4 is a class 5 pool
  5391. #
  5392. # The delay pool classes are:
  5393. #
  5394. # class 1 Everything is limited by a single aggregate
  5395. # bucket.
  5396. #
  5397. # class 2 Everything is limited by a single aggregate
  5398. # bucket as well as an "individual" bucket chosen
  5399. # from bits 25 through 32 of the IPv4 address.
  5400. #
  5401. # class 3 Everything is limited by a single aggregate
  5402. # bucket as well as a "network" bucket chosen
  5403. # from bits 17 through 24 of the IP address and a
  5404. # "individual" bucket chosen from bits 17 through
  5405. # 32 of the IPv4 address.
  5406. #
  5407. # class 4 Everything in a class 3 delay pool, with an
  5408. # additional limit on a per user basis. This
  5409. # only takes effect if the username is established
  5410. # in advance - by forcing authentication in your
  5411. # http_access rules.
  5412. #
  5413. # class 5 Requests are grouped according their tag (see
  5414. # external_acl's tag= reply).
  5415. #
  5416. #
  5417. # Each pool also requires a delay_parameters directive to configure the pool size
  5418. # and speed limits used whenever the pool is applied to a request. Along with
  5419. # a set of delay_access directives to determine when it is used.
  5420. #
  5421. # NOTE: If an IP address is a.b.c.d
  5422. # -> bits 25 through 32 are "d"
  5423. # -> bits 17 through 24 are "c"
  5424. # -> bits 17 through 32 are "c * 256 + d"
  5425. #
  5426. # NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
  5427. # IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
  5428. #
  5429. # This clause only supports fast acl types.
  5430. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5431. #
  5432. # See also delay_parameters and delay_access.
  5433. #Default:
  5434. # none
  5435. # TAG: delay_access
  5436. # This is used to determine which delay pool a request falls into.
  5437. #
  5438. # delay_access is sorted per pool and the matching starts with pool 1,
  5439. # then pool 2, ..., and finally pool N. The first delay pool where the
  5440. # request is allowed is selected for the request. If it does not allow
  5441. # the request to any pool then the request is not delayed (default).
  5442. #
  5443. # For example, if you want some_big_clients in delay
  5444. # pool 1 and lotsa_little_clients in delay pool 2:
  5445. #
  5446. # delay_access 1 allow some_big_clients
  5447. # delay_access 1 deny all
  5448. # delay_access 2 allow lotsa_little_clients
  5449. # delay_access 2 deny all
  5450. # delay_access 3 allow authenticated_clients
  5451. #
  5452. # See also delay_parameters and delay_class.
  5453. #
  5454. #Default:
  5455. # Deny using the pool, unless allow rules exist in squid.conf for the pool.
  5456. # TAG: delay_parameters
  5457. # This defines the parameters for a delay pool. Each delay pool has
  5458. # a number of "buckets" associated with it, as explained in the
  5459. # description of delay_class.
  5460. #
  5461. # For a class 1 delay pool, the syntax is:
  5462. # delay_class pool 1
  5463. # delay_parameters pool aggregate
  5464. #
  5465. # For a class 2 delay pool:
  5466. # delay_class pool 2
  5467. # delay_parameters pool aggregate individual
  5468. #
  5469. # For a class 3 delay pool:
  5470. # delay_class pool 3
  5471. # delay_parameters pool aggregate network individual
  5472. #
  5473. # For a class 4 delay pool:
  5474. # delay_class pool 4
  5475. # delay_parameters pool aggregate network individual user
  5476. #
  5477. # For a class 5 delay pool:
  5478. # delay_class pool 5
  5479. # delay_parameters pool tagrate
  5480. #
  5481. # The option variables are:
  5482. #
  5483. # pool a pool number - ie, a number between 1 and the
  5484. # number specified in delay_pools as used in
  5485. # delay_class lines.
  5486. #
  5487. # aggregate the speed limit parameters for the aggregate bucket
  5488. # (class 1, 2, 3).
  5489. #
  5490. # individual the speed limit parameters for the individual
  5491. # buckets (class 2, 3).
  5492. #
  5493. # network the speed limit parameters for the network buckets
  5494. # (class 3).
  5495. #
  5496. # user the speed limit parameters for the user buckets
  5497. # (class 4).
  5498. #
  5499. # tagrate the speed limit parameters for the tag buckets
  5500. # (class 5).
  5501. #
  5502. # A pair of delay parameters is written restore/maximum, where restore is
  5503. # the number of bytes (not bits - modem and network speeds are usually
  5504. # quoted in bits) per second placed into the bucket, and maximum is the
  5505. # maximum number of bytes which can be in the bucket at any time.
  5506. #
  5507. # There must be one delay_parameters line for each delay pool.
  5508. #
  5509. #
  5510. # For example, if delay pool number 1 is a class 2 delay pool as in the
  5511. # above example, and is being used to strictly limit each host to 64Kbit/sec
  5512. # (plus overheads), with no overall limit, the line is:
  5513. #
  5514. # delay_parameters 1 none 8000/8000
  5515. #
  5516. # Note that 8 x 8K Byte/sec -> 64K bit/sec.
  5517. #
  5518. # Note that the word 'none' is used to represent no limit.
  5519. #
  5520. #
  5521. # And, if delay pool number 2 is a class 3 delay pool as in the above
  5522. # example, and you want to limit it to a total of 256Kbit/sec (strict limit)
  5523. # with each 8-bit network permitted 64Kbit/sec (strict limit) and each
  5524. # individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
  5525. # to permit a decent web page to be downloaded at a decent speed
  5526. # (if the network is not being limited due to overuse) but slow down
  5527. # large downloads more significantly:
  5528. #
  5529. # delay_parameters 2 32000/32000 8000/8000 600/8000
  5530. #
  5531. # Note that 8 x 32K Byte/sec -> 256K bit/sec.
  5532. # 8 x 8K Byte/sec -> 64K bit/sec.
  5533. # 8 x 600 Byte/sec -> 4800 bit/sec.
  5534. #
  5535. #
  5536. # Finally, for a class 4 delay pool as in the example - each user will
  5537. # be limited to 128Kbits/sec no matter how many workstations they are logged into.:
  5538. #
  5539. # delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
  5540. #
  5541. #
  5542. # See also delay_class and delay_access.
  5543. #
  5544. #Default:
  5545. # none
  5546. # TAG: delay_initial_bucket_level (percent, 0-100)
  5547. # The initial bucket percentage is used to determine how much is put
  5548. # in each bucket when squid starts, is reconfigured, or first notices
  5549. # a host accessing it (in class 2 and class 3, individual hosts and
  5550. # networks only have buckets associated with them once they have been
  5551. # "seen" by squid).
  5552. #Default:
  5553. # delay_initial_bucket_level 50
  5554. # CLIENT DELAY POOL PARAMETERS
  5555. # -----------------------------------------------------------------------------
  5556. # TAG: client_delay_pools
  5557. # This option specifies the number of client delay pools used. It must
  5558. # preceed other client_delay_* options.
  5559. #
  5560. # Example:
  5561. # client_delay_pools 2
  5562. #
  5563. # See also client_delay_parameters and client_delay_access.
  5564. #Default:
  5565. # client_delay_pools 0
  5566. # TAG: client_delay_initial_bucket_level (percent, 0-no_limit)
  5567. # This option determines the initial bucket size as a percentage of
  5568. # max_bucket_size from client_delay_parameters. Buckets are created
  5569. # at the time of the "first" connection from the matching IP. Idle
  5570. # buckets are periodically deleted up.
  5571. #
  5572. # You can specify more than 100 percent but note that such "oversized"
  5573. # buckets are not refilled until their size goes down to max_bucket_size
  5574. # from client_delay_parameters.
  5575. #
  5576. # Example:
  5577. # client_delay_initial_bucket_level 50
  5578. #Default:
  5579. # client_delay_initial_bucket_level 50
  5580. # TAG: client_delay_parameters
  5581. #
  5582. # This option configures client-side bandwidth limits using the
  5583. # following format:
  5584. #
  5585. # client_delay_parameters pool speed_limit max_bucket_size
  5586. #
  5587. # pool is an integer ID used for client_delay_access matching.
  5588. #
  5589. # speed_limit is bytes added to the bucket per second.
  5590. #
  5591. # max_bucket_size is the maximum size of a bucket, enforced after any
  5592. # speed_limit additions.
  5593. #
  5594. # Please see the delay_parameters option for more information and
  5595. # examples.
  5596. #
  5597. # Example:
  5598. # client_delay_parameters 1 1024 2048
  5599. # client_delay_parameters 2 51200 16384
  5600. #
  5601. # See also client_delay_access.
  5602. #
  5603. #Default:
  5604. # none
  5605. # TAG: client_delay_access
  5606. # This option determines the client-side delay pool for the
  5607. # request:
  5608. #
  5609. # client_delay_access pool_ID allow|deny acl_name
  5610. #
  5611. # All client_delay_access options are checked in their pool ID
  5612. # order, starting with pool 1. The first checked pool with allowed
  5613. # request is selected for the request. If no ACL matches or there
  5614. # are no client_delay_access options, the request bandwidth is not
  5615. # limited.
  5616. #
  5617. # The ACL-selected pool is then used to find the
  5618. # client_delay_parameters for the request. Client-side pools are
  5619. # not used to aggregate clients. Clients are always aggregated
  5620. # based on their source IP addresses (one bucket per source IP).
  5621. #
  5622. # This clause only supports fast acl types.
  5623. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5624. # Additionally, only the client TCP connection details are available.
  5625. # ACLs testing HTTP properties will not work.
  5626. #
  5627. # Please see delay_access for more examples.
  5628. #
  5629. # Example:
  5630. # client_delay_access 1 allow low_rate_network
  5631. # client_delay_access 2 allow vips_network
  5632. #
  5633. #
  5634. # See also client_delay_parameters and client_delay_pools.
  5635. #Default:
  5636. # Deny use of the pool, unless allow rules exist in squid.conf for the pool.
  5637. # WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
  5638. # -----------------------------------------------------------------------------
  5639. # TAG: wccp_router
  5640. # Use this option to define your WCCP ``home'' router for
  5641. # Squid.
  5642. #
  5643. # wccp_router supports a single WCCP(v1) router
  5644. #
  5645. # wccp2_router supports multiple WCCPv2 routers
  5646. #
  5647. # only one of the two may be used at the same time and defines
  5648. # which version of WCCP to use.
  5649. #Default:
  5650. # WCCP disabled.
  5651. # TAG: wccp2_router
  5652. # Use this option to define your WCCP ``home'' router for
  5653. # Squid.
  5654. #
  5655. # wccp_router supports a single WCCP(v1) router
  5656. #
  5657. # wccp2_router supports multiple WCCPv2 routers
  5658. #
  5659. # only one of the two may be used at the same time and defines
  5660. # which version of WCCP to use.
  5661. #Default:
  5662. # WCCPv2 disabled.
  5663. # TAG: wccp_version
  5664. # This directive is only relevant if you need to set up WCCP(v1)
  5665. # to some very old and end-of-life Cisco routers. In all other
  5666. # setups it must be left unset or at the default setting.
  5667. # It defines an internal version in the WCCP(v1) protocol,
  5668. # with version 4 being the officially documented protocol.
  5669. #
  5670. # According to some users, Cisco IOS 11.2 and earlier only
  5671. # support WCCP version 3. If you're using that or an earlier
  5672. # version of IOS, you may need to change this value to 3, otherwise
  5673. # do not specify this parameter.
  5674. #Default:
  5675. # wccp_version 4
  5676. # TAG: wccp2_rebuild_wait
  5677. # If this is enabled Squid will wait for the cache dir rebuild to finish
  5678. # before sending the first wccp2 HereIAm packet
  5679. #Default:
  5680. # wccp2_rebuild_wait on
  5681. # TAG: wccp2_forwarding_method
  5682. # WCCP2 allows the setting of forwarding methods between the
  5683. # router/switch and the cache. Valid values are as follows:
  5684. #
  5685. # gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
  5686. # l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
  5687. #
  5688. # Currently (as of IOS 12.4) cisco routers only support GRE.
  5689. # Cisco switches only support the L2 redirect assignment method.
  5690. #Default:
  5691. # wccp2_forwarding_method gre
  5692. # TAG: wccp2_return_method
  5693. # WCCP2 allows the setting of return methods between the
  5694. # router/switch and the cache for packets that the cache
  5695. # decides not to handle. Valid values are as follows:
  5696. #
  5697. # gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
  5698. # l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
  5699. #
  5700. # Currently (as of IOS 12.4) cisco routers only support GRE.
  5701. # Cisco switches only support the L2 redirect assignment.
  5702. #
  5703. # If the "ip wccp redirect exclude in" command has been
  5704. # enabled on the cache interface, then it is still safe for
  5705. # the proxy server to use a l2 redirect method even if this
  5706. # option is set to GRE.
  5707. #Default:
  5708. # wccp2_return_method gre
  5709. # TAG: wccp2_assignment_method
  5710. # WCCP2 allows the setting of methods to assign the WCCP hash
  5711. # Valid values are as follows:
  5712. #
  5713. # hash - Hash assignment
  5714. # mask - Mask assignment
  5715. #
  5716. # As a general rule, cisco routers support the hash assignment method
  5717. # and cisco switches support the mask assignment method.
  5718. #Default:
  5719. # wccp2_assignment_method hash
  5720. # TAG: wccp2_service
  5721. # WCCP2 allows for multiple traffic services. There are two
  5722. # types: "standard" and "dynamic". The standard type defines
  5723. # one service id - http (id 0). The dynamic service ids can be from
  5724. # 51 to 255 inclusive. In order to use a dynamic service id
  5725. # one must define the type of traffic to be redirected; this is done
  5726. # using the wccp2_service_info option.
  5727. #
  5728. # The "standard" type does not require a wccp2_service_info option,
  5729. # just specifying the service id will suffice.
  5730. #
  5731. # MD5 service authentication can be enabled by adding
  5732. # "password=<password>" to the end of this service declaration.
  5733. #
  5734. # Examples:
  5735. #
  5736. # wccp2_service standard 0 # for the 'web-cache' standard service
  5737. # wccp2_service dynamic 80 # a dynamic service type which will be
  5738. # # fleshed out with subsequent options.
  5739. # wccp2_service standard 0 password=foo
  5740. #Default:
  5741. # Use the 'web-cache' standard service.
  5742. # TAG: wccp2_service_info
  5743. # Dynamic WCCPv2 services require further information to define the
  5744. # traffic you wish to have diverted.
  5745. #
  5746. # The format is:
  5747. #
  5748. # wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
  5749. # priority=<priority> ports=<port>,<port>..
  5750. #
  5751. # The relevant WCCPv2 flags:
  5752. # + src_ip_hash, dst_ip_hash
  5753. # + source_port_hash, dst_port_hash
  5754. # + src_ip_alt_hash, dst_ip_alt_hash
  5755. # + src_port_alt_hash, dst_port_alt_hash
  5756. # + ports_source
  5757. #
  5758. # The port list can be one to eight entries.
  5759. #
  5760. # Example:
  5761. #
  5762. # wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
  5763. # priority=240 ports=80
  5764. #
  5765. # Note: the service id must have been defined by a previous
  5766. # 'wccp2_service dynamic <id>' entry.
  5767. #Default:
  5768. # none
  5769. # TAG: wccp2_weight
  5770. # Each cache server gets assigned a set of the destination
  5771. # hash proportional to their weight.
  5772. #Default:
  5773. # wccp2_weight 10000
  5774. # TAG: wccp_address
  5775. # Use this option if you require WCCPv2 to use a specific
  5776. # interface address.
  5777. #
  5778. # The default behavior is to not bind to any specific address.
  5779. #Default:
  5780. # Address selected by the operating system.
  5781. # TAG: wccp2_address
  5782. # Use this option if you require WCCP to use a specific
  5783. # interface address.
  5784. #
  5785. # The default behavior is to not bind to any specific address.
  5786. #Default:
  5787. # Address selected by the operating system.
  5788. # PERSISTENT CONNECTION HANDLING
  5789. # -----------------------------------------------------------------------------
  5790. #
  5791. # Also see "pconn_timeout" in the TIMEOUTS section
  5792. # TAG: client_persistent_connections
  5793. # Persistent connection support for clients.
  5794. # Squid uses persistent connections (when allowed). You can use
  5795. # this option to disable persistent connections with clients.
  5796. #Default:
  5797. # client_persistent_connections on
  5798. # TAG: server_persistent_connections
  5799. # Persistent connection support for servers.
  5800. # Squid uses persistent connections (when allowed). You can use
  5801. # this option to disable persistent connections with servers.
  5802. #Default:
  5803. # server_persistent_connections on
  5804. # TAG: persistent_connection_after_error
  5805. # With this directive the use of persistent connections after
  5806. # HTTP errors can be disabled. Useful if you have clients
  5807. # who fail to handle errors on persistent connections proper.
  5808. #Default:
  5809. # persistent_connection_after_error on
  5810. # TAG: detect_broken_pconn
  5811. # Some servers have been found to incorrectly signal the use
  5812. # of HTTP/1.0 persistent connections even on replies not
  5813. # compatible, causing significant delays. This server problem
  5814. # has mostly been seen on redirects.
  5815. #
  5816. # By enabling this directive Squid attempts to detect such
  5817. # broken replies and automatically assume the reply is finished
  5818. # after 10 seconds timeout.
  5819. #Default:
  5820. # detect_broken_pconn off
  5821. # CACHE DIGEST OPTIONS
  5822. # -----------------------------------------------------------------------------
  5823. # TAG: digest_generation
  5824. # This controls whether the server will generate a Cache Digest
  5825. # of its contents. By default, Cache Digest generation is
  5826. # enabled if Squid is compiled with --enable-cache-digests defined.
  5827. #Default:
  5828. # digest_generation on
  5829. # TAG: digest_bits_per_entry
  5830. # This is the number of bits of the server's Cache Digest which
  5831. # will be associated with the Digest entry for a given HTTP
  5832. # Method and URL (public key) combination. The default is 5.
  5833. #Default:
  5834. # digest_bits_per_entry 5
  5835. # TAG: digest_rebuild_period (seconds)
  5836. # This is the wait time between Cache Digest rebuilds.
  5837. #Default:
  5838. # digest_rebuild_period 1 hour
  5839. # TAG: digest_rewrite_period (seconds)
  5840. # This is the wait time between Cache Digest writes to
  5841. # disk.
  5842. #Default:
  5843. # digest_rewrite_period 1 hour
  5844. # TAG: digest_swapout_chunk_size (bytes)
  5845. # This is the number of bytes of the Cache Digest to write to
  5846. # disk at a time. It defaults to 4096 bytes (4KB), the Squid
  5847. # default swap page.
  5848. #Default:
  5849. # digest_swapout_chunk_size 4096 bytes
  5850. # TAG: digest_rebuild_chunk_percentage (percent, 0-100)
  5851. # This is the percentage of the Cache Digest to be scanned at a
  5852. # time. By default it is set to 10% of the Cache Digest.
  5853. #Default:
  5854. # digest_rebuild_chunk_percentage 10
  5855. # SNMP OPTIONS
  5856. # -----------------------------------------------------------------------------
  5857. # TAG: snmp_port
  5858. # The port number where Squid listens for SNMP requests. To enable
  5859. # SNMP support set this to a suitable port number. Port number
  5860. # 3401 is often used for the Squid SNMP agent. By default it's
  5861. # set to "0" (disabled)
  5862. #
  5863. # Example:
  5864. # snmp_port 3401
  5865. #Default:
  5866. # SNMP disabled.
  5867. # TAG: snmp_access
  5868. # Allowing or denying access to the SNMP port.
  5869. #
  5870. # All access to the agent is denied by default.
  5871. # usage:
  5872. #
  5873. # snmp_access allow|deny [!]aclname ...
  5874. #
  5875. # This clause only supports fast acl types.
  5876. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5877. #
  5878. #Example:
  5879. # snmp_access allow snmppublic localhost
  5880. # snmp_access deny all
  5881. #Default:
  5882. # Deny, unless rules exist in squid.conf.
  5883. # TAG: snmp_incoming_address
  5884. # Just like 'udp_incoming_address', but for the SNMP port.
  5885. #
  5886. # snmp_incoming_address is used for the SNMP socket receiving
  5887. # messages from SNMP agents.
  5888. #
  5889. # The default snmp_incoming_address is to listen on all
  5890. # available network interfaces.
  5891. #Default:
  5892. # Accept SNMP packets from all machine interfaces.
  5893. # TAG: snmp_outgoing_address
  5894. # Just like 'udp_outgoing_address', but for the SNMP port.
  5895. #
  5896. # snmp_outgoing_address is used for SNMP packets returned to SNMP
  5897. # agents.
  5898. #
  5899. # If snmp_outgoing_address is not set it will use the same socket
  5900. # as snmp_incoming_address. Only change this if you want to have
  5901. # SNMP replies sent using another address than where this Squid
  5902. # listens for SNMP queries.
  5903. #
  5904. # NOTE, snmp_incoming_address and snmp_outgoing_address can not have
  5905. # the same value since they both use the same port.
  5906. #Default:
  5907. # Use snmp_incoming_address or an address selected by the operating system.
  5908. # ICP OPTIONS
  5909. # -----------------------------------------------------------------------------
  5910. # TAG: icp_port
  5911. # The port number where Squid sends and receives ICP queries to
  5912. # and from neighbor caches. The standard UDP port for ICP is 3130.
  5913. #
  5914. # Example:
  5915. # icp_port 3130
  5916. #Default:
  5917. # ICP disabled.
  5918. # TAG: htcp_port
  5919. # The port number where Squid sends and receives HTCP queries to
  5920. # and from neighbor caches. To turn it on you want to set it to
  5921. # 4827.
  5922. #
  5923. # Example:
  5924. # htcp_port 4827
  5925. #Default:
  5926. # HTCP disabled.
  5927. # TAG: log_icp_queries on|off
  5928. # If set, ICP queries are logged to access.log. You may wish
  5929. # do disable this if your ICP load is VERY high to speed things
  5930. # up or to simplify log analysis.
  5931. #Default:
  5932. # log_icp_queries on
  5933. # TAG: udp_incoming_address
  5934. # udp_incoming_address is used for UDP packets received from other
  5935. # caches.
  5936. #
  5937. # The default behavior is to not bind to any specific address.
  5938. #
  5939. # Only change this if you want to have all UDP queries received on
  5940. # a specific interface/address.
  5941. #
  5942. # NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
  5943. # modules. Altering it will affect all of them in the same manner.
  5944. #
  5945. # see also; udp_outgoing_address
  5946. #
  5947. # NOTE, udp_incoming_address and udp_outgoing_address can not
  5948. # have the same value since they both use the same port.
  5949. #Default:
  5950. # Accept packets from all machine interfaces.
  5951. # TAG: udp_outgoing_address
  5952. # udp_outgoing_address is used for UDP packets sent out to other
  5953. # caches.
  5954. #
  5955. # The default behavior is to not bind to any specific address.
  5956. #
  5957. # Instead it will use the same socket as udp_incoming_address.
  5958. # Only change this if you want to have UDP queries sent using another
  5959. # address than where this Squid listens for UDP queries from other
  5960. # caches.
  5961. #
  5962. # NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
  5963. # modules. Altering it will affect all of them in the same manner.
  5964. #
  5965. # see also; udp_incoming_address
  5966. #
  5967. # NOTE, udp_incoming_address and udp_outgoing_address can not
  5968. # have the same value since they both use the same port.
  5969. #Default:
  5970. # Use udp_incoming_address or an address selected by the operating system.
  5971. # TAG: icp_hit_stale on|off
  5972. # If you want to return ICP_HIT for stale cache objects, set this
  5973. # option to 'on'. If you have sibling relationships with caches
  5974. # in other administrative domains, this should be 'off'. If you only
  5975. # have sibling relationships with caches under your control,
  5976. # it is probably okay to set this to 'on'.
  5977. # If set to 'on', your siblings should use the option "allow-miss"
  5978. # on their cache_peer lines for connecting to you.
  5979. #Default:
  5980. # icp_hit_stale off
  5981. # TAG: minimum_direct_hops
  5982. # If using the ICMP pinging stuff, do direct fetches for sites
  5983. # which are no more than this many hops away.
  5984. #Default:
  5985. # minimum_direct_hops 4
  5986. # TAG: minimum_direct_rtt (msec)
  5987. # If using the ICMP pinging stuff, do direct fetches for sites
  5988. # which are no more than this many rtt milliseconds away.
  5989. #Default:
  5990. # minimum_direct_rtt 400
  5991. # TAG: netdb_low
  5992. # The low water mark for the ICMP measurement database.
  5993. #
  5994. # Note: high watermark controlled by netdb_high directive.
  5995. #
  5996. # These watermarks are counts, not percents. The defaults are
  5997. # (low) 900 and (high) 1000. When the high water mark is
  5998. # reached, database entries will be deleted until the low
  5999. # mark is reached.
  6000. #Default:
  6001. # netdb_low 900
  6002. # TAG: netdb_high
  6003. # The high water mark for the ICMP measurement database.
  6004. #
  6005. # Note: low watermark controlled by netdb_low directive.
  6006. #
  6007. # These watermarks are counts, not percents. The defaults are
  6008. # (low) 900 and (high) 1000. When the high water mark is
  6009. # reached, database entries will be deleted until the low
  6010. # mark is reached.
  6011. #Default:
  6012. # netdb_high 1000
  6013. # TAG: netdb_ping_period
  6014. # The minimum period for measuring a site. There will be at
  6015. # least this much delay between successive pings to the same
  6016. # network. The default is five minutes.
  6017. #Default:
  6018. # netdb_ping_period 5 minutes
  6019. # TAG: query_icmp on|off
  6020. # If you want to ask your peers to include ICMP data in their ICP
  6021. # replies, enable this option.
  6022. #
  6023. # If your peer has configured Squid (during compilation) with
  6024. # '--enable-icmp' that peer will send ICMP pings to origin server
  6025. # sites of the URLs it receives. If you enable this option the
  6026. # ICP replies from that peer will include the ICMP data (if available).
  6027. # Then, when choosing a parent cache, Squid will choose the parent with
  6028. # the minimal RTT to the origin server. When this happens, the
  6029. # hierarchy field of the access.log will be
  6030. # "CLOSEST_PARENT_MISS". This option is off by default.
  6031. #Default:
  6032. # query_icmp off
  6033. # TAG: test_reachability on|off
  6034. # When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
  6035. # instead of ICP_MISS if the target host is NOT in the ICMP
  6036. # database, or has a zero RTT.
  6037. #Default:
  6038. # test_reachability off
  6039. # TAG: icp_query_timeout (msec)
  6040. # Normally Squid will automatically determine an optimal ICP
  6041. # query timeout value based on the round-trip-time of recent ICP
  6042. # queries. If you want to override the value determined by
  6043. # Squid, set this 'icp_query_timeout' to a non-zero value. This
  6044. # value is specified in MILLISECONDS, so, to use a 2-second
  6045. # timeout (the old default), you would write:
  6046. #
  6047. # icp_query_timeout 2000
  6048. #Default:
  6049. # Dynamic detection.
  6050. # TAG: maximum_icp_query_timeout (msec)
  6051. # Normally the ICP query timeout is determined dynamically. But
  6052. # sometimes it can lead to very large values (say 5 seconds).
  6053. # Use this option to put an upper limit on the dynamic timeout
  6054. # value. Do NOT use this option to always use a fixed (instead
  6055. # of a dynamic) timeout value. To set a fixed timeout see the
  6056. # 'icp_query_timeout' directive.
  6057. #Default:
  6058. # maximum_icp_query_timeout 2000
  6059. # TAG: minimum_icp_query_timeout (msec)
  6060. # Normally the ICP query timeout is determined dynamically. But
  6061. # sometimes it can lead to very small timeouts, even lower than
  6062. # the normal latency variance on your link due to traffic.
  6063. # Use this option to put an lower limit on the dynamic timeout
  6064. # value. Do NOT use this option to always use a fixed (instead
  6065. # of a dynamic) timeout value. To set a fixed timeout see the
  6066. # 'icp_query_timeout' directive.
  6067. #Default:
  6068. # minimum_icp_query_timeout 5
  6069. # TAG: background_ping_rate time-units
  6070. # Controls how often the ICP pings are sent to siblings that
  6071. # have background-ping set.
  6072. #Default:
  6073. # background_ping_rate 10 seconds
  6074. # MULTICAST ICP OPTIONS
  6075. # -----------------------------------------------------------------------------
  6076. # TAG: mcast_groups
  6077. # This tag specifies a list of multicast groups which your server
  6078. # should join to receive multicasted ICP queries.
  6079. #
  6080. # NOTE! Be very careful what you put here! Be sure you
  6081. # understand the difference between an ICP _query_ and an ICP
  6082. # _reply_. This option is to be set only if you want to RECEIVE
  6083. # multicast queries. Do NOT set this option to SEND multicast
  6084. # ICP (use cache_peer for that). ICP replies are always sent via
  6085. # unicast, so this option does not affect whether or not you will
  6086. # receive replies from multicast group members.
  6087. #
  6088. # You must be very careful to NOT use a multicast address which
  6089. # is already in use by another group of caches.
  6090. #
  6091. # If you are unsure about multicast, please read the Multicast
  6092. # chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
  6093. #
  6094. # Usage: mcast_groups 239.128.16.128 224.0.1.20
  6095. #
  6096. # By default, Squid doesn't listen on any multicast groups.
  6097. #Default:
  6098. # none
  6099. # TAG: mcast_miss_addr
  6100. # Note: This option is only available if Squid is rebuilt with the
  6101. # -DMULTICAST_MISS_STREAM define
  6102. #
  6103. # If you enable this option, every "cache miss" URL will
  6104. # be sent out on the specified multicast address.
  6105. #
  6106. # Do not enable this option unless you are are absolutely
  6107. # certain you understand what you are doing.
  6108. #Default:
  6109. # disabled.
  6110. # TAG: mcast_miss_ttl
  6111. # Note: This option is only available if Squid is rebuilt with the
  6112. # -DMULTICAST_MISS_STREAM define
  6113. #
  6114. # This is the time-to-live value for packets multicasted
  6115. # when multicasting off cache miss URLs is enabled. By
  6116. # default this is set to 'site scope', i.e. 16.
  6117. #Default:
  6118. # mcast_miss_ttl 16
  6119. # TAG: mcast_miss_port
  6120. # Note: This option is only available if Squid is rebuilt with the
  6121. # -DMULTICAST_MISS_STREAM define
  6122. #
  6123. # This is the port number to be used in conjunction with
  6124. # 'mcast_miss_addr'.
  6125. #Default:
  6126. # mcast_miss_port 3135
  6127. # TAG: mcast_miss_encode_key
  6128. # Note: This option is only available if Squid is rebuilt with the
  6129. # -DMULTICAST_MISS_STREAM define
  6130. #
  6131. # The URLs that are sent in the multicast miss stream are
  6132. # encrypted. This is the encryption key.
  6133. #Default:
  6134. # mcast_miss_encode_key XXXXXXXXXXXXXXXX
  6135. # TAG: mcast_icp_query_timeout (msec)
  6136. # For multicast peers, Squid regularly sends out ICP "probes" to
  6137. # count how many other peers are listening on the given multicast
  6138. # address. This value specifies how long Squid should wait to
  6139. # count all the replies. The default is 2000 msec, or 2
  6140. # seconds.
  6141. #Default:
  6142. # mcast_icp_query_timeout 2000
  6143. # INTERNAL ICON OPTIONS
  6144. # -----------------------------------------------------------------------------
  6145. # TAG: icon_directory
  6146. # Where the icons are stored. These are normally kept in
  6147. # /usr/share/squid/icons
  6148. #Default:
  6149. # icon_directory /usr/share/squid/icons
  6150. # TAG: global_internal_static
  6151. # This directive controls is Squid should intercept all requests for
  6152. # /squid-internal-static/ no matter which host the URL is requesting
  6153. # (default on setting), or if nothing special should be done for
  6154. # such URLs (off setting). The purpose of this directive is to make
  6155. # icons etc work better in complex cache hierarchies where it may
  6156. # not always be possible for all corners in the cache mesh to reach
  6157. # the server generating a directory listing.
  6158. #Default:
  6159. # global_internal_static on
  6160. # TAG: short_icon_urls
  6161. # If this is enabled Squid will use short URLs for icons.
  6162. # If disabled it will revert to the old behavior of including
  6163. # it's own name and port in the URL.
  6164. #
  6165. # If you run a complex cache hierarchy with a mix of Squid and
  6166. # other proxies you may need to disable this directive.
  6167. #Default:
  6168. # short_icon_urls on
  6169. # ERROR PAGE OPTIONS
  6170. # -----------------------------------------------------------------------------
  6171. # TAG: error_directory
  6172. # If you wish to create your own versions of the default
  6173. # error files to customize them to suit your company copy
  6174. # the error/template files to another directory and point
  6175. # this tag at them.
  6176. #
  6177. # WARNING: This option will disable multi-language support
  6178. # on error pages if used.
  6179. #
  6180. # The squid developers are interested in making squid available in
  6181. # a wide variety of languages. If you are making translations for a
  6182. # language that Squid does not currently provide please consider
  6183. # contributing your translation back to the project.
  6184. # http://wiki.squid-cache.org/Translations
  6185. #
  6186. # The squid developers working on translations are happy to supply drop-in
  6187. # translated error files in exchange for any new language contributions.
  6188. #Default:
  6189. # Send error pages in the clients preferred language
  6190. # TAG: error_default_language
  6191. # Set the default language which squid will send error pages in
  6192. # if no existing translation matches the clients language
  6193. # preferences.
  6194. #
  6195. # If unset (default) generic English will be used.
  6196. #
  6197. # The squid developers are interested in making squid available in
  6198. # a wide variety of languages. If you are interested in making
  6199. # translations for any language see the squid wiki for details.
  6200. # http://wiki.squid-cache.org/Translations
  6201. #Default:
  6202. # Generate English language pages.
  6203. # TAG: error_log_languages
  6204. # Log to cache.log what languages users are attempting to
  6205. # auto-negotiate for translations.
  6206. #
  6207. # Successful negotiations are not logged. Only failures
  6208. # have meaning to indicate that Squid may need an upgrade
  6209. # of its error page translations.
  6210. #Default:
  6211. # error_log_languages on
  6212. # TAG: err_page_stylesheet
  6213. # CSS Stylesheet to pattern the display of Squid default error pages.
  6214. #
  6215. # For information on CSS see http://www.w3.org/Style/CSS/
  6216. #Default:
  6217. # err_page_stylesheet /etc/squid/errorpage.css
  6218. # TAG: err_html_text
  6219. # HTML text to include in error messages. Make this a "mailto"
  6220. # URL to your admin address, or maybe just a link to your
  6221. # organizations Web page.
  6222. #
  6223. # To include this in your error messages, you must rewrite
  6224. # the error template files (found in the "errors" directory).
  6225. # Wherever you want the 'err_html_text' line to appear,
  6226. # insert a %L tag in the error template file.
  6227. #Default:
  6228. # none
  6229. # TAG: email_err_data on|off
  6230. # If enabled, information about the occurred error will be
  6231. # included in the mailto links of the ERR pages (if %W is set)
  6232. # so that the email body contains the data.
  6233. # Syntax is <A HREF="mailto:%w%W">%w</A>
  6234. #Default:
  6235. # email_err_data on
  6236. # TAG: deny_info
  6237. # Usage: deny_info err_page_name acl
  6238. # or deny_info http://... acl
  6239. # or deny_info TCP_RESET acl
  6240. #
  6241. # This can be used to return a ERR_ page for requests which
  6242. # do not pass the 'http_access' rules. Squid remembers the last
  6243. # acl it evaluated in http_access, and if a 'deny_info' line exists
  6244. # for that ACL Squid returns a corresponding error page.
  6245. #
  6246. # The acl is typically the last acl on the http_access deny line which
  6247. # denied access. The exceptions to this rule are:
  6248. # - When Squid needs to request authentication credentials. It's then
  6249. # the first authentication related acl encountered
  6250. # - When none of the http_access lines matches. It's then the last
  6251. # acl processed on the last http_access line.
  6252. # - When the decision to deny access was made by an adaptation service,
  6253. # the acl name is the corresponding eCAP or ICAP service_name.
  6254. #
  6255. # NP: If providing your own custom error pages with error_directory
  6256. # you may also specify them by your custom file name:
  6257. # Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
  6258. #
  6259. # By defaut Squid will send "403 Forbidden". A different 4xx or 5xx
  6260. # may be specified by prefixing the file name with the code and a colon.
  6261. # e.g. 404:ERR_CUSTOM_ACCESS_DENIED
  6262. #
  6263. # Alternatively you can tell Squid to reset the TCP connection
  6264. # by specifying TCP_RESET.
  6265. #
  6266. # Or you can specify an error URL or URL pattern. The browsers will
  6267. # get redirected to the specified URL after formatting tags have
  6268. # been replaced. Redirect will be done with 302 or 307 according to
  6269. # HTTP/1.1 specs. A different 3xx code may be specified by prefixing
  6270. # the URL. e.g. 303:http://example.com/
  6271. #
  6272. # URL FORMAT TAGS:
  6273. # %a - username (if available. Password NOT included)
  6274. # %B - FTP path URL
  6275. # %e - Error number
  6276. # %E - Error description
  6277. # %h - Squid hostname
  6278. # %H - Request domain name
  6279. # %i - Client IP Address
  6280. # %M - Request Method
  6281. # %o - Message result from external ACL helper
  6282. # %p - Request Port number
  6283. # %P - Request Protocol name
  6284. # %R - Request URL path
  6285. # %T - Timestamp in RFC 1123 format
  6286. # %U - Full canonical URL from client
  6287. # (HTTPS URLs terminate with *)
  6288. # %u - Full canonical URL from client
  6289. # %w - Admin email from squid.conf
  6290. # %x - Error name
  6291. # %% - Literal percent (%) code
  6292. #
  6293. #Default:
  6294. # none
  6295. # OPTIONS INFLUENCING REQUEST FORWARDING
  6296. # -----------------------------------------------------------------------------
  6297. # TAG: nonhierarchical_direct
  6298. # By default, Squid will send any non-hierarchical requests
  6299. # (not cacheable request type) direct to origin servers.
  6300. #
  6301. # When this is set to "off", Squid will prefer to send these
  6302. # requests to parents.
  6303. #
  6304. # Note that in most configurations, by turning this off you will only
  6305. # add latency to these request without any improvement in global hit
  6306. # ratio.
  6307. #
  6308. # This option only sets a preference. If the parent is unavailable a
  6309. # direct connection to the origin server may still be attempted. To
  6310. # completely prevent direct connections use never_direct.
  6311. #Default:
  6312. # nonhierarchical_direct on
  6313. # TAG: prefer_direct
  6314. # Normally Squid tries to use parents for most requests. If you for some
  6315. # reason like it to first try going direct and only use a parent if
  6316. # going direct fails set this to on.
  6317. #
  6318. # By combining nonhierarchical_direct off and prefer_direct on you
  6319. # can set up Squid to use a parent as a backup path if going direct
  6320. # fails.
  6321. #
  6322. # Note: If you want Squid to use parents for all requests see
  6323. # the never_direct directive. prefer_direct only modifies how Squid
  6324. # acts on cacheable requests.
  6325. #Default:
  6326. # prefer_direct off
  6327. # TAG: cache_miss_revalidate on|off
  6328. # RFC 7232 defines a conditional request mechanism to prevent
  6329. # response objects being unnecessarily transferred over the network.
  6330. # If that mechanism is used by the client and a cache MISS occurs
  6331. # it can prevent new cache entries being created.
  6332. #
  6333. # This option determines whether Squid on cache MISS will pass the
  6334. # client revalidation request to the server or tries to fetch new
  6335. # content for caching. It can be useful while the cache is mostly
  6336. # empty to more quickly have the cache populated by generating
  6337. # non-conditional GETs.
  6338. #
  6339. # When set to 'on' (default), Squid will pass all client If-* headers
  6340. # to the server. This permits server responses without a cacheable
  6341. # payload to be delivered and on MISS no new cache entry is created.
  6342. #
  6343. # When set to 'off' and if the request is cacheable, Squid will
  6344. # remove the clients If-Modified-Since and If-None-Match headers from
  6345. # the request sent to the server. This requests a 200 status response
  6346. # from the server to create a new cache entry with.
  6347. #Default:
  6348. # cache_miss_revalidate on
  6349. # TAG: always_direct
  6350. # Usage: always_direct allow|deny [!]aclname ...
  6351. #
  6352. # Here you can use ACL elements to specify requests which should
  6353. # ALWAYS be forwarded by Squid to the origin servers without using
  6354. # any peers. For example, to always directly forward requests for
  6355. # local servers ignoring any parents or siblings you may have use
  6356. # something like:
  6357. #
  6358. # acl local-servers dstdomain my.domain.net
  6359. # always_direct allow local-servers
  6360. #
  6361. # To always forward FTP requests directly, use
  6362. #
  6363. # acl FTP proto FTP
  6364. # always_direct allow FTP
  6365. #
  6366. # NOTE: There is a similar, but opposite option named
  6367. # 'never_direct'. You need to be aware that "always_direct deny
  6368. # foo" is NOT the same thing as "never_direct allow foo". You
  6369. # may need to use a deny rule to exclude a more-specific case of
  6370. # some other rule. Example:
  6371. #
  6372. # acl local-external dstdomain external.foo.net
  6373. # acl local-servers dstdomain .foo.net
  6374. # always_direct deny local-external
  6375. # always_direct allow local-servers
  6376. #
  6377. # NOTE: If your goal is to make the client forward the request
  6378. # directly to the origin server bypassing Squid then this needs
  6379. # to be done in the client configuration. Squid configuration
  6380. # can only tell Squid how Squid should fetch the object.
  6381. #
  6382. # NOTE: This directive is not related to caching. The replies
  6383. # is cached as usual even if you use always_direct. To not cache
  6384. # the replies see the 'cache' directive.
  6385. #
  6386. # This clause supports both fast and slow acl types.
  6387. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  6388. #Default:
  6389. # Prevent any cache_peer being used for this request.
  6390. # TAG: never_direct
  6391. # Usage: never_direct allow|deny [!]aclname ...
  6392. #
  6393. # never_direct is the opposite of always_direct. Please read
  6394. # the description for always_direct if you have not already.
  6395. #
  6396. # With 'never_direct' you can use ACL elements to specify
  6397. # requests which should NEVER be forwarded directly to origin
  6398. # servers. For example, to force the use of a proxy for all
  6399. # requests, except those in your local domain use something like:
  6400. #
  6401. # acl local-servers dstdomain .foo.net
  6402. # never_direct deny local-servers
  6403. # never_direct allow all
  6404. #
  6405. # or if Squid is inside a firewall and there are local intranet
  6406. # servers inside the firewall use something like:
  6407. #
  6408. # acl local-intranet dstdomain .foo.net
  6409. # acl local-external dstdomain external.foo.net
  6410. # always_direct deny local-external
  6411. # always_direct allow local-intranet
  6412. # never_direct allow all
  6413. #
  6414. # This clause supports both fast and slow acl types.
  6415. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  6416. #Default:
  6417. # Allow DNS results to be used for this request.
  6418. # ADVANCED NETWORKING OPTIONS
  6419. # -----------------------------------------------------------------------------
  6420. # TAG: incoming_udp_average
  6421. # Heavy voodoo here. I can't even believe you are reading this.
  6422. # Are you crazy? Don't even think about adjusting these unless
  6423. # you understand the algorithms in comm_select.c first!
  6424. #Default:
  6425. # incoming_udp_average 6
  6426. # TAG: incoming_tcp_average
  6427. # Heavy voodoo here. I can't even believe you are reading this.
  6428. # Are you crazy? Don't even think about adjusting these unless
  6429. # you understand the algorithms in comm_select.c first!
  6430. #Default:
  6431. # incoming_tcp_average 4
  6432. # TAG: incoming_dns_average
  6433. # Heavy voodoo here. I can't even believe you are reading this.
  6434. # Are you crazy? Don't even think about adjusting these unless
  6435. # you understand the algorithms in comm_select.c first!
  6436. #Default:
  6437. # incoming_dns_average 4
  6438. # TAG: min_udp_poll_cnt
  6439. # Heavy voodoo here. I can't even believe you are reading this.
  6440. # Are you crazy? Don't even think about adjusting these unless
  6441. # you understand the algorithms in comm_select.c first!
  6442. #Default:
  6443. # min_udp_poll_cnt 8
  6444. # TAG: min_dns_poll_cnt
  6445. # Heavy voodoo here. I can't even believe you are reading this.
  6446. # Are you crazy? Don't even think about adjusting these unless
  6447. # you understand the algorithms in comm_select.c first!
  6448. #Default:
  6449. # min_dns_poll_cnt 8
  6450. # TAG: min_tcp_poll_cnt
  6451. # Heavy voodoo here. I can't even believe you are reading this.
  6452. # Are you crazy? Don't even think about adjusting these unless
  6453. # you understand the algorithms in comm_select.c first!
  6454. #Default:
  6455. # min_tcp_poll_cnt 8
  6456. # TAG: accept_filter
  6457. # FreeBSD:
  6458. #
  6459. # The name of an accept(2) filter to install on Squid's
  6460. # listen socket(s). This feature is perhaps specific to
  6461. # FreeBSD and requires support in the kernel.
  6462. #
  6463. # The 'httpready' filter delays delivering new connections
  6464. # to Squid until a full HTTP request has been received.
  6465. # See the accf_http(9) man page for details.
  6466. #
  6467. # The 'dataready' filter delays delivering new connections
  6468. # to Squid until there is some data to process.
  6469. # See the accf_dataready(9) man page for details.
  6470. #
  6471. # Linux:
  6472. #
  6473. # The 'data' filter delays delivering of new connections
  6474. # to Squid until there is some data to process by TCP_ACCEPT_DEFER.
  6475. # You may optionally specify a number of seconds to wait by
  6476. # 'data=N' where N is the number of seconds. Defaults to 30
  6477. # if not specified. See the tcp(7) man page for details.
  6478. #EXAMPLE:
  6479. ## FreeBSD
  6480. #accept_filter httpready
  6481. ## Linux
  6482. #accept_filter data
  6483. #Default:
  6484. # none
  6485. # TAG: client_ip_max_connections
  6486. # Set an absolute limit on the number of connections a single
  6487. # client IP can use. Any more than this and Squid will begin to drop
  6488. # new connections from the client until it closes some links.
  6489. #
  6490. # Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
  6491. # connections from the client. For finer control use the ACL access controls.
  6492. #
  6493. # Requires client_db to be enabled (the default).
  6494. #
  6495. # WARNING: This may noticably slow down traffic received via external proxies
  6496. # or NAT devices and cause them to rebound error messages back to their clients.
  6497. #Default:
  6498. # No limit.
  6499. # TAG: tcp_recv_bufsize (bytes)
  6500. # Size of receive buffer to set for TCP sockets. Probably just
  6501. # as easy to change your kernel's default.
  6502. # Omit from squid.conf to use the default buffer size.
  6503. #Default:
  6504. # Use operating system TCP defaults.
  6505. # ICAP OPTIONS
  6506. # -----------------------------------------------------------------------------
  6507. # TAG: icap_enable on|off
  6508. # If you want to enable the ICAP module support, set this to on.
  6509. #Default:
  6510. # icap_enable off
  6511. # TAG: icap_connect_timeout
  6512. # This parameter specifies how long to wait for the TCP connect to
  6513. # the requested ICAP server to complete before giving up and either
  6514. # terminating the HTTP transaction or bypassing the failure.
  6515. #
  6516. # The default for optional services is peer_connect_timeout.
  6517. # The default for essential services is connect_timeout.
  6518. # If this option is explicitly set, its value applies to all services.
  6519. #Default:
  6520. # none
  6521. # TAG: icap_io_timeout time-units
  6522. # This parameter specifies how long to wait for an I/O activity on
  6523. # an established, active ICAP connection before giving up and
  6524. # either terminating the HTTP transaction or bypassing the
  6525. # failure.
  6526. #Default:
  6527. # Use read_timeout.
  6528. # TAG: icap_service_failure_limit limit [in memory-depth time-units]
  6529. # The limit specifies the number of failures that Squid tolerates
  6530. # when establishing a new TCP connection with an ICAP service. If
  6531. # the number of failures exceeds the limit, the ICAP service is
  6532. # not used for new ICAP requests until it is time to refresh its
  6533. # OPTIONS.
  6534. #
  6535. # A negative value disables the limit. Without the limit, an ICAP
  6536. # service will not be considered down due to connectivity failures
  6537. # between ICAP OPTIONS requests.
  6538. #
  6539. # Squid forgets ICAP service failures older than the specified
  6540. # value of memory-depth. The memory fading algorithm
  6541. # is approximate because Squid does not remember individual
  6542. # errors but groups them instead, splitting the option
  6543. # value into ten time slots of equal length.
  6544. #
  6545. # When memory-depth is 0 and by default this option has no
  6546. # effect on service failure expiration.
  6547. #
  6548. # Squid always forgets failures when updating service settings
  6549. # using an ICAP OPTIONS transaction, regardless of this option
  6550. # setting.
  6551. #
  6552. # For example,
  6553. # # suspend service usage after 10 failures in 5 seconds:
  6554. # icap_service_failure_limit 10 in 5 seconds
  6555. #Default:
  6556. # icap_service_failure_limit 10
  6557. # TAG: icap_service_revival_delay
  6558. # The delay specifies the number of seconds to wait after an ICAP
  6559. # OPTIONS request failure before requesting the options again. The
  6560. # failed ICAP service is considered "down" until fresh OPTIONS are
  6561. # fetched.
  6562. #
  6563. # The actual delay cannot be smaller than the hardcoded minimum
  6564. # delay of 30 seconds.
  6565. #Default:
  6566. # icap_service_revival_delay 180
  6567. # TAG: icap_preview_enable on|off
  6568. # The ICAP Preview feature allows the ICAP server to handle the
  6569. # HTTP message by looking only at the beginning of the message body
  6570. # or even without receiving the body at all. In some environments,
  6571. # previews greatly speedup ICAP processing.
  6572. #
  6573. # During an ICAP OPTIONS transaction, the server may tell Squid what
  6574. # HTTP messages should be previewed and how big the preview should be.
  6575. # Squid will not use Preview if the server did not request one.
  6576. #
  6577. # To disable ICAP Preview for all ICAP services, regardless of
  6578. # individual ICAP server OPTIONS responses, set this option to "off".
  6579. #Example:
  6580. #icap_preview_enable off
  6581. #Default:
  6582. # icap_preview_enable on
  6583. # TAG: icap_preview_size
  6584. # The default size of preview data to be sent to the ICAP server.
  6585. # This value might be overwritten on a per server basis by OPTIONS requests.
  6586. #Default:
  6587. # No preview sent.
  6588. # TAG: icap_206_enable on|off
  6589. # 206 (Partial Content) responses is an ICAP extension that allows the
  6590. # ICAP agents to optionally combine adapted and original HTTP message
  6591. # content. The decision to combine is postponed until the end of the
  6592. # ICAP response. Squid supports Partial Content extension by default.
  6593. #
  6594. # Activation of the Partial Content extension is negotiated with each
  6595. # ICAP service during OPTIONS exchange. Most ICAP servers should handle
  6596. # negotation correctly even if they do not support the extension, but
  6597. # some might fail. To disable Partial Content support for all ICAP
  6598. # services and to avoid any negotiation, set this option to "off".
  6599. #
  6600. # Example:
  6601. # icap_206_enable off
  6602. #Default:
  6603. # icap_206_enable on
  6604. # TAG: icap_default_options_ttl
  6605. # The default TTL value for ICAP OPTIONS responses that don't have
  6606. # an Options-TTL header.
  6607. #Default:
  6608. # icap_default_options_ttl 60
  6609. # TAG: icap_persistent_connections on|off
  6610. # Whether or not Squid should use persistent connections to
  6611. # an ICAP server.
  6612. #Default:
  6613. # icap_persistent_connections on
  6614. # TAG: adaptation_send_client_ip on|off
  6615. # If enabled, Squid shares HTTP client IP information with adaptation
  6616. # services. For ICAP, Squid adds the X-Client-IP header to ICAP requests.
  6617. # For eCAP, Squid sets the libecap::metaClientIp transaction option.
  6618. #
  6619. # See also: adaptation_uses_indirect_client
  6620. #Default:
  6621. # adaptation_send_client_ip off
  6622. # TAG: adaptation_send_username on|off
  6623. # This sends authenticated HTTP client username (if available) to
  6624. # the adaptation service.
  6625. #
  6626. # For ICAP, the username value is encoded based on the
  6627. # icap_client_username_encode option and is sent using the header
  6628. # specified by the icap_client_username_header option.
  6629. #Default:
  6630. # adaptation_send_username off
  6631. # TAG: icap_client_username_header
  6632. # ICAP request header name to use for adaptation_send_username.
  6633. #Default:
  6634. # icap_client_username_header X-Client-Username
  6635. # TAG: icap_client_username_encode on|off
  6636. # Whether to base64 encode the authenticated client username.
  6637. #Default:
  6638. # icap_client_username_encode off
  6639. # TAG: icap_service
  6640. # Defines a single ICAP service using the following format:
  6641. #
  6642. # icap_service id vectoring_point uri [option ...]
  6643. #
  6644. # id: ID
  6645. # an opaque identifier or name which is used to direct traffic to
  6646. # this specific service. Must be unique among all adaptation
  6647. # services in squid.conf.
  6648. #
  6649. # vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
  6650. # This specifies at which point of transaction processing the
  6651. # ICAP service should be activated. *_postcache vectoring points
  6652. # are not yet supported.
  6653. #
  6654. # uri: icap://servername:port/servicepath
  6655. # ICAP server and service location.
  6656. #
  6657. # ICAP does not allow a single service to handle both REQMOD and RESPMOD
  6658. # transactions. Squid does not enforce that requirement. You can specify
  6659. # services with the same service_url and different vectoring_points. You
  6660. # can even specify multiple identical services as long as their
  6661. # service_names differ.
  6662. #
  6663. # To activate a service, use the adaptation_access directive. To group
  6664. # services, use adaptation_service_chain and adaptation_service_set.
  6665. #
  6666. # Service options are separated by white space. ICAP services support
  6667. # the following name=value options:
  6668. #
  6669. # bypass=on|off|1|0
  6670. # If set to 'on' or '1', the ICAP service is treated as
  6671. # optional. If the service cannot be reached or malfunctions,
  6672. # Squid will try to ignore any errors and process the message as
  6673. # if the service was not enabled. No all ICAP errors can be
  6674. # bypassed. If set to 0, the ICAP service is treated as
  6675. # essential and all ICAP errors will result in an error page
  6676. # returned to the HTTP client.
  6677. #
  6678. # Bypass is off by default: services are treated as essential.
  6679. #
  6680. # routing=on|off|1|0
  6681. # If set to 'on' or '1', the ICAP service is allowed to
  6682. # dynamically change the current message adaptation plan by
  6683. # returning a chain of services to be used next. The services
  6684. # are specified using the X-Next-Services ICAP response header
  6685. # value, formatted as a comma-separated list of service names.
  6686. # Each named service should be configured in squid.conf. Other
  6687. # services are ignored. An empty X-Next-Services value results
  6688. # in an empty plan which ends the current adaptation.
  6689. #
  6690. # Dynamic adaptation plan may cross or cover multiple supported
  6691. # vectoring points in their natural processing order.
  6692. #
  6693. # Routing is not allowed by default: the ICAP X-Next-Services
  6694. # response header is ignored.
  6695. #
  6696. # ipv6=on|off
  6697. # Only has effect on split-stack systems. The default on those systems
  6698. # is to use IPv4-only connections. When set to 'on' this option will
  6699. # make Squid use IPv6-only connections to contact this ICAP service.
  6700. #
  6701. # on-overload=block|bypass|wait|force
  6702. # If the service Max-Connections limit has been reached, do
  6703. # one of the following for each new ICAP transaction:
  6704. # * block: send an HTTP error response to the client
  6705. # * bypass: ignore the "over-connected" ICAP service
  6706. # * wait: wait (in a FIFO queue) for an ICAP connection slot
  6707. # * force: proceed, ignoring the Max-Connections limit
  6708. #
  6709. # In SMP mode with N workers, each worker assumes the service
  6710. # connection limit is Max-Connections/N, even though not all
  6711. # workers may use a given service.
  6712. #
  6713. # The default value is "bypass" if service is bypassable,
  6714. # otherwise it is set to "wait".
  6715. #
  6716. #
  6717. # max-conn=number
  6718. # Use the given number as the Max-Connections limit, regardless
  6719. # of the Max-Connections value given by the service, if any.
  6720. #
  6721. # Older icap_service format without optional named parameters is
  6722. # deprecated but supported for backward compatibility.
  6723. #
  6724. #Example:
  6725. #icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0
  6726. #icap_service svcLogger reqmod_precache icap://icap2.mydomain.net:1344/respmod routing=on
  6727. #Default:
  6728. # none
  6729. # TAG: icap_class
  6730. # This deprecated option was documented to define an ICAP service
  6731. # chain, even though it actually defined a set of similar, redundant
  6732. # services, and the chains were not supported.
  6733. #
  6734. # To define a set of redundant services, please use the
  6735. # adaptation_service_set directive. For service chains, use
  6736. # adaptation_service_chain.
  6737. #Default:
  6738. # none
  6739. # TAG: icap_access
  6740. # This option is deprecated. Please use adaptation_access, which
  6741. # has the same ICAP functionality, but comes with better
  6742. # documentation, and eCAP support.
  6743. #Default:
  6744. # none
  6745. # eCAP OPTIONS
  6746. # -----------------------------------------------------------------------------
  6747. # TAG: ecap_enable on|off
  6748. # Controls whether eCAP support is enabled.
  6749. #Default:
  6750. # ecap_enable off
  6751. # TAG: ecap_service
  6752. # Defines a single eCAP service
  6753. #
  6754. # ecap_service id vectoring_point uri [option ...]
  6755. #
  6756. # id: ID
  6757. # an opaque identifier or name which is used to direct traffic to
  6758. # this specific service. Must be unique among all adaptation
  6759. # services in squid.conf.
  6760. #
  6761. # vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
  6762. # This specifies at which point of transaction processing the
  6763. # eCAP service should be activated. *_postcache vectoring points
  6764. # are not yet supported.
  6765. #
  6766. # uri: ecap://vendor/service_name?custom&cgi=style&parameters=optional
  6767. # Squid uses the eCAP service URI to match this configuration
  6768. # line with one of the dynamically loaded services. Each loaded
  6769. # eCAP service must have a unique URI. Obtain the right URI from
  6770. # the service provider.
  6771. #
  6772. # To activate a service, use the adaptation_access directive. To group
  6773. # services, use adaptation_service_chain and adaptation_service_set.
  6774. #
  6775. # Service options are separated by white space. eCAP services support
  6776. # the following name=value options:
  6777. #
  6778. # bypass=on|off|1|0
  6779. # If set to 'on' or '1', the eCAP service is treated as optional.
  6780. # If the service cannot be reached or malfunctions, Squid will try
  6781. # to ignore any errors and process the message as if the service
  6782. # was not enabled. No all eCAP errors can be bypassed.
  6783. # If set to 'off' or '0', the eCAP service is treated as essential
  6784. # and all eCAP errors will result in an error page returned to the
  6785. # HTTP client.
  6786. #
  6787. # Bypass is off by default: services are treated as essential.
  6788. #
  6789. # routing=on|off|1|0
  6790. # If set to 'on' or '1', the eCAP service is allowed to
  6791. # dynamically change the current message adaptation plan by
  6792. # returning a chain of services to be used next.
  6793. #
  6794. # Dynamic adaptation plan may cross or cover multiple supported
  6795. # vectoring points in their natural processing order.
  6796. #
  6797. # Routing is not allowed by default.
  6798. #
  6799. # Older ecap_service format without optional named parameters is
  6800. # deprecated but supported for backward compatibility.
  6801. #
  6802. #
  6803. #Example:
  6804. #ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off
  6805. #ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on
  6806. #Default:
  6807. # none
  6808. # TAG: loadable_modules
  6809. # Instructs Squid to load the specified dynamic module(s) or activate
  6810. # preloaded module(s).
  6811. #Example:
  6812. #loadable_modules /usr/lib/MinimalAdapter.so
  6813. #Default:
  6814. # none
  6815. # MESSAGE ADAPTATION OPTIONS
  6816. # -----------------------------------------------------------------------------
  6817. # TAG: adaptation_service_set
  6818. #
  6819. # Configures an ordered set of similar, redundant services. This is
  6820. # useful when hot standby or backup adaptation servers are available.
  6821. #
  6822. # adaptation_service_set set_name service_name1 service_name2 ...
  6823. #
  6824. # The named services are used in the set declaration order. The first
  6825. # applicable adaptation service from the set is used first. The next
  6826. # applicable service is tried if and only if the transaction with the
  6827. # previous service fails and the message waiting to be adapted is still
  6828. # intact.
  6829. #
  6830. # When adaptation starts, broken services are ignored as if they were
  6831. # not a part of the set. A broken service is a down optional service.
  6832. #
  6833. # The services in a set must be attached to the same vectoring point
  6834. # (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
  6835. #
  6836. # If all services in a set are optional then adaptation failures are
  6837. # bypassable. If all services in the set are essential, then a
  6838. # transaction failure with one service may still be retried using
  6839. # another service from the set, but when all services fail, the master
  6840. # transaction fails as well.
  6841. #
  6842. # A set may contain a mix of optional and essential services, but that
  6843. # is likely to lead to surprising results because broken services become
  6844. # ignored (see above), making previously bypassable failures fatal.
  6845. # Technically, it is the bypassability of the last failed service that
  6846. # matters.
  6847. #
  6848. # See also: adaptation_access adaptation_service_chain
  6849. #
  6850. #Example:
  6851. #adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
  6852. #adaptation service_set svcLogger loggerLocal loggerRemote
  6853. #Default:
  6854. # none
  6855. # TAG: adaptation_service_chain
  6856. #
  6857. # Configures a list of complementary services that will be applied
  6858. # one-by-one, forming an adaptation chain or pipeline. This is useful
  6859. # when Squid must perform different adaptations on the same message.
  6860. #
  6861. # adaptation_service_chain chain_name service_name1 svc_name2 ...
  6862. #
  6863. # The named services are used in the chain declaration order. The first
  6864. # applicable adaptation service from the chain is used first. The next
  6865. # applicable service is applied to the successful adaptation results of
  6866. # the previous service in the chain.
  6867. #
  6868. # When adaptation starts, broken services are ignored as if they were
  6869. # not a part of the chain. A broken service is a down optional service.
  6870. #
  6871. # Request satisfaction terminates the adaptation chain because Squid
  6872. # does not currently allow declaration of RESPMOD services at the
  6873. # "reqmod_precache" vectoring point (see icap_service or ecap_service).
  6874. #
  6875. # The services in a chain must be attached to the same vectoring point
  6876. # (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
  6877. #
  6878. # A chain may contain a mix of optional and essential services. If an
  6879. # essential adaptation fails (or the failure cannot be bypassed for
  6880. # other reasons), the master transaction fails. Otherwise, the failure
  6881. # is bypassed as if the failed adaptation service was not in the chain.
  6882. #
  6883. # See also: adaptation_access adaptation_service_set
  6884. #
  6885. #Example:
  6886. #adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
  6887. #Default:
  6888. # none
  6889. # TAG: adaptation_access
  6890. # Sends an HTTP transaction to an ICAP or eCAP adaptation service.
  6891. #
  6892. # adaptation_access service_name allow|deny [!]aclname...
  6893. # adaptation_access set_name allow|deny [!]aclname...
  6894. #
  6895. # At each supported vectoring point, the adaptation_access
  6896. # statements are processed in the order they appear in this
  6897. # configuration file. Statements pointing to the following services
  6898. # are ignored (i.e., skipped without checking their ACL):
  6899. #
  6900. # - services serving different vectoring points
  6901. # - "broken-but-bypassable" services
  6902. # - "up" services configured to ignore such transactions
  6903. # (e.g., based on the ICAP Transfer-Ignore header).
  6904. #
  6905. # When a set_name is used, all services in the set are checked
  6906. # using the same rules, to find the first applicable one. See
  6907. # adaptation_service_set for details.
  6908. #
  6909. # If an access list is checked and there is a match, the
  6910. # processing stops: For an "allow" rule, the corresponding
  6911. # adaptation service is used for the transaction. For a "deny"
  6912. # rule, no adaptation service is activated.
  6913. #
  6914. # It is currently not possible to apply more than one adaptation
  6915. # service at the same vectoring point to the same HTTP transaction.
  6916. #
  6917. # See also: icap_service and ecap_service
  6918. #
  6919. #Example:
  6920. #adaptation_access service_1 allow all
  6921. #Default:
  6922. # Allow, unless rules exist in squid.conf.
  6923. # TAG: adaptation_service_iteration_limit
  6924. # Limits the number of iterations allowed when applying adaptation
  6925. # services to a message. If your longest adaptation set or chain
  6926. # may have more than 16 services, increase the limit beyond its
  6927. # default value of 16. If detecting infinite iteration loops sooner
  6928. # is critical, make the iteration limit match the actual number
  6929. # of services in your longest adaptation set or chain.
  6930. #
  6931. # Infinite adaptation loops are most likely with routing services.
  6932. #
  6933. # See also: icap_service routing=1
  6934. #Default:
  6935. # adaptation_service_iteration_limit 16
  6936. # TAG: adaptation_masterx_shared_names
  6937. # For each master transaction (i.e., the HTTP request and response
  6938. # sequence, including all related ICAP and eCAP exchanges), Squid
  6939. # maintains a table of metadata. The table entries are (name, value)
  6940. # pairs shared among eCAP and ICAP exchanges. The table is destroyed
  6941. # with the master transaction.
  6942. #
  6943. # This option specifies the table entry names that Squid must accept
  6944. # from and forward to the adaptation transactions.
  6945. #
  6946. # An ICAP REQMOD or RESPMOD transaction may set an entry in the
  6947. # shared table by returning an ICAP header field with a name
  6948. # specified in adaptation_masterx_shared_names.
  6949. #
  6950. # An eCAP REQMOD or RESPMOD transaction may set an entry in the
  6951. # shared table by implementing the libecap::visitEachOption() API
  6952. # to provide an option with a name specified in
  6953. # adaptation_masterx_shared_names.
  6954. #
  6955. # Squid will store and forward the set entry to subsequent adaptation
  6956. # transactions within the same master transaction scope.
  6957. #
  6958. # Only one shared entry name is supported at this time.
  6959. #
  6960. #Example:
  6961. ## share authentication information among ICAP services
  6962. #adaptation_masterx_shared_names X-Subscriber-ID
  6963. #Default:
  6964. # none
  6965. # TAG: adaptation_meta
  6966. # This option allows Squid administrator to add custom ICAP request
  6967. # headers or eCAP options to Squid ICAP requests or eCAP transactions.
  6968. # Use it to pass custom authentication tokens and other
  6969. # transaction-state related meta information to an ICAP/eCAP service.
  6970. #
  6971. # The addition of a meta header is ACL-driven:
  6972. # adaptation_meta name value [!]aclname ...
  6973. #
  6974. # Processing for a given header name stops after the first ACL list match.
  6975. # Thus, it is impossible to add two headers with the same name. If no ACL
  6976. # lists match for a given header name, no such header is added. For
  6977. # example:
  6978. #
  6979. # # do not debug transactions except for those that need debugging
  6980. # adaptation_meta X-Debug 1 needs_debugging
  6981. #
  6982. # # log all transactions except for those that must remain secret
  6983. # adaptation_meta X-Log 1 !keep_secret
  6984. #
  6985. # # mark transactions from users in the "G 1" group
  6986. # adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1
  6987. #
  6988. # The "value" parameter may be a regular squid.conf token or a "double
  6989. # quoted string". Within the quoted string, use backslash (\) to escape
  6990. # any character, which is currently only useful for escaping backslashes
  6991. # and double quotes. For example,
  6992. # "this string has one backslash (\\) and two \"quotes\""
  6993. #
  6994. # Used adaptation_meta header values may be logged via %note
  6995. # logformat code. If multiple adaptation_meta headers with the same name
  6996. # are used during master transaction lifetime, the header values are
  6997. # logged in the order they were used and duplicate values are ignored
  6998. # (only the first repeated value will be logged).
  6999. #Default:
  7000. # none
  7001. # TAG: icap_retry
  7002. # This ACL determines which retriable ICAP transactions are
  7003. # retried. Transactions that received a complete ICAP response
  7004. # and did not have to consume or produce HTTP bodies to receive
  7005. # that response are usually retriable.
  7006. #
  7007. # icap_retry allow|deny [!]aclname ...
  7008. #
  7009. # Squid automatically retries some ICAP I/O timeouts and errors
  7010. # due to persistent connection race conditions.
  7011. #
  7012. # See also: icap_retry_limit
  7013. #Default:
  7014. # icap_retry deny all
  7015. # TAG: icap_retry_limit
  7016. # Limits the number of retries allowed.
  7017. #
  7018. # Communication errors due to persistent connection race
  7019. # conditions are unavoidable, automatically retried, and do not
  7020. # count against this limit.
  7021. #
  7022. # See also: icap_retry
  7023. #Default:
  7024. # No retries are allowed.
  7025. # DNS OPTIONS
  7026. # -----------------------------------------------------------------------------
  7027. # TAG: check_hostnames
  7028. # For security and stability reasons Squid can check
  7029. # hostnames for Internet standard RFC compliance. If you want
  7030. # Squid to perform these checks turn this directive on.
  7031. #Default:
  7032. # check_hostnames off
  7033. # TAG: allow_underscore
  7034. # Underscore characters is not strictly allowed in Internet hostnames
  7035. # but nevertheless used by many sites. Set this to off if you want
  7036. # Squid to be strict about the standard.
  7037. # This check is performed only when check_hostnames is set to on.
  7038. #Default:
  7039. # allow_underscore on
  7040. # TAG: dns_retransmit_interval
  7041. # Initial retransmit interval for DNS queries. The interval is
  7042. # doubled each time all configured DNS servers have been tried.
  7043. #Default:
  7044. # dns_retransmit_interval 5 seconds
  7045. # TAG: dns_timeout
  7046. # DNS Query timeout. If no response is received to a DNS query
  7047. # within this time all DNS servers for the queried domain
  7048. # are assumed to be unavailable.
  7049. #Default:
  7050. # dns_timeout 30 seconds
  7051. # TAG: dns_packet_max
  7052. # Maximum number of bytes packet size to advertise via EDNS.
  7053. # Set to "none" to disable EDNS large packet support.
  7054. #
  7055. # For legacy reasons DNS UDP replies will default to 512 bytes which
  7056. # is too small for many responses. EDNS provides a means for Squid to
  7057. # negotiate receiving larger responses back immediately without having
  7058. # to failover with repeat requests. Responses larger than this limit
  7059. # will retain the old behaviour of failover to TCP DNS.
  7060. #
  7061. # Squid has no real fixed limit internally, but allowing packet sizes
  7062. # over 1500 bytes requires network jumbogram support and is usually not
  7063. # necessary.
  7064. #
  7065. # WARNING: The RFC also indicates that some older resolvers will reply
  7066. # with failure of the whole request if the extension is added. Some
  7067. # resolvers have already been identified which will reply with mangled
  7068. # EDNS response on occasion. Usually in response to many-KB jumbogram
  7069. # sizes being advertised by Squid.
  7070. # Squid will currently treat these both as an unable-to-resolve domain
  7071. # even if it would be resolvable without EDNS.
  7072. #Default:
  7073. # EDNS disabled
  7074. # TAG: dns_defnames on|off
  7075. # Normally the RES_DEFNAMES resolver option is disabled
  7076. # (see res_init(3)). This prevents caches in a hierarchy
  7077. # from interpreting single-component hostnames locally. To allow
  7078. # Squid to handle single-component names, enable this option.
  7079. #Default:
  7080. # Search for single-label domain names is disabled.
  7081. # TAG: dns_multicast_local on|off
  7082. # When set to on, Squid sends multicast DNS lookups on the local
  7083. # network for domains ending in .local and .arpa.
  7084. # This enables local servers and devices to be contacted in an
  7085. # ad-hoc or zero-configuration network environment.
  7086. #Default:
  7087. # Search for .local and .arpa names is disabled.
  7088. # TAG: dns_nameservers
  7089. # Use this if you want to specify a list of DNS name servers
  7090. # (IP addresses) to use instead of those given in your
  7091. # /etc/resolv.conf file.
  7092. #
  7093. # On Windows platforms, if no value is specified here or in
  7094. # the /etc/resolv.conf file, the list of DNS name servers are
  7095. # taken from the Windows registry, both static and dynamic DHCP
  7096. # configurations are supported.
  7097. #
  7098. # Example: dns_nameservers 10.0.0.1 192.172.0.4
  7099. #Default:
  7100. # Use operating system definitions
  7101. dns_nameservers 8.8.8.8 192.168.1.1
  7102. # TAG: hosts_file
  7103. # Location of the host-local IP name-address associations
  7104. # database. Most Operating Systems have such a file on different
  7105. # default locations:
  7106. # - Un*X & Linux: /etc/hosts
  7107. # - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
  7108. # (%SystemRoot% value install default is c:\winnt)
  7109. # - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
  7110. # (%SystemRoot% value install default is c:\windows)
  7111. # - Windows 9x/Me: %windir%\hosts
  7112. # (%windir% value is usually c:\windows)
  7113. # - Cygwin: /etc/hosts
  7114. #
  7115. # The file contains newline-separated definitions, in the
  7116. # form ip_address_in_dotted_form name [name ...] names are
  7117. # whitespace-separated. Lines beginning with an hash (#)
  7118. # character are comments.
  7119. #
  7120. # The file is checked at startup and upon configuration.
  7121. # If set to 'none', it won't be checked.
  7122. # If append_domain is used, that domain will be added to
  7123. # domain-local (i.e. not containing any dot character) host
  7124. # definitions.
  7125. #Default:
  7126. # hosts_file /etc/hosts
  7127. # TAG: append_domain
  7128. # Appends local domain name to hostnames without any dots in
  7129. # them. append_domain must begin with a period.
  7130. #
  7131. # Be warned there are now Internet names with no dots in
  7132. # them using only top-domain names, so setting this may
  7133. # cause some Internet sites to become unavailable.
  7134. #
  7135. #Example:
  7136. # append_domain .yourdomain.com
  7137. #Default:
  7138. # Use operating system definitions
  7139. # TAG: ignore_unknown_nameservers
  7140. # By default Squid checks that DNS responses are received
  7141. # from the same IP addresses they are sent to. If they
  7142. # don't match, Squid ignores the response and writes a warning
  7143. # message to cache.log. You can allow responses from unknown
  7144. # nameservers by setting this option to 'off'.
  7145. #Default:
  7146. # ignore_unknown_nameservers on
  7147. # TAG: dns_v4_first
  7148. # With the IPv6 Internet being as fast or faster than IPv4 Internet
  7149. # for most networks Squid prefers to contact websites over IPv6.
  7150. #
  7151. # This option reverses the order of preference to make Squid contact
  7152. # dual-stack websites over IPv4 first. Squid will still perform both
  7153. # IPv6 and IPv4 DNS lookups before connecting.
  7154. #
  7155. # WARNING:
  7156. # This option will restrict the situations under which IPv6
  7157. # connectivity is used (and tested), potentially hiding network
  7158. # problems which would otherwise be detected and warned about.
  7159. #Default:
  7160. dns_v4_first on
  7161. # TAG: ipcache_size (number of entries)
  7162. # Maximum number of DNS IP cache entries.
  7163. #Default:
  7164. # ipcache_size 1024
  7165. # TAG: ipcache_low (percent)
  7166. #Default:
  7167. # ipcache_low 90
  7168. # TAG: ipcache_high (percent)
  7169. # The size, low-, and high-water marks for the IP cache.
  7170. #Default:
  7171. # ipcache_high 95
  7172. # TAG: fqdncache_size (number of entries)
  7173. # Maximum number of FQDN cache entries.
  7174. #Default:
  7175. # fqdncache_size 1024
  7176. # MISCELLANEOUS
  7177. # -----------------------------------------------------------------------------
  7178. # TAG: configuration_includes_quoted_values on|off
  7179. # If set, Squid will recognize each "quoted string" after a configuration
  7180. # directive as a single parameter. The quotes are stripped before the
  7181. # parameter value is interpreted or used.
  7182. # See "Values with spaces, quotes, and other special characters"
  7183. # section for more details.
  7184. #Default:
  7185. # configuration_includes_quoted_values off
  7186. # TAG: memory_pools on|off
  7187. # If set, Squid will keep pools of allocated (but unused) memory
  7188. # available for future use. If memory is a premium on your
  7189. # system and you believe your malloc library outperforms Squid
  7190. # routines, disable this.
  7191. #Default:
  7192. # memory_pools on
  7193. # TAG: memory_pools_limit (bytes)
  7194. # Used only with memory_pools on:
  7195. # memory_pools_limit 50 MB
  7196. #
  7197. # If set to a non-zero value, Squid will keep at most the specified
  7198. # limit of allocated (but unused) memory in memory pools. All free()
  7199. # requests that exceed this limit will be handled by your malloc
  7200. # library. Squid does not pre-allocate any memory, just safe-keeps
  7201. # objects that otherwise would be free()d. Thus, it is safe to set
  7202. # memory_pools_limit to a reasonably high value even if your
  7203. # configuration will use less memory.
  7204. #
  7205. # If set to none, Squid will keep all memory it can. That is, there
  7206. # will be no limit on the total amount of memory used for safe-keeping.
  7207. #
  7208. # To disable memory allocation optimization, do not set
  7209. # memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
  7210. #
  7211. # An overhead for maintaining memory pools is not taken into account
  7212. # when the limit is checked. This overhead is close to four bytes per
  7213. # object kept. However, pools may actually _save_ memory because of
  7214. # reduced memory thrashing in your malloc library.
  7215. #Default:
  7216. # memory_pools_limit 5 MB
  7217. # TAG: forwarded_for on|off|transparent|truncate|delete
  7218. # If set to "on", Squid will append your client's IP address
  7219. # in the HTTP requests it forwards. By default it looks like:
  7220. #
  7221. # X-Forwarded-For: 192.1.2.3
  7222. #
  7223. # If set to "off", it will appear as
  7224. #
  7225. # X-Forwarded-For: unknown
  7226. #
  7227. # If set to "transparent", Squid will not alter the
  7228. # X-Forwarded-For header in any way.
  7229. #
  7230. # If set to "delete", Squid will delete the entire
  7231. # X-Forwarded-For header.
  7232. #
  7233. # If set to "truncate", Squid will remove all existing
  7234. # X-Forwarded-For entries, and place the client IP as the sole entry.
  7235. #Default:
  7236. # forwarded_for on
  7237. # TAG: cachemgr_passwd
  7238. # Specify passwords for cachemgr operations.
  7239. #
  7240. # Usage: cachemgr_passwd password action action ...
  7241. #
  7242. # Some valid actions are (see cache manager menu for a full list):
  7243. # 5min
  7244. # 60min
  7245. # asndb
  7246. # authenticator
  7247. # cbdata
  7248. # client_list
  7249. # comm_incoming
  7250. # config *
  7251. # counters
  7252. # delay
  7253. # digest_stats
  7254. # dns
  7255. # events
  7256. # filedescriptors
  7257. # fqdncache
  7258. # histograms
  7259. # http_headers
  7260. # info
  7261. # io
  7262. # ipcache
  7263. # mem
  7264. # menu
  7265. # netdb
  7266. # non_peers
  7267. # objects
  7268. # offline_toggle *
  7269. # pconn
  7270. # peer_select
  7271. # reconfigure *
  7272. # redirector
  7273. # refresh
  7274. # server_list
  7275. # shutdown *
  7276. # store_digest
  7277. # storedir
  7278. # utilization
  7279. # via_headers
  7280. # vm_objects
  7281. #
  7282. # * Indicates actions which will not be performed without a
  7283. # valid password, others can be performed if not listed here.
  7284. #
  7285. # To disable an action, set the password to "disable".
  7286. # To allow performing an action without a password, set the
  7287. # password to "none".
  7288. #
  7289. # Use the keyword "all" to set the same password for all actions.
  7290. #
  7291. #Example:
  7292. # cachemgr_passwd secret shutdown
  7293. # cachemgr_passwd lesssssssecret info stats/objects
  7294. # cachemgr_passwd disable all
  7295. #Default:
  7296. # No password. Actions which require password are denied.
  7297. # TAG: client_db on|off
  7298. # If you want to disable collecting per-client statistics,
  7299. # turn off client_db here.
  7300. #Default:
  7301. # client_db on
  7302. # TAG: refresh_all_ims on|off
  7303. # When you enable this option, squid will always check
  7304. # the origin server for an update when a client sends an
  7305. # If-Modified-Since request. Many browsers use IMS
  7306. # requests when the user requests a reload, and this
  7307. # ensures those clients receive the latest version.
  7308. #
  7309. # By default (off), squid may return a Not Modified response
  7310. # based on the age of the cached version.
  7311. #Default:
  7312. # refresh_all_ims off
  7313. # TAG: reload_into_ims on|off
  7314. # When you enable this option, client no-cache or ``reload''
  7315. # requests will be changed to If-Modified-Since requests.
  7316. # Doing this VIOLATES the HTTP standard. Enabling this
  7317. # feature could make you liable for problems which it
  7318. # causes.
  7319. #
  7320. # see also refresh_pattern for a more selective approach.
  7321. #Default:
  7322. # reload_into_ims off
  7323. # TAG: connect_retries
  7324. # This sets the maximum number of connection attempts made for each
  7325. # TCP connection. The connect_retries attempts must all still
  7326. # complete within the connection timeout period.
  7327. #
  7328. # The default is not to re-try if the first connection attempt fails.
  7329. # The (not recommended) maximum is 10 tries.
  7330. #
  7331. # A warning message will be generated if it is set to a too-high
  7332. # value and the configured value will be over-ridden.
  7333. #
  7334. # Note: These re-tries are in addition to forward_max_tries
  7335. # which limit how many different addresses may be tried to find
  7336. # a useful server.
  7337. #Default:
  7338. # Do not retry failed connections.
  7339. # TAG: retry_on_error
  7340. # If set to ON Squid will automatically retry requests when
  7341. # receiving an error response with status 403 (Forbidden),
  7342. # 500 (Internal Error), 501 or 503 (Service not available).
  7343. # Status 502 and 504 (Gateway errors) are always retried.
  7344. #
  7345. # This is mainly useful if you are in a complex cache hierarchy to
  7346. # work around access control errors.
  7347. #
  7348. # NOTE: This retry will attempt to find another working destination.
  7349. # Which is different from the server which just failed.
  7350. #Default:
  7351. # retry_on_error off
  7352. # TAG: as_whois_server
  7353. # WHOIS server to query for AS numbers. NOTE: AS numbers are
  7354. # queried only when Squid starts up, not for every request.
  7355. #Default:
  7356. # as_whois_server whois.ra.net
  7357. # TAG: offline_mode
  7358. # Enable this option and Squid will never try to validate cached
  7359. # objects.
  7360. #Default:
  7361. # offline_mode off
  7362. # TAG: uri_whitespace
  7363. # What to do with requests that have whitespace characters in the
  7364. # URI. Options:
  7365. #
  7366. # strip: The whitespace characters are stripped out of the URL.
  7367. # This is the behavior recommended by RFC2396 and RFC3986
  7368. # for tolerant handling of generic URI.
  7369. # NOTE: This is one difference between generic URI and HTTP URLs.
  7370. #
  7371. # deny: The request is denied. The user receives an "Invalid
  7372. # Request" message.
  7373. # This is the behaviour recommended by RFC2616 for safe
  7374. # handling of HTTP request URL.
  7375. #
  7376. # allow: The request is allowed and the URI is not changed. The
  7377. # whitespace characters remain in the URI. Note the
  7378. # whitespace is passed to redirector processes if they
  7379. # are in use.
  7380. # Note this may be considered a violation of RFC2616
  7381. # request parsing where whitespace is prohibited in the
  7382. # URL field.
  7383. #
  7384. # encode: The request is allowed and the whitespace characters are
  7385. # encoded according to RFC1738.
  7386. #
  7387. # chop: The request is allowed and the URI is chopped at the
  7388. # first whitespace.
  7389. #
  7390. #
  7391. # NOTE the current Squid implementation of encode and chop violates
  7392. # RFC2616 by not using a 301 redirect after altering the URL.
  7393. #Default:
  7394. # uri_whitespace strip
  7395. # TAG: chroot
  7396. # Specifies a directory where Squid should do a chroot() while
  7397. # initializing. This also causes Squid to fully drop root
  7398. # privileges after initializing. This means, for example, if you
  7399. # use a HTTP port less than 1024 and try to reconfigure, you may
  7400. # get an error saying that Squid can not open the port.
  7401. #Default:
  7402. # none
  7403. # TAG: balance_on_multiple_ip
  7404. # Modern IP resolvers in squid sort lookup results by preferred access.
  7405. # By default squid will use these IP in order and only rotates to
  7406. # the next listed when the most preffered fails.
  7407. #
  7408. # Some load balancing servers based on round robin DNS have been
  7409. # found not to preserve user session state across requests
  7410. # to different IP addresses.
  7411. #
  7412. # Enabling this directive Squid rotates IP's per request.
  7413. #Default:
  7414. # balance_on_multiple_ip off
  7415. # TAG: pipeline_prefetch
  7416. # HTTP clients may send a pipeline of 1+N requests to Squid using a
  7417. # single connection, without waiting for Squid to respond to the first
  7418. # of those requests. This option limits the number of concurrent
  7419. # requests Squid will try to handle in parallel. If set to N, Squid
  7420. # will try to receive and process up to 1+N requests on the same
  7421. # connection concurrently.
  7422. #
  7423. # Defaults to 0 (off) for bandwidth management and access logging
  7424. # reasons.
  7425. #
  7426. # NOTE: pipelining requires persistent connections to clients.
  7427. #
  7428. # WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication.
  7429. #Default:
  7430. # Do not pre-parse pipelined requests.
  7431. # TAG: high_response_time_warning (msec)
  7432. # If the one-minute median response time exceeds this value,
  7433. # Squid prints a WARNING with debug level 0 to get the
  7434. # administrators attention. The value is in milliseconds.
  7435. #Default:
  7436. # disabled.
  7437. # TAG: high_page_fault_warning
  7438. # If the one-minute average page fault rate exceeds this
  7439. # value, Squid prints a WARNING with debug level 0 to get
  7440. # the administrators attention. The value is in page faults
  7441. # per second.
  7442. #Default:
  7443. # disabled.
  7444. # TAG: high_memory_warning
  7445. # Note: This option is only available if Squid is rebuilt with the
  7446. # GNU Malloc with mstats()
  7447. #
  7448. # If the memory usage (as determined by gnumalloc, if available and used)
  7449. # exceeds this amount, Squid prints a WARNING with debug level 0 to get
  7450. # the administrators attention.
  7451. #Default:
  7452. # disabled.
  7453. # TAG: sleep_after_fork (microseconds)
  7454. # When this is set to a non-zero value, the main Squid process
  7455. # sleeps the specified number of microseconds after a fork()
  7456. # system call. This sleep may help the situation where your
  7457. # system reports fork() failures due to lack of (virtual)
  7458. # memory. Note, however, if you have a lot of child
  7459. # processes, these sleep delays will add up and your
  7460. # Squid will not service requests for some amount of time
  7461. # until all the child processes have been started.
  7462. # On Windows value less then 1000 (1 milliseconds) are
  7463. # rounded to 1000.
  7464. #Default:
  7465. # sleep_after_fork 0
  7466. # TAG: windows_ipaddrchangemonitor on|off
  7467. # Note: This option is only available if Squid is rebuilt with the
  7468. # MS Windows
  7469. #
  7470. # On Windows Squid by default will monitor IP address changes and will
  7471. # reconfigure itself after any detected event. This is very useful for
  7472. # proxies connected to internet with dial-up interfaces.
  7473. # In some cases (a Proxy server acting as VPN gateway is one) it could be
  7474. # desiderable to disable this behaviour setting this to 'off'.
  7475. # Note: after changing this, Squid service must be restarted.
  7476. #Default:
  7477. # windows_ipaddrchangemonitor on
  7478. # TAG: eui_lookup
  7479. # Whether to lookup the EUI or MAC address of a connected client.
  7480. #Default:
  7481. # eui_lookup on
  7482. # TAG: max_filedescriptors
  7483. # Reduce the maximum number of filedescriptors supported below
  7484. # the usual operating system defaults.
  7485. #
  7486. # Remove from squid.conf to inherit the current ulimit setting.
  7487. #
  7488. # Note: Changing this requires a restart of Squid. Also
  7489. # not all I/O types supports large values (eg on Windows).
  7490. #Default:
  7491. # Use operating system limits set by ulimit.