configured_engines.rst 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. _configured engines:
  2. ==================
  3. Configured Engines
  4. ==================
  5. .. sidebar:: Further reading ..
  6. - :ref:`engines-dev`
  7. - :ref:`settings engine`
  8. Explanation of the :ref:`general engine configuration` shown in the table
  9. :ref:`configured engines`.
  10. .. jinja:: searx
  11. SearXNG supports {{engines | length}} search engines (of which {{enabled_engine_count}} are enabled by default).
  12. {% for category, engines in engines.items() | groupby('1.categories.0') %}
  13. {{category}} search engines
  14. ---------------------------------------
  15. .. flat-table::
  16. :header-rows: 2
  17. :stub-columns: 1
  18. * - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`)
  19. - :cspan:`3` :ref:`Supported features <engine file>`
  20. * - Name
  21. - Shortcut
  22. - Module
  23. - Disabled
  24. - Timeout
  25. - Weight
  26. - Paging
  27. - Language
  28. - Safe search
  29. - Time range
  30. {% for name, mod in engines | sort_engines %}
  31. * - `{{name}} <{{mod.about and mod.about.website}}>`_
  32. - ``!{{mod.shortcut}}``
  33. - {%- if 'searx.engines.' + mod.__name__ in documented_modules %}
  34. :py:mod:`~searx.engines.{{mod.__name__}}`
  35. {%- else %}
  36. :origin:`{{mod.__name__}} <searx/engines/{{mod.__name__}}.py>`
  37. {%- endif %}
  38. - {{(mod.disabled and "y") or ""}}
  39. {%- if mod.about and mod.about.language %}
  40. ({{mod.about.language | upper}})
  41. {%- endif %}
  42. - {{mod.timeout}}
  43. - {{mod.weight or 1 }}
  44. {% if mod.engine_type == 'online' %}
  45. - {{(mod.paging and "y") or ""}}
  46. - {{(mod.language_support and "y") or ""}}
  47. - {{(mod.safesearch and "y") or ""}}
  48. - {{(mod.time_range_support and "y") or ""}}
  49. {% else %}
  50. - :cspan:`3` not applicable ({{mod.engine_type}})
  51. {% endif %}
  52. {% endfor %}
  53. {% endfor %}