diff options
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/plugins.rst | 19 | ||||
| -rw-r--r-- | docs/admin/settings/index.rst | 2 | ||||
| -rw-r--r-- | docs/admin/settings/settings_plugins.rst | 67 |
3 files changed, 76 insertions, 12 deletions
diff --git a/docs/admin/plugins.rst b/docs/admin/plugins.rst index d97b3dada..d3d137fcf 100644 --- a/docs/admin/plugins.rst +++ b/docs/admin/plugins.rst @@ -1,12 +1,14 @@ -.. _plugins generic: +.. _plugins admin: =============== -Plugins builtin +List of plugins =============== .. sidebar:: Further reading .. + - :ref:`SearXNG settings <settings plugins>` - :ref:`dev plugin` + - :ref:`builtin plugins` Configuration defaults (at built time): @@ -25,15 +27,10 @@ Configuration defaults (at built time): - DO - Description - JS & CSS dependencies + {% for plg in plugins %} - {% for plgin in plugins %} - - * - {{plgin.name}} - - {{(plgin.default_on and "y") or ""}} - - {{plgin.description}} - - {% for dep in (plgin.js_dependencies + plgin.css_dependencies) %} - | ``{{dep}}`` {% endfor %} + * - {{plg.info.name}} + - {{(plg.default_on and "y") or ""}} + - {{plg.info.description}} {% endfor %} diff --git a/docs/admin/settings/index.rst b/docs/admin/settings/index.rst index acc91dbdd..d1f808f3d 100644 --- a/docs/admin/settings/index.rst +++ b/docs/admin/settings/index.rst @@ -22,6 +22,6 @@ Settings settings_redis settings_outgoing settings_categories_as_tabs - + settings_plugins diff --git a/docs/admin/settings/settings_plugins.rst b/docs/admin/settings/settings_plugins.rst new file mode 100644 index 000000000..991e7ee53 --- /dev/null +++ b/docs/admin/settings/settings_plugins.rst @@ -0,0 +1,67 @@ +.. _settings plugins: + +======= +Plugins +======= + +.. sidebar:: Further reading .. + + - :ref:`plugins admin` + - :ref:`dev plugin` + - :ref:`builtin plugins` + + +The built-in plugins can be activated or deactivated via the settings +(:ref:`settings enabled_plugins`) and external plugins can be integrated into +SearXNG (:ref:`settings external_plugins`). + + +.. _settings enabled_plugins: + +``enabled_plugins:`` (internal) +=============================== + +In :ref:`plugins admin` you find a complete list of all plugins, the default +configuration looks like: + +.. code:: yaml + + enabled_plugins: + - 'Basic Calculator' + - 'Hash plugin' + - 'Self Information' + - 'Tracker URL remover' + - 'Unit converter plugin' + - 'Ahmia blacklist' + + +.. _settings external_plugins: + +``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] +<https://www.thegreenwebfoundation.org/news/searching-the-green-web-with-searx/>`__: + +.. code:: bash + + $ sudo utils/searxng.sh instance cmd bash -c + (searxng-pyenv)$ pip install git+https://github.com/return42/tgwf-searx-plugins + +In the :ref:`settings.yml` activate the ``plugins:`` section and add module +``only_show_green_results`` from ``tgwf-searx-plugins``. + +.. code:: yaml + + 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 :py:obj:`searx.plugins.Plugin` class. |