searxng/docs/admin/engines
Markus Heiser 5fca26f0b3 [mod] engines_languages.json: add new type engine_properties
This patch adds the boilerplate code, needed to fetch properties from engines.
In the past we only fetched *languages* but some engines need *regions* to
parameterize the engine request.

To fit into our *fetch language* procedures the boilerplate is implemented in
the `searxng_extra/update/update_languages.py` and the *engine_properties* are
stored along in the `searx/data/engines_languages.json`.

This implementation is downward compatible to the `_fetch_fetch_languages()`
infrastructure we have.  If there comes the day we have all
`_fetch_fetch_languages()` implementations moved to `_fetch_engine_properties()`
implementations, we can rename the files and scripts.

The new type `engine_properties` is a dictionary with keys `languages` and
`regions`.  The values are dictionaries to map from SearXNG's language & region
to option values the engine does use::

    engine_properties = {
        'type' : 'engine_properties',  # <-- !!!
        'regions': {
            # 'ca-ES' : <engine's region name>
        },
        'languages': {
            # 'ca' : <engine's language name>
        },
    }

Similar to the `supported_languages`, in the engine the properties are available
under the name `supported_properties`.

Initial we start with languages & regions, but in a wider sense the type is
named *engine properties*.  Engines can store in whatever options they need and
may be in the future there is a need to fetch additional or complete different
properties.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-04-19 14:35:02 +02:00
..
command-line-engines.rst [docs] revision of the section 'Command Line Engines' 2021-06-04 15:05:58 +02:00
configured_engines.rst [mod] engines_languages.json: add new type engine_properties 2022-04-19 14:35:02 +02:00
index.rst [docs] document NoSLQ engines MongoDB and redis 2021-07-25 11:39:11 +02:00
nosql-engines.rst [brand] docs - normalize project name to SearXNG 2021-09-13 14:36:24 +02:00
private-engines.rst [docs] move blog article "private engines" to admin/engines/ 2021-06-04 15:05:58 +02:00
recoll.rst [docs] rename 'Recoll' to 'Recoll Engine' 2021-06-04 15:05:58 +02:00
search-indexer-engines.rst [docs] revision of the blog article about local search engines 2021-06-04 15:05:58 +02:00
searx.engines.xpath.rst [docs] move article "XPath Engine" to to admin/engines/ 2021-06-04 15:04:38 +02:00
settings.rst Merge pull request #999 from return42/fix-doc-settings2 2022-03-26 17:09:07 +01:00
sql-engines.rst [docs] fix some warnings from Sphinx-doc update 4.3.2 to 4.4.0 2022-01-21 09:35:00 +01:00