document the querystringSearchGet setting (#5206)

Co-authored-by: Steve Piercy <web@stevepiercy.com>
plone · Sep 26, 2023 · 510d74d · 510d74d
1 parent 6582921
commit 510d74d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/source/configuration/settings-reference.md b/docs/source/configuration/settings-reference.md
@@ -441,6 +441,17 @@ siteTitleFormat
         }
     ```
 
+querystringSearchGet
+    Volto uses `HTTP POST` requests to query the `@querystring-search` endpoint.
+    This can create a lot of traffic between Volto and the backend, and can also create a lot of cache misses.
+
+    By modifying this configuration setting and setting it to `true`, the endpoint queries will be executed as `HTTP GET` requests.
+    Thus any proxy cache in between Volto and the backend may cache those queries, improving your site performance.
+
+    Please be aware that this could break some other functionality in your site, or some of your queries may break, when they contain more than 2000 characters.
+    [See an explanation of character limits in URLs](https://stackoverflow.com/questions/417142/what-is-the-maximum-length-of-a-url-in-different-browsers/417184#417184).
+    Please test this setting properly before enabling in a production site.
+
 ```
 
 ## Views settings

diff --git a/news/5206.documentation b/news/5206.documentation
@@ -0,0 +1 @@
+Document the `querystringSearchGet` setting @erral