ZaclysIndustries/searxngRebrandZaclys
2
0
Fork 0
forked from zaclys/searxng
Code Issues Pull Requests Activity
03123675a0
searxngRebrandZaclys/docs/user/configured_engines.rst
Markus Heiser 5720844fcd [doc] rearranges Settings & Engines docs for better readability 
We have built up detailed documentation of the *settings* and the *engines* over
the past few years.  However, this documentation was still spread over various
chapters and was difficult to navigate in its entirety.

This patch rearranges the Settings & Engines documentation for better
readability.

To review new ordered docs::

   make docs.clean docs.live

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-07-01 22:45:19 +02:00

2.6 KiB
Raw Blame History

Configured Engines

Further reading ..

  • settings categories_as_tabs
  • engines-dev
  • settings engine
  • general engine configuration

searx

SearXNG supports {{engines | length}} search engines of which {{enabled_engine_count}} are enabled by default.

Engines can be assigned to multiple categories <engine categories>. The UI displays the tabs that are configured in categories_as_tabs <settings categories_as_tabs>. In addition to these UI categories (also called tabs), engines can be queried by their name or the categories they belong to, by using a \!bing syntax <search-syntax>.

searx

{% for category, engines in categories_as_tabs.items() %}

tab !{{category.replace(' ', '_')}}

{% for group, group_bang, engines in engines | group_engines_in_tab %}

{% if loop.length > 1 %} {% if group_bang %}group {{group_bang}}{% else %}{{group}}{% endif %} ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {% endif %}

    • 5 Engines configured by default (in settings.yml <engine settings>)
    • 3 Supported features <engine file>
    • Name
    • !bang
    • Module
    • Disabled
    • Timeout
    • Weight
    • Paging
    • Locale
    • Safe search
    • Time range

{% for mod in engines %}

    • {{mod.name}} {%- if mod.about and mod.about.language %} ({{mod.about.language | upper}}) {%- endif %}
    • !{{mod.shortcut}}
    • {%- if 'searx.engines.' + mod.__name__ in documented_modules %} :py~searx.engines.{{mod.__name__}} {%- else %} {{mod.__name__}} <searx/engines/{{mod.__name__}}.py> {%- endif %}
    • {{(mod.disabled and "y") or ""}}
    • {{mod.timeout}}
    - {{mod.weight or 1 }} {% if mod.engine_type == 'online' %}
    • {{(mod.paging and "y") or ""}}
    • {{(mod.language_support and "y") or ""}}
    • {{(mod.safesearch and "y") or ""}}
    - {{(mod.time_range_support and "y") or ""}} {% else %} - 3 not applicable ({{mod.engine_type}}) {% endif %}

{% endfor %} {% endfor %} {% endfor %}