]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_html.html.en
Rebuild
[apache] / docs / manual / mod / mod_proxy_html.html.en
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5               This file is generated from xml source: DO NOT EDIT
6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7       -->
8 <title>mod_proxy_html - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
13 <body>
14 <div id="page-header">
15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
16 <p class="apache">Apache HTTP Server Version 2.5</p>
17 <img alt="" src="../images/feather.gif" /></div>
18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
19 <div id="path">
20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
21 <div id="page-content">
22 <div id="preamble"><h1>Apache Module mod_proxy_html</h1>
23 <div class="toplang">
24 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_html.html" title="English">&nbsp;en&nbsp;</a></p>
25 </div>
26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Rewrite HTML links in to ensure they are addressable
27 from Clients' networks in a proxy context.</td></tr>
28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_html_module</td></tr>
30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_html.c</td></tr>
31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later.  Available as a third-party module
32 for earlier 2.x versions</td></tr></table>
33 <h3>Summary</h3>
34
35     <p>This module provides an output filter to rewrite HTML links in a proxy situation, to ensure that links work for users outside the proxy. It serves the same purpose as Apache's ProxyPassReverse directive does for HTTP headers, and is an essential component of a reverse proxy.</p>
36
37 <p>For example, if a company has an application server at appserver.example.com that is only visible from within the company's internal network, and a public webserver <code>www.example.com</code>, they may wish to provide a gateway to the application server at <code>http://www.example.com/appserver/</code>. When the application server links to itself, those links need to be rewritten to work through the gateway. mod_proxy_html serves to rewrite <code>&lt;a href="http://appserver.example.com/foo/bar.html"&gt;foobar&lt;/a&gt;</code> to <code>&lt;a href="http://www.example.com/appserver/foo/bar.html"&gt;foobar&lt;/a&gt;</code> making it accessible from outside.</p>
38
39 <p>mod_proxy_html was originally developed at WebÞing, whose
40 extensive <a href="http://apache.webthing.com/mod_proxy_html/">documentation</a> may be useful to users.</p>
41 </div>
42 <div id="quickview"><h3 class="directives">Directives</h3>
43 <ul id="toc">
44 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlbufsize">ProxyHTMLBufSize</a></li>
45 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlcharsetout">ProxyHTMLCharsetOut</a></li>
46 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmldoctype">ProxyHTMLDocType</a></li>
47 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlenable">ProxyHTMLEnable</a></li>
48 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlevents">ProxyHTMLEvents</a></li>
49 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlextended">ProxyHTMLExtended</a></li>
50 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlfixups">ProxyHTMLFixups</a></li>
51 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlinterp">ProxyHTMLInterp</a></li>
52 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmllinks">ProxyHTMLLinks</a></li>
53 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlstripcomments">ProxyHTMLStripComments</a></li>
54 <li><img alt="" src="../images/down.gif" /> <a href="#proxyhtmlurlmap">ProxyHTMLURLMap</a></li>
55 </ul>
56 </div>
57
58 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
59 <div class="directive-section"><h2><a name="ProxyHTMLBufSize" id="ProxyHTMLBufSize">ProxyHTMLBufSize</a> <a name="proxyhtmlbufsize" id="proxyhtmlbufsize">Directive</a></h2>
60 <table class="directive">
61 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the buffer size increment for buffering inline scripts and
62 stylesheets.</td></tr>
63 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLBufSize <var>bytes</var></code></td></tr>
64 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
65 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
66 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
67 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
68 for earlier 2.x versions</td></tr>
69 </table>
70 <p>In order to parse non-HTML content (stylesheets and scripts), mod_proxy_html
71 has to read the entire script or stylesheet into a buffer.  This buffer will
72 be expanded as necessary to hold the largest script or stylesheet in a page,
73 in increments of [nnnn] as set by this directive.</p>
74 <p>The default is 8192, and will work well for almost all pages.  However,
75 if you know you're proxying a lot of pages containing stylesheets and/or
76 scripts bigger than 8K (that is, for a single script or stylesheet,
77 NOT in total), it will be more efficient to set a larger buffer
78 size and avoid the need to resize the buffer dynamically during a request.
79 </p>
80
81 </div>
82 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
83 <div class="directive-section"><h2><a name="ProxyHTMLCharsetOut" id="ProxyHTMLCharsetOut">ProxyHTMLCharsetOut</a> <a name="proxyhtmlcharsetout" id="proxyhtmlcharsetout">Directive</a></h2>
84 <table class="directive">
85 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify a charset for mod_proxy_html output.</td></tr>
86 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLCharsetOut <var>Charset | *</var></code></td></tr>
87 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
88 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
89 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
90 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
91 for earlier 2.x versions</td></tr>
92 </table>
93 <p>This selects an encoding for mod_proxy_html output.  It should not
94 normally be used, as any change from the default <code>UTF-8</code>
95 (Unicode - as used internally by libxml2) will impose an additional
96 processing overhead.  The special token <code>ProxyHTMLCharsetOut *</code>
97 will generate output using the same encoding as the input.</p>
98 <p>Note that this relies on <code class="module"><a href="../mod/mod_xml2enc.html">mod_xml2enc</a></code> being loaded.</p>
99
100 </div>
101 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
102 <div class="directive-section"><h2><a name="ProxyHTMLDocType" id="ProxyHTMLDocType">ProxyHTMLDocType</a> <a name="proxyhtmldoctype" id="proxyhtmldoctype">Directive</a></h2>
103 <table class="directive">
104 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets an HTML or XHTML document type declaration.</td></tr>
105 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLDocType <var>HTML|XHTML [Legacy]</var><br /><strong>OR</strong>
106 <br />ProxyHTMLDocType <var>fpi [SGML|XML]</var></code></td></tr>
107 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
108 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
109 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
110 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
111 for earlier 2.x versions</td></tr>
112 </table>
113 <p>In the first form, documents will be declared as HTML 4.01 or XHTML 1.0
114 according to the option selected.  This option also determines whether
115 HTML or XHTML syntax is used for output.   Note that the format of the
116 documents coming from the backend server is immaterial: the parser will
117 deal with it automatically.  If the optional second argument is set to
118 "Legacy", documents will be declared "Transitional", an option that may
119 be necessary if you are proxying pre-1998 content or working with defective
120 authoring/publishing tools.</p>
121 <p>In the second form, it will insert your own FPI.  The optional second
122 argument determines whether SGML/HTML or XML/XHTML syntax will be used.</p>
123 <p>The default is changed to omitting any FPI,
124 on the grounds that no FPI is better than a bogus one.  If your backend
125 generates decent HTML or XHTML, set it accordingly.</p>
126 <p>If the first form is used, mod_proxy_html
127 will also clean up the HTML to the specified standard.  It cannot
128 fix every error, but it will strip out bogus elements and attributes.
129 It will also optionally log other errors at <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> Debug.</p>
130
131 </div>
132 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
133 <div class="directive-section"><h2><a name="ProxyHTMLEnable" id="ProxyHTMLEnable">ProxyHTMLEnable</a> <a name="proxyhtmlenable" id="proxyhtmlenable">Directive</a></h2>
134 <table class="directive">
135 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Turns the proxy_html filter on or off.</td></tr>
136 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLEnable <var>On|Off</var></code></td></tr>
137 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
138 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
139 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
140 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
141 module for earlier 2.x versions.</td></tr>
142 </table>
143     <p>A simple switch to enable or disable the proxy_html filter.
144     If <code class="module"><a href="../mod/mod_xml2enc.html">mod_xml2enc</a></code> is loaded it will also automatically
145     set up internationalisation support.</p>
146     <p>Note that the proxy_html filter will only act on HTML data
147     (Content-Type text/html or application/xhtml+xml) and when the
148     data are proxied.  You can override this (at your own risk) by
149     setting the <var>PROXY_HTML_FORCE</var> environment variable.</p>
150
151 </div>
152 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
153 <div class="directive-section"><h2><a name="ProxyHTMLEvents" id="ProxyHTMLEvents">ProxyHTMLEvents</a> <a name="proxyhtmlevents" id="proxyhtmlevents">Directive</a></h2>
154 <table class="directive">
155 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify attributes to treat as scripting events.</td></tr>
156 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLEvents <var>attribute [attribute ...]</var></code></td></tr>
157 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
158 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
159 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
160 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
161 for earlier 2.x versions</td></tr>
162 </table>
163 <p>Specifies one or more attributes to treat as scripting events and
164 apply <code class="directive">ProxyHTMLURLMap</code>s to where appropriate.
165 You can specify any number of attributes in one or more
166 <code>ProxyHTMLEvents</code> directives.</p>
167 <p>The default configuration defines the events in standard HTML 4
168 and XHTML 1.</p>
169
170 </div>
171 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
172 <div class="directive-section"><h2><a name="ProxyHTMLExtended" id="ProxyHTMLExtended">ProxyHTMLExtended</a> <a name="proxyhtmlextended" id="proxyhtmlextended">Directive</a></h2>
173 <table class="directive">
174 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether to fix links in inline scripts, stylesheets,
175 and scripting events.</td></tr>
176 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLExtended <var>On|Off</var></code></td></tr>
177 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
178 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
179 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
180 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
181 for earlier 2.x versions</td></tr>
182 </table>
183 <p>Set to <code>Off</code>, HTML links are rewritten according
184 <code class="directive">ProxyHTMLURLMap</code> directives, but links appearing
185 in Javascript and CSS are ignored.</p>
186 <p>Set to <code>On</code>, all scripting events and embedded scripts or
187 stylesheets are also processed by the <code class="directive">ProxyHTMLURLMap</code>
188 rules, according to the flags set for each rule.  Since this requires more
189 parsing, performance will be best if you only enable it when strictly necessary.</p>
190
191 </div>
192 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
193 <div class="directive-section"><h2><a name="ProxyHTMLFixups" id="ProxyHTMLFixups">ProxyHTMLFixups</a> <a name="proxyhtmlfixups" id="proxyhtmlfixups">Directive</a></h2>
194 <table class="directive">
195 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fixes for simple HTML errors.</td></tr>
196 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLFixups <var>[lowercase] [dospath] [reset]</var></code></td></tr>
197 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
198 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
199 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
200 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
201 for earlier 2.x versions</td></tr>
202 </table>
203 <p>This directive takes one to three arguments as follows:</p>
204 <ul>
205 <li><code>lowercase</code> Urls are rewritten to lowercase</li>
206 <li><code>dospath</code> Backslashes in URLs are rewritten to forward slashes.</li>
207 <li><code>reset</code> Unset any options set at a higher level in the configuration.</li>
208 </ul>
209 <p>Take care when using these.  The fixes will correct certain authoring
210 mistakes, but risk also erroneously fixing links that were correct to start with.
211 Only use them if you know you have a broken backend server.</p> 
212
213 </div>
214 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
215 <div class="directive-section"><h2><a name="ProxyHTMLInterp" id="ProxyHTMLInterp">ProxyHTMLInterp</a> <a name="proxyhtmlinterp" id="proxyhtmlinterp">Directive</a></h2>
216 <table class="directive">
217 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables per-request interpolation of
218 <code class="directive">ProxyHTMLURLMap</code> rules.</td></tr>
219 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLInterp <var>On|Off</var></code></td></tr>
220 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
221 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
222 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
223 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
224 for earlier 2.x versions</td></tr>
225 </table>
226     <p>This enables per-request interpolation in
227     <code class="directive">ProxyHTMLURLMap</code> to- and from- patterns.</p>
228     <p>If interpolation is not enabled, all rules are pre-compiled at startup.
229     With interpolation, they must be re-compiled for every request, which
230     implies an extra processing overhead.  It should therefore be
231     enabled only when necessary.</p>
232
233 </div>
234 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
235 <div class="directive-section"><h2><a name="ProxyHTMLLinks" id="ProxyHTMLLinks">ProxyHTMLLinks</a> <a name="proxyhtmllinks" id="proxyhtmllinks">Directive</a></h2>
236 <table class="directive">
237 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify HTML elements that have URL attributes to be rewritten.</td></tr>
238 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLLinks <var>element attribute [attribute2 ...]</var></code></td></tr>
239 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
240 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
241 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
242 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
243 for earlier 2.x versions</td></tr>
244 </table>
245 <p>Specifies elements that have URL attributes that should be rewritten
246 using standard <code class="directive">ProxyHTMLURLMap</code>s.  You will need one
247 ProxyHTMLLinks directive per element, but it can have any number of attributes.</p>
248 <p>The default configuration defines the HTML links for standard HTML 4
249 and XHTML 1.</p>
250
251 </div>
252 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
253 <div class="directive-section"><h2><a name="ProxyHTMLStripComments" id="ProxyHTMLStripComments">ProxyHTMLStripComments</a> <a name="proxyhtmlstripcomments" id="proxyhtmlstripcomments">Directive</a></h2>
254 <table class="directive">
255 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether to strip HTML comments.</td></tr>
256 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLStripComments <var>On|Off</var></code></td></tr>
257 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
258 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
259 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
260 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
261 for earlier 2.x versions</td></tr>
262 </table>
263 <p>This directive will cause mod_proxy_html to strip HTML comments.
264 Note that this will also kill off any scripts or styles embedded in
265 comments (a bogosity introduced in 1995/6 with Netscape 2 for the
266 benefit of then-older browsers, but still in use today).
267 It may also interfere with comment-based processors such as SSI or ESI:
268 be sure to run any of those <em>before</em> mod_proxy_html in the
269 filter chain if stripping comments!</p>
270
271 </div>
272 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
273 <div class="directive-section"><h2><a name="ProxyHTMLURLMap" id="ProxyHTMLURLMap">ProxyHTMLURLMap</a> <a name="proxyhtmlurlmap" id="proxyhtmlurlmap">Directive</a></h2>
274 <table class="directive">
275 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a rule to rewrite HTML links</td></tr>
276 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyHTMLURLMap <var>from-pattern to-pattern [flags] [cond]</var></code></td></tr>
277 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
278 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
279 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_html</td></tr>
280 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later; available as a third-party
281 module for earlier 2.x versions.</td></tr>
282 </table>
283 <p>This is the key directive for rewriting HTML links.  When parsing a document,
284 whenever a link target matches <var>from-pattern</var>, the matching
285 portion will be rewritten to <var>to-pattern</var>, as modified by any
286 flags supplied.</p>
287
288 <p>The optional third argument may define any of the following
289 <strong>Flags</strong>.  Flags are case-sensitive.</p>
290 <dl>
291 <dt>h</dt>
292 <dd><p>Ignore HTML links (pass through unchanged)</p></dd>
293 <dt>e</dt>
294 <dd><p>Ignore scripting events (pass through unchanged)</p></dd>
295 <dt>c</dt>
296 <dd><p>Pass embedded script and style sections through untouched.</p></dd>
297
298 <dt>L</dt>
299 <dd><p>Last-match.  If this rule matches, no more rules are applied
300 (note that this happens automatically for HTML links).</p></dd>
301 <dt>l</dt>
302 <dd><p>Opposite to L.  Overrides the one-change-only default
303 behaviour with HTML links.</p></dd>
304 <dt>R</dt>
305 <dd><p>Use Regular Expression matching-and-replace.  <code>from-pattern</code>
306 is a regexp, and <code>to-pattern</code> a replacement string that may be
307 based on the regexp.  Regexp memory is supported: you can use brackets ()
308 in the <code>from-pattern</code> and retrieve the matches with $1 to $9
309 in the <code>to-pattern</code>.</p>
310
311 <p>If R is not set, it will use string-literal search-and-replace.
312 The logic is <em>starts-with</em> in HTML links, but
313 <em>contains</em> in scripting events and embedded script and style sections.
314 </p>
315 </dd>
316 <dt>x</dt>
317 <dd><p>Use POSIX extended Regular Expressions.  Only applicable with R.</p></dd>
318 <dt>i</dt>
319 <dd><p>Case-insensitive matching.  Only applicable with R.</p></dd>
320
321 <dt>n</dt>
322 <dd><p>Disable regexp memory (for speed).  Only applicable with R.</p></dd>
323 <dt>s</dt>
324 <dd><p>Line-based regexp matching.  Only applicable with R.</p></dd>
325 <dt>^</dt>
326 <dd><p>Match at start only.  This applies only to string matching
327 (not regexps) and is irrelevant to HTML links.</p></dd>
328 <dt>$</dt>
329 <dd><p>Match at end only.  This applies only to string matching
330 (not regexps) and is irrelevant to HTML links.</p></dd>
331 <dt>V</dt>
332 <dd><p>Interpolate environment variables in <code>to-pattern</code>.
333 A string of the form <code>${varname|default}</code> will be replaced by the
334 value of environment variable <code>varname</code>.  If that is unset, it
335 is replaced by <code>default</code>.  The <code>|default</code> is optional.</p>
336 <p>NOTE: interpolation will only be enabled if
337 <code class="directive">ProxyHTMLInterp</code> is <var>On</var>.</p>
338 </dd>
339
340 <dt>v</dt>
341 <dd><p>Interpolate environment variables in <code>from-pattern</code>.
342 Patterns supported are as above.</p>
343 <p>NOTE: interpolation will only be enabled if
344 <code class="directive">ProxyHTMLInterp</code> is <var>On</var>.</p>
345 </dd>
346 </dl>
347
348 <p>The optional fourth <strong>cond</strong> argument defines a condition
349 that will be evaluated per Request, provided
350 <code class="directive">ProxyHTMLInterp</code> is <var>On</var>.
351 If the condition evaluates FALSE the map will not be applied in this request.
352 If TRUE, or if no condition is defined, the map is applied.</p>
353 <p>A <strong>cond</strong> is evaluated by the <a href="../expr.html">Expression Parser</a>.  In addition, the simpler syntax of conditions
354 in mod_proxy_html 3.x for HTTPD 2.0 and 2.2 is also supported.</p>
355
356 </div>
357 </div>
358 <div class="bottomlang">
359 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_html.html" title="English">&nbsp;en&nbsp;</a></p>
360 </div><div id="footer">
361 <p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
362 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
363 </body></html>