From b80e49d7324343d807fff9db363ad111b38a696c Mon Sep 17 00:00:00 2001 From: Martin Kraemer Date: Thu, 5 Feb 1998 09:58:40 +0000 Subject: [PATCH] Add a document describing a solution which uses XSSI and negotiation to custom-tailor the apache ErrorDocuments to taste, adding the advantage of returning internationalized versions of the error messages depending on the client's language preferences. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@80119 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/images/custom_errordocs.gif | Bin 0 -> 23291 bytes docs/manual/misc/FAQ.html | 18 +- docs/manual/misc/custom_errordocs.html | 389 ++++++++++++++++++++++++ docs/manual/mod/mod_include.html | 8 + 4 files changed, 414 insertions(+), 1 deletion(-) create mode 100644 docs/manual/images/custom_errordocs.gif create mode 100644 docs/manual/misc/custom_errordocs.html diff --git a/docs/manual/images/custom_errordocs.gif b/docs/manual/images/custom_errordocs.gif new file mode 100644 index 0000000000000000000000000000000000000000..d566c5d891e5c574267fe715fc10706c5702b790 GIT binary patch literal 23291 zc-o|Tbx<6>6Yt@NyOy>TcMgh6ixw&FUhHr$ZiT}ScQ~ZDJH@5ATXA>y;(EM(e>3lo z_xDROyPIS;`^hGgnar%T>=%AM<4VLygj>LW<@NQor>Dos$q531xVpNks60V@eP3Sz z00=VE{1X-zWqk1}g+`3%`Ov|Lk7D z6R)om0KoY_^?&uB4d{Oo2=EH}kNsN%00RFb|I`6s(0?Kr3;_R+{qqKff&P*Iy#8As z1b~76H4yB76aR)_Fc9oNX#zF@_(xz96BB^f3DD~V7%%|_P5c7~hE0GcCcv)~Fu(*1 zGy(e$?mz7b*y}&li3!lef7AcjO-#H_{D<`)|F_+L$ic4w*z3P|{150W2>c3yy@Fm} z{{sqs1;bv!udn~Z^a=yN{tLlB1pnWK^*{38Spd-B{)mvkpx}_uuyANZWK?uaY+QUo zVp4KSY8os(BQxt~c1~_yegXgyp`^5|yrQzIx~8`7SA9ccQ*%peTYJav&aUpB-oE~U z!J*-iCX^zCf)r~MT(5%J{eOJ~cp z>#SE{cx%)ahQtCwOP02(Vzej#;n<^2T@APz5|@acz#r7*FJ-_fU!Y=gmxcmJo8-(l>D~}OYiljt5NdSD&L;3EmrOO z6|o3$tS-n736ZRexUHWZ8r0#g8~%M-+}Qm7x%}O};p0xG)_cDWbc>AuprYi;Cn*Cr zneXPoH!DtKvZPv;kp^0;u1Gg@RDLh`#p_|#tE48Lf0KYeJr8E-w<69;fVtu4Lu5uK zTvNrlQOBnqCXs)98GnZH(p&Dt$*{wJ8GY#2kO2l|66cbC$aZQ-G?}j<_Sd7lOxcDm zcWG*ev0bLDg&vKirW*@>8Q2T6jz`~vftL7+((K@a+gZ+#)SaLHh%K~9*zfMBT(T4_ z2|cEhzW66AqWEV8%IrrBRw$rxGW9vWvbHVC})cZR!Lc;4Zo(v}K6x-*pU;CPy5 z|C*y%$>#0a&i@`J*Swhfhi540YRZC50>2$0qeGs&W<`b9+qo z8DYfF)M+NeP`2MwB0BWMGsLDWyV0PzK`=Ygf z9?s}xr^q9ispI9SnYnIz?S!HJ>E)TOo5fW3?;n`~7boXtu29azGpK7$Qtr$5+I*#i zXVm~xx!(GUZwzd=3*7}aIg6AZ5o@cpisI|%*n;iMC7o%kxEDS4vGoBc*Qa;uKS)vT zH~iec@NcSx>hmBtn4YMvj)?b?^=%*8J?zHvR5tIyZ7a$1_{5?g4)Rm%1sBwDr#g?y z8_yn(s|VPhPJYeXKb2{m3E}_;|a6gUhK2o$fQfbd1D-^YLgN$cAun z2x6T^^Xb{(#=U~wWg#B&Mx@L9GGdx>R$1KnG#FMxpUqX`tmJo?Np*>WaIYeZW*U zLn8{0mnmr;6m)tI-DihRDK`0AtnOA{F*x_U2rxk zJ;urm?}q0)9&f7rvCECnzAkiA+*XGvl$(%_Ec6TB*2G4Yn=yP{9M-+9O&u%$*1F#| z?sZ$2ja^|W{dH*ycKfSXp~Bk9T_dP4p|U#aRA*Dre}4G3p{b8q@I$BG8ht@SGj^pT zk3hf{#a+{&R3#MwMgUL}@UHW1rAtvn_m1v-%Loq>avOock=I=-;%FywugwZpSW4UO z+jHdFh)*i?e;Sl1a(I|(=2b^yLN4hJq&6RVtaefoy3`B(nh(R1ZrwXS-cZxal!n9G zaJD+uL>y4Pyx0ETk{}YBbG%$yhMi4abkdhg+8Ib=;Ql0v9Pg!qhyhK~*_-+>h^26i z!<7(`76?~NS0Chs4X~a_h>`I)LO7_RG4Hi|;BS!KH*Mrny|9V_VB{DS|9LbuPd{zL zGlPmY(=&y%Y{g_trJuH@(96WwDx&JN?I$ztd6z6PI?!jU(mm4s_((UOE5F%6^YHO$ z<@7ivTHzIc=5GQcddU?rV-W%B$Z3t_mcQZ{un=fzsu2uJxRcT{%xe&J+ay{Ki95~7Bbp4q{ zMgnjXzX&#y7j5SdwPLAmZM{hXq}KSxSy+ST4c*} zf*A1&j&t6dw*W*kfn_qj+QOWcorkQn6{mNc$5RGJ2Z(pOMg7OUyD#7$rEyVvk@OvR zBPx1uQYg!;K&SgV6Wy!j&QGHZwZRn*>D#p_X<@vhOz^V>!_IB86mDijJcLNJjU&9y z&cW6ct7Ovlg&j?PRq(-OT3*XCM~q?4s^LwYgm00OR_p5DN+n}b`0@lvJ5SUfMUVEU z)x+mD%cbv8Cl zyA~z*a3!zTrm>x)#BIhp&zZoQdyG;BlHObZuDOtF)qOwG=ec@5?;VYavjvllBdwI{ zt48?B$hVEl?3kSRKkbgpsDcFu=Z=D9!dLS)iz8QS&SUAL`ycN-qe5b8NOB_oIRA7W zJ&$2{*{%{3+}0^F)->wjlNWPUyGQd!mT`&SFgl(Cmxo%Hqv_3sA`p=Qh-3ovECPr; zTo;Q3!4^(C7rHD1#O<1Niaf!!kC09{vBS7~fGh$w9tc68$rahr zlWf86lujfM4Z@-wv^@#Amh!Zm4HO7N*z!kE`e-P!5J0Q#{KX@9-9Jb+RS%XEXjm+u zPA2lc$xmB5WG64kVppIWIp|HYsDw<2Ia#PPBd&F-m~E;V#3=ZCQ>c$jsH?Wv0e6Vy zLTHe7*z859|AE~(I4p7@Y{ft9x42&5L0F=8_ySdUa%wn?AIGgv3%^Jwn+%%E56#zx z7J5L7Q=z3z(DDT+4oOfMaYQYD#4qiL29JoQ)QA=j-HJZn_4YVU@eDKS>;O-s73UfO|EF zh4T=LM;=EY5J#jFN8%Z$h8L?E5(%j`=-@|3s5acqi^cDZ9rK7|Op9l3j%QtrXMcz< zjg3PL4^K1-pq2%m$%qgDuxYL0F|x@)auP#*O7bK;DfMqs1t8fhjl8Tgwbm#(I-JLH2qVHX)zLVu z29%Z{fSE3fnRAsfQczPEwvqxmQs>xPnbOMfDuQYIT@ZY#RQu?OiCBXoDIj! zKTNCM$k_0N?dW6`m&9@38wvHtIq-`STx6-Fg`P73N$(T;QdGV6Z4Isbe%Iv^S?C>t>H4du;PM)-`^| z)XlVD&N4nKh=0ttT*}naEii=@C_bhQ$)>%BW+)sLWKiTN=@R8LmtetiVoM9ltzovX ztniRrF-ETlOQ5S)8HuHt!MtmrbUwVq7W!D`F9(Dy9?rAp9Hp&dn8?NZ25 zUM`DQnOkYu*sPxUUYY-`&7gZR1dv^9WadYXfDC(&wC4!0@e0MO*tf2Tg=QXEmuyhL zj^s*+JY8!5*;2;&9Sib(2cVNz~H{+=nH7|;{r77J9D3*sJ&rR54WZ3@*! z@@a(%WnuLzL-p!QsiB9d>c=Gp5e<=x4XH~R#v=_jBb97=jg073WplPCI%PaIbs9SQ z0{rkGdNY5!J&Uy+wJ=?YFA*5+4|(In2r_y&1Bcm*UKMUO6_T9EDXq;Z5smmMl9Xwo zPO?Bx-4+6)mL=4tO$opl9YT9}U2Hnj0VqcEE78hOb5nY2iyq8lB*cLtED+>;ann?! z*ET_n&?of?8H8|-o?4rZgWcRZCDcAMQrqsW=zXjk>DUr;tlxp2+J@4+Ro51W+0LNT zevsaA)S5iMY@Fjw=O|N-JlTGJ-=@bCL!S2gvGw=!@^ARlZvbT{qHrg&ekZC=CorQE zqpcHbr4#456OXcsK)8!YIKhmxEnnJTRHln^rR&{u7ZqhUwQx7BemA{*H;HhW0vz2C z*c{I86MkOS&Uymn*6-o<>EX}l5zNpTT+sU2)FVpSD=yqCso(p>r&q>Dd$I>0|BNU< z3Q(l%Q+`HNm+w3F?$gfb({1Z(6V;xi=~JNWSEcOZ=9@@2pB2(RN+40f>Ngec zQy&Fb>kqj340z~gx$gpeMhCDb2mDt0fyn*Fto_P9gKDt@(6+(Il|ho`0pB)3B*5U| zVSk9vpc7?ZblXtI%23t{W-R4k0_70Ihc4)(H}ttTbrcZ(JXHBSTzxW>gH@Mz0!WG! zb;uYl&KPo`9O-x->CEV_Tk+3-?kn*b4JjY00HLVaBC4N^DpHP436H^N$_rz$%JO_h zwBkpGY!TO<$Hqs8AKn0zPsYg9`e!r7kJ`qiJjaf<$G^6X4B8?pNlX9$;}g$guz>NC zl?nLs1X1$%p9!2MBB;0*pXKGesP7qiZ+Z<+Zn7(azcYKt@e8Th$)Yk%*Kd?k9G?jvP*q< zbH%<35D~1h%!TsmY5PUPAfHhV<%xCM84T<{sc|z$tg{T6CEe}wu}n)jt4j)}^HpqE z`UbO|)hiu<)#|r^T5KWWdBfP%UKPqeWLJ||r<3iz6W`mXzGF6;kId{>%w`)b4PZBz z*{m78S-%vSJvS)PL0Sqvt?#R-e^8j!^P2BesApi?xUrkoXkABPU#)4I-gjBG(_T)~ z?;C%f#BE=0JRRG9JKLkM;TE-)GL)t?wyt$DaP8aa zrbbrUhmLJ7`@&=2Ey}Z9IQF`pA`JO#OI~5uGd%~VUE9<8G;2P-&VF`a<+o+S&XCDaOY08*PZQHTKJ_sMnk1<@+9pAJ5beQpOhhyz9rE)ix{fIaE zIH{wwEo(lzo}`=cmAm|Z8Pg4JnL-8{tP?jEUNN!)$i10>>{r60OiN=$l64HW!6N;zA5YC%cs>> z#j|Agi`vS+*Qck(_8S=Q|6<}^y>a+EfOFQ*z98N)GYG#R!#!ul{d=pw<`p{E3>Q{pu>gm#2L!^&Bx#4;<(INpKJBwH?lW7KD41hUyC1h-CiZ1;AG))4^}ek%+CR3Q?>Q~sovf{Q|Gs2BT{C?x82ouf{pmS=?Xmvr zeP88Cf6VhI-2FbKm+qqCWEB*igo~X8^M_6ic)8N9vJ&>G9Kvst-%tNQ7d1&$Q z0i6Ov5HvYS5Zh+;( zusH~(Ww?sQGljh$DThQ0v)x2wa@B(gD8&(4h?2kGP410EsFkcehx3%pRp_^h!!8l% zYjEiqA;K``lHnlM5uS=ZmQsmg@$j?@C|}iDyU+P7G0TBOTZ|=ogLr|<+;Z|6MbAgH zdHUK`UlzTNNP)V%-+*rTS%P)4>81t>eiiZLRK;>X7)d^#KiJ-27-qBF5!G6>KW;MA zVno^`G4RK_hi;}XK4rT<2eSmpkksPraHdQzWdH!`Ck6Q<`B%#}-2=8q5+&F>eg5lNW?Dc*fQ(#%!;z$q%#DWgc@Ww6{6pM_{Gbdx3#)s2I zpGLeTQ<9DpN3w5KQV(WOuTtn`$S%x+S}U@9-68;&6sG9%qc3G7V}+N^xv<*<6QYwgrVy+uGqr2`u3IFn>BuL}yJR+PBw0EB^PNE^9?M_W*icxwui<6M8NZ51`WTNR|=QKD8HBnYehRJ<_SwqzChwgw9Xh0?d!kS7W?-5g2~-z z4Y8NvW+_!*$uOa_THY{V}>NI!eGPp~@v{eO8Izf1ckJHlz+ zF8HIV%6yZ$MF}VOEKx~NHCnpm|-@?iqJiwCjEWT2ZA_7ny}K4PgwSI=Q>4M+tR#QKlnmth~)g0v4?Qtl5-Th5MqXO7qFYNx$@(MKg0HYERu%qnMc~2m-(IL`Yh6+q|zB|Y>UO~bOQki&xyut-{QCna+SKA`U&8lpaysxQ_ z`FND(q5Q$>Gucux&Yysr)4^_cYryFOMA{Wje9>r3q?b3&W_Yn`N zc>FWF7yH*g?zDlgFthsxS6tw z5K#=rGtsI1$)INnYLOrh&@9|KZ0B&em3K)mCL4{P`E%Dq)pkJ(rCPEIImMrHc6tVc z*g!zrq5z5aN8%tt;WGl$BnA6J>VO@kQqH-)R%#wa1YbjUvg6+s_HKZ$W+>u7G<>zw z&T=r@DS%ahb$;AsG)tI&iQ07dC+&RX4?0P8OC7iXk!eHS`ilrE^5U3d|E=dyrkyRz z1Ek81s|xkb%$oYz0f^!sVT!u=J)LFsyZ9~pB<6Wo!o@7u^Sf7}-QO#-6&^BKb!zU@ z)zs5YRL*E8f^6l$4-bF(`rnysDUQ*)fA!h>oY!r(#d#{O?Ts(MH*)HM1W+fS0k5qQ z(~w&Q`lqR)vD4pL>e-vhImhg&->t=q+1lh=wM~|0iN_nbWbf2Fo>+_TqUkD!yaDmL z(uaEWOguOasQaEpsd1gnd7e(Hzey#)*TrSLjE_g?)H#`M4*z&>@CL6ZL7AT}^0R<- zuta0o=j`UhTx9ytI)49w-Y+)yGD>q2#__e$35-}KFw z7<#%bLT(|2o%{ClTOq1ncCwP;I#G*GxOOf}Ev$9m6X`CrX&RPh^BMV)uT+Bj(8ump zLgxdE#N+JGnU)9L>pUJmrIFL0ALMIvuM?G3pEms7u}9n7m0EatW?^CFBA5T`GzJuq zb|9z$h>;>r#>=J5Ac*>V_>k~}@U3Nyq&HABw`K*K?wF)paJY(oyj^(TNlG|>`@_4| zeL>SFjh8U(2EjbX>a&S6TBCMIEz*OTGrE>HHjiNEtx{nUR% z)LEix zY;9GQf9(Vl$^_ojzHwS1P{nW82@3FZP-3)k`W~w# zt&5SCz|SQzxFPLE8%>xN*aB9(b!SKk*2xI4N~MZ<)Q%V3j-!7FdE`%0EQx;xLI9J< zAJbf;Ld>p1%<6bi7$PbJ5#5 z@#1OGWBg@fAf8Fgp3#4j?Yy;P>yqCIeMIS(VC*(Wl;42bhRRGq1a%IiH=DwCWjIIU z45h9Kt*!kQ$GKrjxPP&5=dj*_un_YTM_%tFM!eX>$rC6*UQUt*J{YF2i9a3KS^C zLv&dqkOPd(AI$dY4g#cp|9lrt7AIWcp(KRv$h<-R%L6qoG~?h_`CKfzqZh2P3BLXC z9)~l#&oY}s*D~P`jBzExg2wDjsBRObr*C>4WU1v4_!9zsXo(0XckQT_&$>llYcZr_+1sdoq zn<&(jKYW|-0xhB8M4tR5{zD@D_KQy=eUvw8!W})n@MOB%Uji1YLV_?yu%lpplC+$^ zw1=5A%S>VWwc}}WNjo!vJk`%pS}M4^4-J3Tl%`#dI_h#Cw{Sj=Xo+~9hAv+%lJ~Z7 zU1>Qluw-b+@wPEv`KWBu3!6YD-`7l=+Mh6&B3ALf1dR)&@ex^Y#>qQRJhE0iNuY4F z1)h};)}2f&6CSkBW~xLw#=VvbBm~l6Qa}lq6aEEA)hI(*)Bs%@F{c+<0nOASAK5M6 zgDeLzLpLA8JmBfDq6ifiIimJHTfd&7B0~^aqO0i6+{UxXsq%vsn96=i967re>DDal zK^HM?h-Su2_x)^|V~Q~Bdys+C~ub4vwPM5l$K|uBiC)_ z_geTALhIjr)mqq9DUb>rKbB@~MZzmqccX1qEn;s!ZqEdv=`vr}w#(S< z>$DujisuCfgTAP;Ekn5ntN!Zh)h@}$FxN^mm*}7h?KHKnf9*^VMcMz_X2SB5Hdy_! zl(Ar>U^|psRr$ldkZ#v<)sCJPW@MP3q;m0eZ9zfB%bOC~viusgP9|1#1&xMW+ID=| zK#xRZ@zD1|DWUb@1z5^RY`wMIP2%@vjTuKRpNEyQ^m?sXIy)po%=zWv%qQ)xeJu|z zWmCxYi={{bD$V?(9rTlkORA{-Oj^;%&RaV@bw$)m**? zwNJZhf6$>RCk^amHP+=rB*GPQL?$IiT7}{z$hWPJR>sg~{}D@9Hd;pK`m!1$m-iOccvdB}tH~=S=^urA};3+|NI_m$nlj zfQdc%seR#zc*hCG3gFJ@)XmA%ea3sV$S};YPLnqk`w=o6RIyNjPft{cjwpQ@)@7Ks z9qCx6vq%0Igdd6Za*pZAUe*s#s`6LZ|YNVzo+u0VyVlr)W>d5A`SF3>H&;7vt>a>fs+yIIsH9gnmmZ^!ul~_^mp9 zxzQ$Fop>onzS59Wax7%yvhUU#`OxA>1M_X%$oT%j_^?>#UU@DmYBBOWb;<>qK~3#KCchC~$G7Ero>mpWg;+**q%7T+oyg|^xpH+42|~)-BY1Fj3KAS`fg(}A#>$R)&_y% z>b3rk=-CF|r=73%Z$JBku;SOa)M$dEl|?X+6o-MLlgNyCAObFy3Kt|{fIJpnPp?gH zftgk|(L#%er;0)fJ!X+KY9(}aaq#VdiQWDP+v*_p@rd1&IQ(c#WEFBoJhp6HBl4{s z=j8XA@yb0S;x-jl{HA6!pY%HYaavM$&*PSeLHt6sLAgVdYbE2yCX0yiH{ z#NWzA?{{QhzOIofz^McXb_sJ^J`;RplVmDLa2Z~^m<$cBObr%g3J9@Y2Z49#jgV9T zYZ{d03Q@~e(dx@({CLs?&-OQ3F*iC@H+mB{1`{{zKZ&1EL>B9*8mD4a{CG$%C0I#l zX{1{VOuue6r3GF=1WKC3az%wz8=izlGD?T6a4w&NdIbo-8!1(*`->*#Qq2akz)fWM za%uPy4S*!S>5Et{4j~es|6ai@8bR`nRi}gFlyWjC+p6b0QE`1CN<~k>^u{I<5)hW8 z+SS+?rbLG;{2yVHHd>)F`2qrkZ%-z&-_^VdKT1*FEBOO3z?_1($CdTH^R_w zyB>9jC|CExS9~nyJc~T1(sy|qWIuCPUG92^BdrHTe3q2Xhw|Sa(fnSfJ1?}weA$HF zTTigKBDv%u?Fn|4zoG(VW#u5jfl9$a%CcdQ2qmy`gq)IjSW;@TQY<)KITNO=l$)QG zUYJ*uj!<4vS&4*%jg45}fLK%4fC4~7Xu#^?!0PGk@8KBgsTv&{pP2lAb8Xi*Hn;xE zwS`xy3G)W=%AU%x0RVJ?f^xUAe=kEqgr4sr$mrxQWtC}U!Y~XGgAb<})H3npxapW@ z36b+asv}aznrzXnUN5D=tf`;`y03}?1OGSKR<^EiEPZyWxsER=6T|a5@z)!!!7t(X zY-dagTS}8Sav?w!2s0j({7W*UD*;$mO;X+PYaDYhvxbz)8?fs&u$F}5Tc;w)SIp1fyLNA*glQE$u*s97kgL|>-gXq8r2U)KD6vQN8M3D6|w>o z#TgZbmvode>-|aWx3XI-#YRubuSsZBq0mEbYCK=>48(lzSBDfsD;bPI4Zr;U?t?qz zT0n`~AqyLCRs-0g^0t$ja8~aC55eCDosMoNJlpJxYJM30+b>+;aF)_JprmnPqGpP; zeqA%2s=n*$mwB#Uy5bE87Vm-4H%P_zRJDg~s%TIp5Uc+$HM@1IanY%y>5_p?!8bl6X3%Px{^TPT-q zL_jkqAgd4{&vKYB?>10UyyA9z+L&dsxF9HbT1~EOX*ftv{dV|j zW)qbXW-O~SNzGp#Zm0wiitYvTFf+zZ?Kp;!S%9Lso?ZQhM#kYUfGy@(Kc)ML(>J;J z5h4{?ZVO22Nn+#~)hrJxN;+-J8+53Bt=`*6{LL~8iL1A)2iB!j+3574aMB(BiE-kJ zyssu+Yz<^u7Tp8tT6QySNkce0wp~|%W@wG`(pS^3>t?Nj~PIR$Jo4Mr_E6qwS@TFh) zcLy1&d>YkRbF59HR|0fngWG{Wzqe~(w&GDv0{Q^rlLnaHCJGj1U}ET#PSH8znc#^gkKk{Ij!Tc`Pa13Y}2+4_# z?)xM*>)?phvmO@|5Ls+BY(iMJkWyMt>dD;`?T*~ZdqIXR@)#U5bMS#1&`c%n+!H$` zx`Y3NhRmBg1ZWHyCwkZ{lvNa`ij#p5jTo`$-5iT#0l=i2DbSp;Nw;5mISl&uK_C5S zqk^Y50}}txM(D7H2}dRxULQ!CUr(ikX7qDBaE*#Kh{u&P778Syii=zx=lJe0{W27XpkBZSH zc)cf$l&cr_aHZV&n4czthCf68J8@4e-7`8E<9p1sJRXu!r#~e!4cf=1gDrWkz<0LS zc~r9pTdc!>p!PFB`VUNm>@BLOAh7~=FhDM?dJ5K(h^}BHs^|n&OX1C-;Fa8dF=>`) zKKSU-b5-qof;#3yLom|CngjW@bVxHAa?L@^5Q@R@hpyV9tP7 zV|gXIE#z*|CkwbZ9_8pv{xnxL+}H+f-)5?ZQ%b6Djf1V4qyHvX48oHt~zY!(ct1SwR55397?Ra(JV(cIB9!f8s%e* z^IN0mh|US}S$_*#YjGH^zV6@|*p2-jKYNb1Hdq zGmrHr;>OYU?r9@#nOwfxD{D$07i;u=IejW@jt&b2+s2YA6As&~wPL(FYVBQu9NJgu zOcy5x3~Zc@MK+a>Tc!rr`U{?HO!H8+$urMt((#)$y0ge?{4{vZYdw{E7o4dz zziiYZYW`v9a0|xO)3OsHS=m!$ZBel^5i4t|Jlu0OuFyTQqTyYKyIIzv;Y5L#3CE&U zmslluz-_>cjX&^fP%pzL%E0-19at8ai>%Y}cyD);s0y`RLh*7I$flA zQ@Y%H$TW|={Vpk=&e&#K6Ss9?z|e6S<7Q*bZ)VzW(0>!9(`tr-YH?rjuEbQN5#w9N zoBaccVz8XQD{k9Hpx<3n@rr0{{0wDqu}9>P??r6Pb0_9cZiUab+u=Wn@+lb}#=Wzq z5+~M&_iL46dC#JLDzzUKk$bJb&5DvI$SObt1#h|Tdz4MIpCyobt$q@6vehI=Kx`^m zee-%BYXg5d5Bk$%gTQ&^oKJIEr1TPX^J&}eWOHkm>;MD;T3*g)wK8!;kI0^KlW=z=U2)PWNrV)B9MiLweO@Aay`_5wH>;~L^k?*F*VLULBMYWcf zGFSpQ6KE5jhw=kbvB>WAddw|+cLFyrARLU&<+sXj$ed76oVf=HB$|Rg-`fQ4I2qDA zOOpli9K0b4d(&E=B*Y&`fEJ{FK%ltbh@ufp$q!K@3u#RZvFi^}HV;t@3(?Z1;~Vs! z=!ZM)P}%Mk1~Bf~ZPDvrBwGXf9Twcab@L+!Em76{J7kelE&^6^yl}4rA>;N6qAgZ~*U1HlB5?ik? zwjuf935B7jC?TH)ZLWE=f4W78FW68oSa7&m*PH7Lqndwj2=FF0Yfgc~-T9+6c%vMeqLiCrP!GY9ZkE5z<9uDhNp)f<;7ry{ zU!vYJT1hp4&59!;%!2~=%*LCHegkdGnqpT0(Na>R24O)fP4R@`mXWCOrTqz?1#I4g z$0MS|)E&grH^D$#@28NocVP;vH z$?xWa&Tb-EisOImg(9L`QQap?Et=VsL^k&)iw{K(12xmgk~%bl!UiL)!eassty_~* z<}7XX7YR0sxrrCtkorT{k{xavLXY>tvzx2~$s9KO!xob*r!}M0HMENs(iUzVE;XZ= z&FvnOqfU~Ivt?n$gVw%Hc8k2QU30@mCOd@2bn}JOjmcQuRHZep1mu)>cz3g3OtT8w zl&c~^rgA*hpnxMyW5&ro)Vk3vk;~h$h$)7Y5~0LpJ3MoJ-rLiHz?)QbJjHX#BZXPxZw;><8LulGFJs;1dE%mHI1u8(Gj zwMFU;^Vztt9Audc1)3imcs>9kp3RaRT3uh>G{-SMCcl)QOsNgUK@LTS8WJDmndoTUKJc!j#3GGdWv3_yDqYtnD0!s^zxZJZZ z^|B}|aYz`9F{!V9O-}xXQr#qL{j6=hoRn0+Z(Jyljt1AOKI5%9@v0ntEXfcotuU&k z8>t+TE2ST)Jv}PvTdHM$!eH^P9X_hfgVyqu)g3XX4Z7YuciC z|N605dQ<9Oc?Xg%s`8(+UTI3byASU}P3aws_`a(l-H^IEYv*QO-j6G~hQ^r5@KSM)*G$`L{?_)M!Hv&8%x32j7=#innPB!>k*QsN}P00v)%-jwL3FW&LCWl0o=$?p$ax?t_m%m2J!MJ_kZ zJ~fSZHgPOh4tO^W+LV(Ech7pKN$@tpSvrk8Ig2j{G4z+2cD{tfV?zI?#S4mP1NT=4zKbPAdcYdU-8r}GbLV$H_#Rg;G ze6$LBDvb~J9OS}k3AIXzd`N~IcK0hl+>EspG38ELc>ZnjB}iSTLA&KSWjNkz#RNKH>^i;P0# z`x$rWN`NH2zwcpfS?vw1u3QX%lb-a;6N-A9-rHBBuoCb`#xANp&EqgFsX5)ZDJ`vd ztjua`31f^<$iCT1M%bnBD7sH=BToFV(Ez%3u_azc1F%>WY>`aoo`2xX5ZIBwtv1b-~W} zm)-myuH;cFpKHwJMUgf1?kR+p9{c?sf9bUoHcHC3Y(Jjqs9xLySJrMt0+utau1iLt zp+E1*eaRDoTKKh*3^$PdHc+!RfE^ncYa3Yb4V-tIc%L>23^$4VHc7HJ$vQSE);1~O zoA2IjQGME?Hr%51+oI3fqBL|X@a@4#$VzcvqZ;$v_FCs8V{55m$Fmihsa^>Fb@}{nzx4Mq*^D|ROTCnZv;}FV!%7Yu^InC^v zou#V#&A4asd-}pTy(|2{@V#WWy}L(ffXEMcF9t4f-wTf2I`%ojV8{F2!Jbi3TVDah z-e*?UDQz_;$M-;*Hcoj@UQ473>A9FeW)O8H{VUetufZzM!m($1h0d3pXnRSzLruD& zUM=#H#079Wf5U`FL%E`sDx*_#UBO zpcswwhK{|QUFK!rv##q__UouQZkD-%_n7L&#bDR^>*7{Jaz5FAYQMu?K;GLm>c+XKJHTSg zYk_uPQI@EY?C%l&D`#%TsF*pido1Ts%X7&f@EY2Vlmp!44)Xh%=p0krENAj8uMNvB zzbzm0)&SjWB;7LK^44wKH^1}$&hcrM=JWe?!Oio64)AN&Bs_d6J-*%=no}pD{f2q4_UY@_+W5 z690hk0st^II2C}HsJO`3==ca3DLF}5X?cm6skzD7>G`QRFwoE-V0tPbN_tuVAP{i+ z!XV2qTU$#z`|@IPIQ8qhYcf1IXab6yth~&u$uLp^bGZ8wphcs#^`e!P^|FDr!Npa^ z)x`xQQVbx%PzX>h2rxVNQL+vsKLRos5HeV6il7qq0GMC^Fo3*83j?TI@Qz=#W)v%0 zy#9zWqsEPkRFy(y$|EaRuuR>OMQfKXYSa!bnlj6T!F3Zk+PsNV6HImR<}pZ-f<}sK zS!iU@q9vSCa9nu04Dc?Vp?C1)9h1kT#}5VpWQs^6s2!7lgI);ir)VKUcnXU>%?UTI z+_`jZiUgTz)JFlWUd6I?^5nW=!-nw^R#>J?gLNA_)+nzk01_mE(zv`u%TR9IzHKOm zg^PwVO$Zx9B(GLksAU=82;q=1qO~Zi@m$An@Vo%DAN&3dJb2x^Ac^-aDIjo4l#6xG zB&K-gbK%shPx7^P9f`@6Eoakw4e1Mh0Kjcnz=g=YdM**d4loD^qIAV%1Q-DT{)8eN z>$oQCy*e!@UY!r zlu>q>W!PX-lol^!5e^rjaWO;}Wiau?FOf{qgCy>FBI1Wa4oM_k4W9C#Unb!K7=^X5 z1SKsxBH~MtR>I{DOV$8InTg!JK*9?`(Xho(*rec17EA#UBROT1W6oO~y+h!YcHW7n zCr5^)*GNhVKp~S8R>%u5hC-ERqBi}~15Ag62UH4O>ULsfB#gP)ncZ{)PB`DhSk5^= zY?Q_aH7SZ}s;UOCXI`tAa@;A(G5I7*Rm!<)uFTxJ=@waRkzxvyImaFTWkFe%*_lWk z!;7uvX-7|Q`AmkmsC!3C#bZ6s+3K?cK>Oko5XOHIu0252Pwk{4o#;e`~E zNHNYh9y4Nw8E2GyGRh^Jtg;zQlnZkxed5)vtl$n>t64Gc{0U6vZF&^2S_Dz1P$fFI z9lVkPMW%|$cE%Yu>6YOyCQ5@bNg4)ky*0*-e1R{%UOUo6#T1`yF(XZc%!L>qv&}^# zW`yx3-E@~>H{N>F{W8zxayv6$5SsFBN)tX=wcm>GSOyIIb`$<~X4e2~G_l1bZE1HY zZUHRiG`y&$QljOM1s91sV(ii+V6E`MNTfkV6C9-Rdh7%T>`2(UkIjgA;Ghw4#A7fq z{1{_+!LOWakF$Z>k)Q#0BWKioqZCX?v4r*5TOY;sXDqHQ;I9h)=d3taSSR@EQ!)h? zFO0)xy3F2-Z_@({3!vpmOKPc5MAIMx7GXmR?kfWna&(=gr62%Euv7{X$AN-Hf?!T) zL=(c61_p+WcZ!%;B*w6mv9*tFk~l;37;%QYt#5te+e@sL1eo(hX@xYT1QcWdr=@I) z8@|endjbLLu|FsPu_~5 z;hdz4Kq@j43@F3z^)W5;03}unr;LUh8H|xiKBGl0msz@DJlXC z4&-0}w8phqUPex72-^`BQA>QG!4YlT#2oDi%sY~7Z`8Y67y!A*RSgnWgGa%pKCgrzJE zrbS%pZlC+yB_lit2{dR7j*J*#$bg3i;w3Z+{%F`99p#ocCR|UV+&djLt+Y(?6;eXE zfaZ@b3Q{UfVOr$K=2GH^h4Q=r3y|YRB{@UC0UqUE)N-N|msp0L)FO?k>kgNU)g8** zauH&@%up|(Mt&+4Utj3mQX(OS5SH#1g2tGAW!vwMkgntc4O-9I)D&<;tv4=$mBw4e3a0ssGB z)QX~X3=Qd=E@z0((UA?d&=R0sBSP8A_C&KU@oYsjJ3#PxwXPo#ZQLMxFp1DMwU>SE zR(BiRn81y+%gu;eM|%2<>wJ&9-sG;gzQJv6Y4^k4-nRGO zx{9Q)>X+20Cf0?XBOS$%YvA){wZ&VF>}B^`;{nI`#XFvCkmnlXB-gjKJ6`d9S6kiH z=C`XsE^dvJeBK<7x&F=XUGr_98`?E*In4oH@_i3{==}b7%L8t4iqqWS<4*d|b&m9V z8y)8|r+2?U9`v2ZJl975Hqm9Cb#nO{%}%;BFF14|FAHKA6TkS(Kkjz7&%ESB$2!4- zes`18UEoolJKXy&^sH;!<5>4Mz)z0!jISK!cn7<#4G!<8S6uE(pZwOr-gvt&zUnJK zy2>km_qWfz=lO>G&JPs4{*x|y%p0HT2OpnT$5&fJBAF$sE4+3SvuAyDVT7MHbwr2}W0zxPCoW8w z6GDCO(w~8#s5v-U@ZpdHI zvYxORj`c!jT+e(~mvn^25Mc#Q6bZ^>wkX5|s0ppDze zg*T>uzcwh8NR1WfHi=}vu!8ne-=z-6u3Cu{0?O2WZIDyGvkA9;H z+X#>fS3b{lhm6RN?YDzpcY{TDj8?aV@t27Sxp+<|don13EGU7`=XorsimKOuJD7}_ z_<<5>i2x*+c{4~&qTm2a$&^j$0NuDzhgOg~rVGP1Y|_MjCaHKXxqLY&bc}a+LCKI?XM!g= zfYX<9DtLl7cY|f=lO}nQU@3iWDSUK^Z}7I2Yw3c`D2rpsl6gsvdzo!xNtPLDmcu8Q z6iArw=YWRCed-66ZRwRM*N-uyluqfCP-!!g7!yjCAxx$toe5={IDa)bnHKq&J!zCz zhn9c&lLXkBFPMN2`GOYtm5v9Sr+AyI`E+uro4l!W-nW;piJQ@9fU&uogV~s=Nu0vD zm1+5$T6dhR7ns1=Zpf*aTXmV3$&{LD5_!e|T4ow(XO*0$YR-syOy```nf`+g`Ev26 zmFg*jA_t$$Iew9ekV`0&w;K@pnw@}Wm~hIL zl{%@7X?`2Iffc$)Aj+NI8CD&YW>Au2i$)A-N}BS=bUDg$E_$IjNP~fyff=f+6Ka}( ziL1A%kf*qyxLK-UYGCHeSNvkS(i3-VeL%E}}*^rjns}E_bE7^4p8EzIB zf-g#uy9$>fWvZBos+DF)!r%*)QUB>LKv>-uXQ6>NQ0o+^48^IDQ}s<5M&v3A0+VM<8-nr00bY;6`DTxM(= zi?S)3uU`tLBKom}^RSDUAs3Q%e71Iurm{J!vmVm1ONpxf`?ZL;7Z6WTC6nL*M~etY z>j4&_v`X6vNSm~e0JRh`wVANAjZn3VkhNNiv`!lUUdsqu>j+s3wiclq<#w<;`=Klg zrVgvBLEC@+$9tP_wO^YNb!)erfVYsax6IJDpzybe5V(R%xP?2mm9V#B%eR~`l$4OR zYFnyo8=^l;kpDV_fE%@Us|bT@w3NWP$nd$Ez`3DYx23zdh-Ao4dTpE45^6xXQb^c^e7Ko4wl0yXE`4QLFyA==i2ZnU+ZTy4WbWr^>G|q=;Xr zGs;l5nVY-h%e&VLy}b*z&Fj30tG)W`yZc+X{R_U*>%0ZrzXS}vT}!;otH6JYz}=g` z2pqhUAifcN!1~+07tFcg%D#OGo$p(SEi1bk6(L84h5(Dd3k<@{o4^@7!*&b70=&S( z8^JYv!#wQ3Hyp&@i@ieJ!v>7CQj5b!tiz{8#28G(8XUG{%*Jkf#>uO=bo{-@Yrax!zEiuu z*$c$FE4@`a!coefR(h*htetw{#iUR(^!__5rG~q8+`tq(#Zk<|Kzzq>4988}$y6-I zqO8ZCT*`KQy2k6jb6m=-49eFl#C`j@;i{9x*QJb%u3u_@d9lLz_qHCj3zh80AB?^@ z%*W9i$aGx6{0qVoe9V0O%*Tw(GYrkeyu_oN%+mb9#B9N>yu0W7z)sx8*DS}&yucf( zcb*D*gNn;*yTW|Z%Zd1hVQi3q3&;YT!y4Sd1`N)IOvvcF$wO?tWjo3qoW|t~$5Cv| zg*>*3%gF?-x*H6Yu(K@Z|oXbAD7nkX_PdLf8AdZTpx*o04kqgoZ z*V40VWRblv{yWXnJ?+y!4b(v`)I&|wMQzkPz0y*+ovX0a^9v~7 zsAv>&(lwO7Np00$>ak7zvZ?xpV|CSE4b~R{q75+CPR*_}{SsB_V^|s1ZSB^HFxF+g z)raOJp81)FBAV*-)_cv@rW(IL3!dW1X5{H*G{M)0-PT+D$Xz_wF}oZ}hN30=X6K36 zmA%rAyx5El)2EQxo$cA54cehC+M`X{rES`$joPWL+N;glt?k;c4coCT+p|sEwQbwC zjoZ2H)O&#!z3tn-4cx&k+`~=W#ckZjjoitt+{?|}&F$RJ4c*Z#-P29o)otC^josO; z-O4=xTg}_s4c_4`-s4UF-sNrH=Z)U!t={X+-t7(C-M!hS@DTw?-vC)0^^M>8t>632 z-~H|1^zBvuE#L!A;012r2aezguHXyK;0^BJ4-Vl3jtaU>;T7K6A>rK^Ufkae-|lVR zyxrj*F5)9j;w5h4C(hg7T^uLQ;_t2DEG*wIKHMDM;@b`4HICysuH!q-ZVTW zrcMBM{@ieG3WlBtejx#gj@-!6=NI4#Q~u&bPUxo)0k8l74-f$opy(?u>A~&j$FA(l z&g?cm;UMAay$%wbzUiAT02VL-e?HufaOjA@>dj5-uPy)=kOAfX3bP*V!X4|tE&v38 z>$wi-yWUJj-rI0)=mIbS#J=dw&e;ya@Ba?)0l(a74ian*+?*}}6A%CsaPQha+@{V5 z36KDZ@a@Yz?9p!MoZju|zU`gv7YNYq@9yx%PUQ2h;d;*H0HY^#>=J+g50by?ec@FP`?(Z=V^E0pZYrpJLehTT{=AW+doNo0VkMG1y z>Wu&aD9`tyuI1hC7vT=;egO+958ORZ^@$Ji?w<9Duj^SZ=td3!jUWLJQ1&j*?`hBW zo6q@Z{_JY5B$(dwo1XJKKLMML?b%M;v3~WMzW02e=M&)fzWwV>-}F&$=n|m&x*zVr zjrdm2_yAz_ARq6L594Ov-IFf?6~O$=FYK3Z>;kX(olpJMALKP}>BisNg%9Tp|LG7g z{^z^D`@aqGiqPffkN)Q``?KHM8Sn8>AMOx9?CD?Jh;ItPKm1f*_FHfKyq@Kg4+sGk zgM<$N0*C?)iHHM?kC2g)la!T~mzRr)j+mXEpP-?lqok##r>Lo_tE{4$h_8qcjGU4L z2m%ubv%3=!5)r`!5|k7H8vzu#6U-3K&(6%ulo0|K8Q1{;Y_*3_g+4=Y~GxUpl!RT;tcM`^4C31U4WvMdUkXK0;1J5%+* z!UJy*a9+wQV6RWgos2$Cn0U7B+qiS9$yDt2j>Z9VoT^UZ!yt(t|3VXAI zu2?v{*T|I~r(UWy_wV4ti!V%m`uL{SdlGNJzPL{L!u%q#wg>AG}dS%D=w<12#7rP=;Mz-1}Wr_L>6h}kw_+~Ex48Mw#SJ zFWzY7l~`t}<%+{?>E)MThAHM$U5;tynP{e|rYAfV;O3if#wq8Vbk=F-op|P{=bn7_ z>F1w-1}f;FgcfS(p@=4`=%S1^>gc18`dQATlvZl#rI==_>86}^>glJThAQf)q?T&x Zsi>x^>Z+`^>gubo#wzQqw3-?S06YJ?

