From: Yann Ylavic <ylavic@apache.org>
Date: Mon, 13 Dec 2021 15:07:45 +0000 (+0000)
Subject: Improve docs for ProxyPass mapping= parameter. [skip ci]
X-Git-Tag: 2.5.0-alpha2-ci-test-only~651
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=00818b79791fd7dbbbc49f6ddbb73b07a7e85597;p=thirdparty%2Fapache%2Fhttpd.git

Improve docs for ProxyPass mapping= parameter. [skip ci]

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1895895 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_proxy.xml b/docs/manual/mod/mod_proxy.xml
index 8b77ad8310a..2d720cc012b 100644
--- a/docs/manual/mod/mod_proxy.xml
+++ b/docs/manual/mod/mod_proxy.xml
@@ -1285,9 +1285,20 @@ ProxyPass "/example" "http://backend.example.com" max=20 ttl=120 retry=300
     </td></tr>
     <tr><td>mapping</td>
         <td>-</td>
-        <td><p>Mapping to process the <var>url</var> before choosing a Worker/Balancer.
-        'servlet' maps like a servlet container (like jk_servlet_normalize), use with Apache Tomcat for example.
-        'encoded' maps it encoded.</p>
+        <td><p>Type of mapping between the <var>path</var> and the <var>url</var>.
+        This determines the normalization and/or (non-)decoding that <module>mod_proxy</module> will
+        apply to the request's <var>uri-path</var> to match the <var>path</var>. If/when the mapping
+        matches, the request <var>uri-path</var> is committed such that <code>&lt;Location</code>
+        and other directory contexts using a path will match according to the same mapping.</p>
+        <p>The <code>encoded</code> mapping avoids the %-decoding of the <var>uri-path</var> such that
+        one can match for instance <code>/some%2furi%2fpath%2fwith%2fslash</code> in a <code>ProxyPass</code>
+        or <code>&lt;Location</code> context.</p>
+        <p>The <code>servlet</code> mapping refers to the one defined by the Servlet specification, which
+        is for instance applied by Apache Tomcat for servlet containers (notably the path parameters are
+        ignored for the mapping). An <var>uri-path</var> like <code>/some;foo/path</code> is then mapped
+        as <code>/some/path</code> and thus matches <code>&lt;Location /some/path&gt;</code> or
+        <code>ProxyPass "/some/path" "https://tomcat.example.com"</code> regardless of the requested
+        path parameters.</p>
     </td></tr>
 
     </table>