mirror of
https://github.com/searxng/searxng.git
synced 2025-03-29 15:45:29 +00:00
50f92779bd
This patch brings two major changes:
- ``Result.filter_urls(..)`` to pass a filter function for URL fields
- The ``enabled_plugins:`` section in SearXNG's settings do no longer exists.
To understand plugin development compile documentation:
$ make docs.clean docs.live
and read http://0.0.0.0:8000/dev/plugins/development.html
There is no longer a distinction between built-in and external plugin, all
plugins are registered via the settings in the ``plugins:`` section.
In SearXNG, plugins can be registered via a fully qualified class name. A
configuration (`PluginCfg`) can be transferred to the plugin, e.g. to activate
it by default / *opt-in* or *opt-out* from user's point of view.
built-in plugins
================
The built-in plugins are all located in the namespace `searx.plugins`.
.. code:: yaml
plugins:
searx.plugins.calculator.SXNGPlugin:
active: true
searx.plugins.hash_plugin.SXNGPlugin:
active: true
searx.plugins.self_info.SXNGPlugin:
active: true
searx.plugins.tracker_url_remover.SXNGPlugin:
active: true
searx.plugins.unit_converter.SXNGPlugin:
active: true
searx.plugins.ahmia_filter.SXNGPlugin:
active: true
searx.plugins.hostnames.SXNGPlugin:
active: true
searx.plugins.oa_doi_rewrite.SXNGPlugin:
active: false
searx.plugins.tor_check.SXNGPlugin:
active: false
external plugins
================
SearXNG supports *external plugins* / there is no need to install one, SearXNG
runs out of the box.
- Only show green hosted results: https://github.com/return42/tgwf-searx-plugins/
To get a developer installation in a SearXNG developer environment:
.. code:: sh
$ git clone git@github.com:return42/tgwf-searx-plugins.git
$ ./manage pyenv.cmd python -m \
pip install -e tgwf-searx-plugins
To register the plugin in SearXNG add ``only_show_green_results.SXNGPlugin`` to
the ``plugins:``:
.. code:: yaml
plugins:
# ...
only_show_green_results.SXNGPlugin:
active: false
Result.filter_urls(..)
======================
The ``Result.filter_urls(..)`` can be used to filter and/or modify URL fields.
In the following example, the filter function ``my_url_filter``:
.. code:: python
def my_url_filter(result, field_name, url_src) -> bool | str:
if "google" in url_src:
return False # remove URL field from result
if "facebook" in url_src:
new_url = url_src.replace("facebook", "fb-dummy")
return new_url # return modified URL
return True # leave URL in field unchanged
is applied to all URL fields in the :py:obj:`Plugin.on_result` hook:
.. code:: python
class MyUrlFilter(Plugin):
...
def on_result(self, request, search, result) -> bool:
result.filter_urls(my_url_filter)
return True
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
|
||
|---|---|---|
| .. | ||
| answerers | ||
| botdetection | ||
| data | ||
| enginelib | ||
| engines | ||
| favicons | ||
| infopage | ||
| metrics | ||
| network | ||
| plugins | ||
| result_types | ||
| search | ||
| static/themes/simple | ||
| templates/simple | ||
| translations | ||
| __init__.py | ||
| autocomplete.py | ||
| babel_extract.py | ||
| compat.py | ||
| exceptions.py | ||
| extended_types.py | ||
| external_bang.py | ||
| external_urls.py | ||
| flaskfix.py | ||
| limiter.py | ||
| limiter.toml | ||
| locales.py | ||
| openmetrics.py | ||
| preferences.py | ||
| query.py | ||
| redisdb.py | ||
| redislib.py | ||
| results.py | ||
| searxng.msg | ||
| settings.yml | ||
| settings_defaults.py | ||
| settings_loader.py | ||
| sqlitedb.py | ||
| sxng_locales.py | ||
| unixthreadname.py | ||
| utils.py | ||
| version.py | ||
| webadapter.py | ||
| webapp.py | ||
| webutils.py | ||