diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2024-06-28 14:47:22 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2025-08-26 08:20:56 +0200 |
| commit | 92463ce6a7aacd366292a383373bebc32988b9c3 (patch) | |
| tree | a6f2cebaacfb1dc1ec611732e9f00dd6c8070309 /docs/admin/settings | |
| parent | a369fe8f2915adc58ffcd611abe2e9af7d58411a (diff) | |
[doc] adds the missing documentation of the `server.method` settings.
TL;DR; For all the issues that comes with HTTP POST I recommend instance
maintainers to switch to GET and lock the property in the preferences:
```yaml
server:
method: GET
preferences:
lock:
- method
```
We don't want this in the defaults of the SearXNG distributions for the pros vs
cons listed in this discussion:
- https://github.com/searxng/searxng/pull/3619
Diffstat (limited to 'docs/admin/settings')
| -rw-r--r-- | docs/admin/settings/settings_server.rst | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/admin/settings/settings_server.rst b/docs/admin/settings/settings_server.rst index 59c0d7791..acf271560 100644 --- a/docs/admin/settings/settings_server.rst +++ b/docs/admin/settings/settings_server.rst @@ -55,11 +55,21 @@ .. _method: -``method`` : ``$SEARXNG_METHOD`` - Whether to use ``GET`` or ``POST`` HTTP method when searching. +``method`` : ``GET`` | ``POST`` + HTTP method. By defaults ``POST`` is used / The ``POST`` method has the + advantage with some WEB browsers that the history is not easy to read, but + there are also various disadvantages that sometimes **severely restrict the + ease of use for the end user** (e.g. back button to jump back to the previous + search page and drag & drop of search term to new tabs do not work as + expected .. and several more). We had a lot of long discussions about the + *pros v2 cons*: + + - `set HTTP GET method by default + <https://github.com/searxng/searxng/pull/3619>`__ + - `http methods GET & POST + <https://github.com/search?q=repo%3Asearxng%2Fsearxng+label%3A%22http+methods+GET+%26+POST%22>`__ .. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers ``default_http_headers`` : Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__ - |