zaclys
/
searxng
mirror of https://github.com/searxng/searxng.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

[fix] update documentation of Search-API (/dev) 

This patch fixes a leftover from [#1548], the list of the plugins was not
up-to-date:

- HTTPS_rewrite has been removed (247c46c6b)
- DOAI_rewrite is named 'Open_Access_DOI_rewrite' (575159b)

[#1548] https://github.com/searxng/searxng/pull/1548

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2022-07-25 16:59:55 +02:00
parent b14ec7286d
commit 5795c1971f
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/dev/search_api.rst
View File

@ -91,22 +91,32 @@ Parameters
``enabled_plugins`` : optional ``enabled_plugins`` : optional
List of enabled plugins. List of enabled plugins.
:default: ``HTTPS_rewrite``, ``Self_Informations``, :default:
``Search_on_category_select``, ``Tracker_URL_remover`` ``Hash_plugin``, ``Search_on_category_select``,
``Self_Informations``, ``Tracker_URL_remover``,
``Ahmia_blacklist``
:values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, :values:
``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, .. enabled by default
``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin``
``Hash_plugin``, ``Search_on_category_select``,
``Self_Informations``, ``Tracker_URL_remover``,
``Ahmia_blacklist``,
.. disabled by default
``Hostname_replace``, ``Open_Access_DOI_rewrite``,
``Vim-like_hotkeys``, ``Tor_check_plugin``
``disabled_plugins``: optional ``disabled_plugins``: optional
List of disabled plugins. List of disabled plugins.
:default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, :default:
``Hostname_replace``, ``Tor_check_plugin`` ``Hostname_replace``, ``Open_Access_DOI_rewrite``,
``Vim-like_hotkeys``, ``Tor_check_plugin``
:values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, :values:
``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, see values from ``enabled_plugins``
``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin``
``enabled_engines`` : optional : *all* :origin:`engines <searx/engines>` ``enabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
List of enabled engines. List of enabled engines.