]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: Add introduction to http-request normalize-uri
authorTim Duesterhus <tim@bastelstu.be>
Fri, 16 Apr 2021 21:52:29 +0000 (23:52 +0200)
committerChristopher Faulet <cfaulet@haproxy.com>
Mon, 19 Apr 2021 07:05:57 +0000 (09:05 +0200)
This patch adds an introduction to the http-request normalize-uri section,
explaining what to expect from the normalizers and possible issues that might
arise when not being careful.

doc/configuration.txt

index dae584307bb83ae888a11c7e6562dec8c783fee5..520db412679e38aa91e043d22a556d82132b21e1 100644 (file)
@@ -6017,8 +6017,18 @@ http-request normalize-uri path-strip-dotdot [ full ] [ { if | unless } <conditi
 http-request normalize-uri percent-to-uppercase [ strict ] [ { if | unless } <condition> ]
 http-request normalize-uri query-sort-by-name [ { if | unless } <condition> ]
 
-  Performs normalization of the request's URI. The following normalizers are
-  available:
+  Performs normalization of the request's URI.
+
+  Each normalizer handles a single type of normalization to allow for a
+  fine-grained selection of the level of normalization that is appropriate for
+  the supported backend.
+
+  As an example the "path-strip-dotdot" normalizer might be useful for a static
+  fileserver that directly maps the requested URI to the path within the local
+  filesystem. However it might break routing of an API that expects a specific
+  number of segments in the path.
+
+  The following normalizers are available:
 
   - path-strip-dotdot: Normalizes "/../" segments within the "path" component.
       This merges segments that attempt to access the parent directory with