Apache Server Frequently Asked Questions

- $Revision: 1.104 $ ($Date: 1998/01/26 16:53:48 $) + $Revision: 1.105 $ ($Date: 1998/02/05 09:58:38 $)

The latest version of this FAQ is always available from the main @@ -142,6 +142,9 @@

Why doesn't my

ErrorDocument
     401

work?

How can I use ErrorDocument + and SSI to simplify customized error messages? +

Why do I get "setgid: Invalid argument" at startup?

@@ -1085,6 +1088,19 @@

+ How can I use ErrorDocument + and SSI to simplify customized error messages? + +

+ Have a look at this document. + It shows in example form how you can a combination of XSSI and + negotiation to tailor a set of ErrorDocuments to your + personal taste, and returning different internationalized error + responses based on the client's native language. +

Why do I get "setgid: Invalid argument" at startup? diff --git a/docs/manual/misc/custom_errordocs.html b/docs/manual/misc/custom_errordocs.html new file mode 100644 index 00000000000..dfc669dd4f1 --- /dev/null +++ b/docs/manual/misc/custom_errordocs.html @@ -0,0 +1,389 @@ + + + +International Customized Server Error Messages + + + + +

+ +

Using XSSI and `ErrorDocument` to configure +customized international server error responses

Index

Introduction +
Creating an ErrorDocument directory +
Naming the individual error document files +
The common header and footer files +
Creating ErrorDocuments in different languages +
The fallback language +
HTML listing of the discussed example +

