Skip to content

Commit

Permalink
document the querystringSearchGet setting (#5206)
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <[email protected]>
  • Loading branch information
erral and stevepiercy authored Sep 26, 2023
1 parent 6582921 commit 510d74d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/source/configuration/settings-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions news/5206.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document the `querystringSearchGet` setting @erral

0 comments on commit 510d74d

Please sign in to comment.