mirror of
https://github.com/searxng/searxng.git
synced 2025-12-22 19:50:00 +00:00
fb089ae297
* [mod] client/simple: client plugins
Defines a new interface for client side *"plugins"* that coexist with server
side plugin system. Each plugin (e.g., `InfiniteScroll`) extends the base
`ts Plugin`. Client side plugins are independent and lazy‑loaded via `router.ts`
when their `load()` conditions are met. On each navigation request, all
applicable plugins are instanced.
Since these are client side plugins, we can only invoke them once DOM is fully
loaded. E.g. `Calculator` will not render a new `answer` block until fully
loaded and executed.
For some plugins, we might want to handle its availability in `settings.yml`
and toggle in UI, like we do for server side plugins. In that case, we extend
`py Plugin` instancing only the information and then checking client side if
[`settings.plugins`](1ad832b1dc/client/simple/src/js/toolkit.ts (L134))
array has the plugin id.
* [mod] client/simple: rebuild static
113 lines
2.7 KiB
ReStructuredText
113 lines
2.7 KiB
ReStructuredText
.. _settings plugins:
|
|
|
|
============
|
|
``plugins:``
|
|
============
|
|
|
|
.. attention::
|
|
|
|
The ``enabled_plugins:`` section in SearXNG's settings no longer exists.
|
|
There is no longer a distinction between built-in and external plugin, all
|
|
plugins are registered via the settings in the ``plugins:`` section.
|
|
|
|
.. sidebar:: Further reading ..
|
|
|
|
- :ref:`plugins admin`
|
|
- :ref:`dev plugin`
|
|
|
|
In SearXNG, plugins can be registered in the :py:obj:`PluginStore
|
|
<searx.plugins.PluginStorage>` via a fully qualified class name.
|
|
|
|
A configuration (:py:obj:`PluginCfg <searx.plugins.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.
|
|
|
|
Please note that some plugins, such as the :ref:`hostnames plugin` plugin,
|
|
require further configuration before they can be made available for selection.
|
|
|
|
By default the :ref:`settings built in plugins` are loaded. To change the list
|
|
of plugins to be loaded, the value for ``plugins:`` in
|
|
``/etc/searxng/settings.yml`` must be overwritten.
|
|
|
|
Following is an example that uses :ref:`settings use_default_settings` and only
|
|
two plugins are registered: the calculator can be activated by the user and the
|
|
unit converter is active by default.
|
|
|
|
|
|
.. code:: yaml
|
|
|
|
use_default_settings: true
|
|
|
|
plugins:
|
|
|
|
searx.plugins.calculator.SXNGPlugin:
|
|
active: false
|
|
|
|
searx.plugins.unit_converter.SXNGPlugin:
|
|
active: true
|
|
|
|
To prevent any plugins from loading, the following setting can be used:
|
|
|
|
.. code:: yaml
|
|
|
|
use_default_settings: true
|
|
|
|
plugins: {}
|
|
|
|
|
|
.. _settings built in plugins:
|
|
|
|
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.infinite_scroll.SXNGPlugin:
|
|
active: false
|
|
|
|
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
|
|
|
|
|
|
.. _settings external_plugins:
|
|
|
|
external plugins
|
|
================
|
|
|
|
.. _Only show green hosted results:
|
|
https://github.com/return42/tgwf-searx-plugins/
|
|
|
|
SearXNG supports *external plugins* / there is no need to install one, SearXNG
|
|
runs out of the box.
|
|
|
|
- `Only show green hosted results`_
|
|
- ..
|