Introduction

+This document describes an easy way to provide your apache WWW server +with a set of customized error messages which take advantage of +Content Negotiation +and eXtended Server Side Includes (XSSI) +to return error messages generated by the server in the client's +native language. +

+By using XSSI, all customized messages +can share a homogenous and consistent style and layout, and maintenance work +(changing images, changing links) is kept to a minimum because all layout +information can be kept in a single file.
+Error documents can be shared across different servers, or even hosts, +because all varying information is inserted at the time the error document +is returned on behalf of a failed request. +

+Content Negotiation then selects the appropriate language version of a +particular error message text, honoring the language preferences passed +in the client's request. (Users usually select their favorite languages +in the preferences options menu of today's browsers). When an error +document in the client's primary language version is unavailable, the +secondary languages are tried or a default (fallback) version is used. +

+You have full flexibility in designing your error documents to +your personal taste (or your company's conventions). For demonstration +purposes, we present a simple generic error document scheme. +For this hypothetic server, we assume that all error messages... +

possibly are served by different virtual hosts (different host name, + different IP address, or different port) on the server machine, +
show a predefined company logo in the right top of the message + (selectable by virtual host), +
print the error title first, followed by an explanatory text and + (depending on the error context) help on how to resolve the error, +
have some kind of standardized background image, +
display an apache logo and a feedback email address at the bottom + of the error message. +

+ +

+An example of a "document not found" message for a german client might +look like this:
+
+All links in the document as well as links to the server's administrator +mail address, and even the name and port of the serving virtual host +are inserted in the error document at "run-time", i.e., when the error +actually occurs. +

+ +

Creating an ErrorDocument directory

+ +For this concept to work as easily as possible, we must take advantage +of as much server support as we can get: +

By defining the MultiViews option, + we enable the language selection of the most appropriate language + alternative (content negotiation). +
By setting the LanguagePriority + directive we define a set of default fallback languages in the situation + where the client's browser did not express any preference at all. +
By enabling Server Side Includes + (and disallowing execution of cgi scripts for security reasons), + we allow the server to include building blocks of the error message, + and to substitute the value of certain environment variables into the + generated document (dynamic HTML) or even to conditionally include + or omit parts of the text. +
The AddHandler and + AddType directives are useful + for automatically XSSI-expanding all files with a .shtml + suffix to text/html. +
By using the Alias directive, + we keep the error document directory outside of the document tree + because it can be regarded more as a server part than part of + the document tree. +
The <Directory>-Block + restricts these "special" settings to the error document directory + and avoids an impact on any of the settings for the regular document tree. +
For each of the error codes to be handled (see RFC2068 for an exact + description of each error code, or look at src/main/http_protocol.c + if you wish to see apache's standard messages), an + ErrorDocument + in the aliased /errordocs directory is defined. + Note that we only define the basename of the document here + because the MultiViews option will select the best candidate + based on the language suffixes and the client's preferences. + Any error situation with an error code not handled by a + custom document will be dealt with by the server in the standard way + (i.e., a plain error message in english). +
Finally, the AllowOverride + directive tells apache that it is not necessary to look for + a .htaccess file in the /errordocs directory: a minor speed + optimization. +

+The resulting httpd.conf configuration would the look +similar to this: (Note that you can defrine your own error +messages using this method for only part of the document tree, +e.g., a /~user/ subtree. In this case, the configuration could as well +be put into the .htaccess file at the root of the subtree. In this case, +the <Directory> and </Directory> directives -but not +the contained directives- must be omitted.) +

+  LanguagePriority en fr de 
+  Alias  /errordocs  /usr/local/apache/errordocs
+  <Directory /usr/local/apache/errordocs>
+   AllowOverride none
+   Options MultiViews IncludesNoExec FollowSymLinks
+   AddType text/html .shtml
+   AddHandler server-parsed .shtml
+  </Directory>
+  #    "400 Bad Request",
+  ErrorDocument  400  /errordocs/400
+  #    "401 Authorization Required",
+  ErrorDocument  401  /errordocs/401
+  #    "403 Forbidden",
+  ErrorDocument  403  /errordocs/403
+  #    "404 Not Found",
+  ErrorDocument  404  /errordocs/404
+  #    "500 Internal Server Error",
+  ErrorDocument  500  /errordocs/500
+

+The directory for the error messages (here: +/usr/local/apache/errordocs/) must then be created with the +appropriate permissions (readable and executable by the server uid or gid, +only writable for the administrator). + +

Naming the individual error document files

+ +By defining the MultiViews option, the server was told to +automatically scan the directory for matching variants (looking at language +and content type suffixes) when a requested document was not found. +In the configuration, we defined the names for the error documents to be +just their error number (without any suffix). +

+The names of the individual error documents are now determined like this +(I'm using 403 as an example, think of it as a placeholder for any of +the configured error documents): +

No file errordocs/403 should exist. Otherwise, it would be found and + served (with the DefaultType, usually text/plain), all negotiation + would be bypassed. +
For each language for which we have a translation (note that this need not + be the same set of languages for each error code - you can get by + with a single language version until you actually have + translated versions), a document + errordocs/403.shtml.lang is created and + filled with the error text in that language (see + below). +
One fallback document called errordocs/403.shtml is + created, usually by creating a symlink to the default language + variant (see below). +

+ +

The common header and footer files

+ +By putting as much layout information in two special "include files", +the error documents can be reduced to a bare minimum. +

+One of these layout files defines the HTML document header +and a configurable list of paths to the icons to be shown in the resulting +error document. These paths are exported as a set of XSSI environment +variables and are later evaluated by the "footer" special file. +The title of the current error (which is +put into the TITLE tag and an H1 header) is simply passed in from the main +error document in a variable called title.
+By changing this file, the layout of all generated error +messages can be changed in a second. +(By exploiting the features of XSSI, you can easily define different +layouts based on the current virtual host, or even based on the +client's domain name). +

+The second layout file describes the footer to be displayed at the bottom +of every error message. In this example, it shows an apache logo, the current +server time, the server version string and adds a mail reference to the +site's webmaster. +

+For simplicity, the header file is simply called head.shtml +because it contains server-parsed content but no language specific +information. The footer file exists once for each language translation, +plus a symlink for the default language.

+Example: for english, french and german versions (default english)
+foot.shtml.en,
+foot.shtml.fr,
+foot.shtml.de,
+foot.shtml symlink to foot.shtml.en

+Both files are then simply included into the error document by using the +directives  +and  +respectively: the rest of the magic occurs in mod_negotiation and +in mod_include. +

+ +See the listings below to see an actual HTML +implementation of the discussed example. + + +

Creating ErrorDocuments in different languages

+ +After all this preparation work, little remains to be said about the +actual documents. They all share a simple common structure: +

+<!--#set var="title" value="error description title" -->
+<!--#include virtual="head" -->
+   explanatory error text
+<!--#include virtual="foot" -->
+

+In the listings section, you can see an example +of a [400 Bad Request] error document. Documents as simple as that +certainly cause no problems to translate or expand. + +

The fallback language

+ +Do we need a special handling for languages other than those we have +translations for? We did set the LanguagePriority, didn't we?! +

+Well, the LanguagePriority directive is for the case where the client does +not express any language priority at all. But what +happens in the situation where the client wants one +of the languages we do not have, and none of those we do have? +

+Without doing anything, the Apache server will usually return a +[406 no acceptable variant] error, listing the choices from which the client +may select. But we're in an error message already, and important error +information might get lost when the client had to choose a language +representation first. +

+So, in this situation it appears to be easier to define a fallback language +(by copying or linking, e.g., the english version to a language-less version). +Because the negotiation algorithm prefers "more specialized" variants over +"more generic" variants, these generic alternatives will only be chosen +when the normal negotiation did not succeed. +

+A simple shell script to do it (execute within the errordocs/ dir): +

+  for f in *.shtml.en
+  do
+     ln -s $f `basename $f .en`
+  done
+

+ +

HTML listing of the discussed example

+ +So, to summarize our example, here's the complete listing of the +400.shtml.en document. You will notice that it contains +almost nothing but the error text (with conditional additions). +Starting with this example, you will find it easy to add more error +documents, or to translate the error documents to different languages. +

+<!--#set var="title" value="Bad Request"
+--><!--#include virtual="head" --><P>
+   Your browser sent a request that this server could not understand:
+   <BLOCKQUOTE>
+     <STRONG><!--#echo var="REQUEST_URI" --></STRONG>
+   </BLOCKQUOTE>
+   The request could not be understood by the server due to malformed
+   syntax. The client should not repeat the request without
+   modifications.
+   </P>
+   <P>
+   <!--#if expr="\"$HTTP_REFERER\" != \"\"" -->
+    Please inform the owner of
+    <A HREF="<!--#echo var="HTTP_REFERER" -->">the referring page</A> about 
+    the malformed link.
+   <!--#else -->
+    Please check your request for typing errors and retry.
+   <!--#endif -->
+   </P>
+<!--#include virtual="foot" -->
+

+ +Here is the complete head.shtml file (the funny line +breaks avoid empty lines in the document after XSSI processing). Note the +configuration section at top. That's where you configure the images and logos +as well as the apache documentation directory. Look how this file displays +two different logos depending on the content of the virtual host name +($SERVER_NAME), and that an animated apache logo is shown if the browser +appears to support it (the latter requires server configuration lines +of the form
BrowserMatch "^Mozilla/[2-4]" anigif
+for browser types which support animated GIFs). +

+<!--#if expr="\"$SERVER_NAME\" = /.*\.mycompany\.com/" 
+--><!--#set var="IMG_CorpLogo"
+            value="http://$SERVER_NAME:$SERVER_PORT/errordocs/CorpLogo.gif" 
+--><!--#set var="ALT_CorpLogo" value="Powered by Linux!" 
+--><!--#else
+--><!--#set var="IMG_CorpLogo"
+            value="http://$SERVER_NAME:$SERVER_PORT/errordocs/PrivLogo.gif" 
+--><!--#set var="ALT_CorpLogo" value="Powered by Linux!" 
+--><!--#endif
+--><!--#set var="IMG_BgImage" value="http://$SERVER_NAME:$SERVER_PORT/errordocs/BgImage.gif" 
+--><!--#set var="DOC_Apache" value="http://$SERVER_NAME:$SERVER_PORT/Apache/" 
+--><!--#if expr="$anigif" 
+--><!--#set var="IMG_Apache" value="http://$SERVER_NAME:$SERVER_PORT/icons/apache_anim.gif" 
+--><!--#else
+--><!--#set var="IMG_Apache" value="http://$SERVER_NAME:$SERVER_PORT/icons/apache_pb.gif" 
+--><!--#endif
+--><!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+<HTML>
+ <HEAD>
+  <TITLE>
+   [<!--#echo var="REDIRECT_STATUS" -->] <!--#echo var="title" -->
+  </TITLE>
+ </HEAD>
+ <BODY BGCOLOR="white" BACKGROUND="<!--#echo var="IMG_BgImage" -->"><UL>
+  <H1 ALIGN="center">
+   [<!--#echo var="REDIRECT_STATUS" -->] <!--#echo var="title" -->
+   <IMG SRC="<!--#echo var="IMG_CorpLogo" -->"
+        ALT="<!--#echo var="ALT_CorpLogo" -->" ALIGN=right>
+  </H1>
+  <HR><!-- ======================================================== -->
+  <DIV>
+

+ and this is the foot.shtml.en file: +

+
+  </DIV>
+  <HR>
+  <DIV ALIGN="right"><SMALL><SUP>Local Server time:
+      <!--#echo var="DATE_LOCAL" -->
+  </SUP></SMALL></DIV>
+  <DIV ALIGN="center">
+    <A HREF="<!--#echo var="DOC_Apache" -->">
+    <IMG SRC="<!--#echo var="IMG_Apache" -->" BORDER=0 ALIGN="bottom"
+         ALT="Powered by <!--#echo var="SERVER_SOFTWARE" -->"></A><BR>
+    <SMALL><SUP><!--#set var="var"
+     value="Powered by $SERVER_SOFTWARE -- File last modified on $LAST_MODIFIED"
+    --><!--#echo var="var" --></SUP></SMALL>
+  </DIV>
+  <ADDRESS>If the indicated error looks like a misconfiguration, please inform
+   <A HREF="mailto:<!--#echo var="SERVER_ADMIN" -->"
+      SUBJECT="Feedback about Error message [<!--#echo var="REDIRECT_STATUS" 
+        -->] <!--#echo var="title" -->, req=<!--#echo var="REQUEST_URI" -->">
+   <!--#echo var="SERVER_NAME" -->'s WebMaster</A>.
+  </ADDRESS>
+ </UL></BODY>
+</HTML>
+

+ + +

More welcome!

+ +If you have tips to contribute, send mail to Martin.Kraemer@Mch.SNI.De + +

+ +

+ + + diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index 1ab38248ddf..a6c8252430c 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -407,6 +407,14 @@ the request.

Using Server Side Includes for ErrorDocuments

+ +There is a document which +describes how to use the features of mod_include to offer internationalized +customized server error documents. +

+ -- 2.47.2