mirror of
				https://github.com/searxng/searxng.git
				synced 2025-10-31 10:37:06 -04:00 
			
		
		
		
	Implementations of the *traits* of the engines.
Engine's traits are fetched from the origin engine and stored in a JSON file in
the *data folder*.  Most often traits are languages and region codes and their
mapping from SearXNG's representation to the representation in the origin search
engine.
To load traits from the persistence::
    searx.enginelib.traits.EngineTraitsMap.from_data()
For new traits new properties can be added to the class::
    searx.enginelib.traits.EngineTraits
.. hint::
   Implementation is downward compatible to the deprecated *supported_languages
   method* from the vintage implementation.
   The vintage code is tagged as *deprecated* an can be removed when all engines
   has been ported to the *traits method*.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
		
	
			
		
			
				
	
	
		
			76 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			76 lines
		
	
	
		
			2.0 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
| .. _configured engines:
 | |
| 
 | |
| ==================
 | |
| Configured Engines
 | |
| ==================
 | |
| 
 | |
| .. sidebar:: Further reading ..
 | |
| 
 | |
|    - :ref:`engines-dev`
 | |
|    - :ref:`settings engine`
 | |
| 
 | |
| Explanation of the :ref:`general engine configuration` shown in the table
 | |
| :ref:`configured engines`.
 | |
| 
 | |
| .. jinja:: searx
 | |
| 
 | |
|    SearXNG supports {{engines | length}} search engines (of which {{enabled_engine_count}} are enabled by default).
 | |
| 
 | |
|    {% for category, engines in categories_as_tabs.items() %}
 | |
| 
 | |
|    {{category}} search engines
 | |
|    ---------------------------------------
 | |
| 
 | |
|    {% for group, engines in engines | group_engines_in_tab %}
 | |
| 
 | |
|    {% if loop.length > 1 %}
 | |
|    {{group}}
 | |
|    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 | |
|    {% endif %}
 | |
| 
 | |
|    .. flat-table::
 | |
|       :header-rows: 2
 | |
|       :stub-columns: 1
 | |
| 
 | |
|       * - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`)
 | |
|         - :cspan:`3` :ref:`Supported features <engine file>`
 | |
| 
 | |
|       * - Name
 | |
|         - Shortcut
 | |
|         - Module
 | |
|         - Disabled
 | |
|         - Timeout
 | |
|         - Weight
 | |
|         - Paging
 | |
|         - Language, Region
 | |
|         - Safe search
 | |
|         - Time range
 | |
| 
 | |
|       {% for mod in engines %}
 | |
| 
 | |
|       * - `{{mod.name}} <{{mod.about and mod.about.website}}>`_
 | |
|         - ``!{{mod.shortcut}}``
 | |
|         - {%- if 'searx.engines.' + mod.__name__ in documented_modules %}
 | |
|           :py:mod:`~searx.engines.{{mod.__name__}}`
 | |
|           {%- else %}
 | |
|           :origin:`{{mod.__name__}} <searx/engines/{{mod.__name__}}.py>`
 | |
|           {%- endif %}
 | |
|         - {{(mod.disabled and "y") or ""}}
 | |
|           {%- if mod.about and  mod.about.language %}
 | |
|           ({{mod.about.language | upper}})
 | |
|           {%- endif %}
 | |
|         - {{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 %}
 | |
|         - :cspan:`3` not applicable ({{mod.engine_type}})
 | |
|         {% endif %}
 | |
| 
 | |
|      {% endfor %}
 | |
|      {% endfor %}
 | |
|      {% endfor %}
 |