diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2025-02-23 15:00:38 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2025-02-26 07:15:39 +0100 |
| commit | 2e0abc931057a8e0189b53f6501769fe26fd0bbc (patch) | |
| tree | a6c68bd8322385dbbd864949429c028ed09b8551 /docs/admin | |
| parent | 28d1240fce945a48a2c61c29fff83336410c4c77 (diff) | |
[fix] various issues in the documentation
Closes: https://github.com/searxng/searxng/issues/4370
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/settings/index.rst | 2 | ||||
| -rw-r--r-- | docs/admin/settings/settings_engines.rst (renamed from docs/admin/settings/settings_engine.rst) | 26 | ||||
| -rw-r--r-- | docs/admin/settings/settings_outgoing.rst | 4 |
3 files changed, 24 insertions, 8 deletions
diff --git a/docs/admin/settings/index.rst b/docs/admin/settings/index.rst index d1f808f3d..eb0e07a53 100644 --- a/docs/admin/settings/index.rst +++ b/docs/admin/settings/index.rst @@ -13,7 +13,7 @@ Settings :maxdepth: 2 settings - settings_engine + settings_engines settings_brand settings_general settings_search diff --git a/docs/admin/settings/settings_engine.rst b/docs/admin/settings/settings_engines.rst index 454fcd241..944972143 100644 --- a/docs/admin/settings/settings_engine.rst +++ b/docs/admin/settings/settings_engines.rst @@ -1,14 +1,30 @@ -.. _settings engine: +.. _settings engines: -=========== -``engine:`` -=========== +============ +``engines:`` +============ .. sidebar:: Further reading .. - :ref:`configured engines` - :ref:`engines-dev` + +In the section ``engines:`` is a list of the engines that are to be made +available in the instance. Each list entry is in turn a key/value mapping. + +.. code:: yaml + + engines: + + - name: dummy.online + engine: dummy + .. + - name: dummy.offline + engine: dummy-offline + .. + .. + In the code example below a *full fledged* example of a YAML setup from a dummy engine is shown. Most of the options have a default value or even are optional. @@ -19,7 +35,7 @@ engine is shown. Most of the options have a default value or even are optional. .. code:: yaml - - name: example engine + - name: example engine: example shortcut: demo base_url: 'https://{language}.example.com/' diff --git a/docs/admin/settings/settings_outgoing.rst b/docs/admin/settings/settings_outgoing.rst index 7d49ab789..1896698ce 100644 --- a/docs/admin/settings/settings_outgoing.rst +++ b/docs/admin/settings/settings_outgoing.rst @@ -43,7 +43,7 @@ Communication with search engines. Global timeout of the requests made to others engines in seconds. A bigger timeout will allow to wait for answers from slow engines, but in consequence will slow SearXNG reactivity (the result page may take the time specified in the - timeout to load). Can be override by ``timeout`` in the :ref:`settings engine`. + timeout to load). Can be override by ``timeout`` in the :ref:`settings engines`. ``useragent_suffix`` : Suffix to the user-agent SearXNG uses to send requests to others engines. If an @@ -105,6 +105,6 @@ Communication with search engines. ``using_tor_proxy`` : Using tor proxy (``true``) or not (``false``) for all engines. The default is - ``false`` and can be overwritten in the :ref:`settings engine` + ``false`` and can be overwritten in the :ref:`settings engines` |