From: Tim Duesterhus <tim@bastelstu.be>
Date: Fri, 16 Apr 2021 21:52:29 +0000 (+0200)
Subject: DOC: Add introduction to http-request normalize-uri
X-Git-Tag: v2.4-dev17~86
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b918a4a564d8d5d50e5f5779228229955857eab0;p=thirdparty%2Fhaproxy.git

DOC: Add introduction to http-request normalize-uri

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.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index dae584307b..520db41267 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -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