Plugins¶
The built-in plugins can be activated or deactivated via the settings (enabled_plugins: (internal)) and external plugins can be integrated into SearXNG (plugins: (external)).
enabled_plugins: (internal)¶
In List of plugins you find a complete list of all plugins, the default configuration looks like:
enabled_plugins:
- 'Basic Calculator'
- 'Hash plugin'
- 'Self Information'
- 'Tracker URL remover'
- 'Unit converter plugin'
- 'Ahmia blacklist'
plugins: (external)¶
SearXNG supports external plugins / there is no need to install one, SearXNG runs out of the box. But to demonstrate; in the example below we install the SearXNG plugins from The Green Web Foundation [ref]:
$ sudo utils/searxng.sh instance cmd bash -c
(searxng-pyenv)$ pip install git+https://github.com/return42/tgwf-searx-plugins
In the settings.yml activate the plugins: section and add module
only_show_green_results from tgwf-searx-plugins.
plugins:
- only_show_green_results
# - mypackage.mymodule.MyPlugin
# - mypackage.mymodule.MyOtherPlugin
Hint
only_show_green_results is an old plugin that was still implemented in
the old style. There is a legacy treatment for backward compatibility, but
new plugins should be implemented as a searx.plugins.Plugin class.
