diff options
| author | Noémi Ványi <sitbackandwait@gmail.com> | 2020-03-29 13:14:06 +0200 |
|---|---|---|
| committer | Noémi Ványi <sitbackandwait@gmail.com> | 2020-05-31 19:17:48 +0200 |
| commit | e3282748d0433d455336487f7e36b789fe6ade30 (patch) | |
| tree | 521fbd7806bf636bdf09c5e2f9be4d4fa2493e8d /docs | |
| parent | d38952c1335d3c6f8615870b11ef9737b203ad49 (diff) | |
| download | searxng-e3282748d0433d455336487f7e36b789fe6ade30.tar.gz searxng-e3282748d0433d455336487f7e36b789fe6ade30.zip | |
add display_error_messages option to engine settings
A new option is added to engines to hide error messages from users. It
is called `display_error_messages` and by default it is set to `True`.
If it is set to `False` error messages do not show up on the UI.
Keep in mind that engines are still suspended if needed regardless of
this setting.
Closes #1828
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/engines.rst | 4 | ||||
| -rw-r--r-- | docs/admin/settings.rst | 3 | ||||
| -rw-r--r-- | docs/dev/engine_overview.rst | 1 |
3 files changed, 8 insertions, 0 deletions
diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst index 4b78c8c2b..4d1872dfc 100644 --- a/docs/admin/engines.rst +++ b/docs/admin/engines.rst @@ -26,6 +26,8 @@ Safe search **SS** Weigth **W** ------------- ----------- --------------------------------- Disabled **D** +------------- ----------- --------------------------------- +Show errors **DE** ============= =========== ================================= Configuration defaults (at built time): @@ -51,6 +53,7 @@ Configuration defaults (at built time): - O - W - D + - DE {% for name, mod in engines.items() %} @@ -67,5 +70,6 @@ Configuration defaults (at built time): - {{(mod.offline and "y") or ""}} - {{mod.weight or 1 }} - {{(mod.disabled and "y") or ""}} + - {{(mod.display_error_messages and "y") or ""}} {% endfor %} diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index 2c42a21e9..2bfbae35c 100644 --- a/docs/admin/settings.rst +++ b/docs/admin/settings.rst @@ -175,6 +175,9 @@ Engine settings ``weigth`` : default ``1`` Weighting of the results of this engine. +``display_error_messages`` : default ``True`` + When an engine returns an error, the message is displayed on the user interface. + .. note:: A few more options are possible, but they are pretty specific to some diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst index 449c837a9..c3c81fff8 100644 --- a/docs/dev/engine_overview.rst +++ b/docs/dev/engine_overview.rst @@ -57,6 +57,7 @@ engine string name of searx-engine (filename without ``.py``) shortcut string shortcut of search-engine timeout string specific timeout for search-engine +display_error_messages boolean display error messages on the web UI ======================= =========== =========================================== |