kamp/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-11-15 01:00:12 +01:00
Code

[doc] hostname plugin: improve online documentation

Browse Source 
The data types (list & map) should be made clearer, as these sometimes lead to
misunderstandings.

[1] https://github.com/searxng/searxng/issues/3558#issuecomment-2175058128

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2024-06-18 11:10:41 +02:00 committed by Markus Heiser
parent accc1c1032
commit acf3f109b2
1 changed files with 42 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
searx/plugins/hostnames.py
View File

@ -13,21 +13,54 @@ other features.
**To maintainers of SearXNG instances, please modify your old plugin config **To maintainers of SearXNG instances, please modify your old plugin config
to the new.** to the new.**
- ``hostnames.replace``: A mapping of regular expressions to hostnames to be - ``hostnames.replace``: A **mapping** of regular expressions to hostnames to be
replaced by other hostnames. replaced by other hostnames.
- ``hostnames.remove``: A list of regular expressions of the hostnames whose .. code:: yaml
hostnames:
replace:
'(.*\\.)?youtube\\.com$': 'invidious.example.com'
'(.*\\.)?youtu\\.be$': 'invidious.example.com'
...
- ``hostnames.remove``: A **list** of regular expressions of the hostnames whose
results should be taken from the results list. results should be taken from the results list.
- ``hostnames.high_priority``: A list of regular expressions for hostnames whose .. code:: yaml
result should be given higher priority. The results from these hosts are
hostnames:
remove:
- '(.*\\.)?facebook.com$'
- ...
- ``hostnames.high_priority``: A **list** of regular expressions for hostnames
whose result should be given higher priority. The results from these hosts are
arranged higher in the results list. arranged higher in the results list.
- ``hostnames.lower_priority``: A list of regular expressions for hostnames .. code:: yaml
hostnames:
high_priority:
- '(.*\\.)?wikipedia.org$'
- ...
- ``hostnames.lower_priority``: A **list** of regular expressions for hostnames
whose result should be given lower priority. The results from these hosts are whose result should be given lower priority. The results from these hosts are
arranged lower in the results list. arranged lower in the results list.
Alternatively, a file name can also be specified for the mappings or lists: .. code:: yaml
hostnames:
low_priority:
- '(.*\\.)?google(\\..*)?$'
- ...
If the URL matches the pattern of ``high_priority`` AND ``low_priority``, the
higher priority wins over the lower priority.
Alternatively, you can also specify a file name for the **mappings** or
**lists** to load these from an external file:
.. code:: yaml .. code:: yaml
@ -35,13 +68,13 @@ Alternatively, a file name can also be specified for the mappings or lists:
replace: 'rewrite-hosts.yml' replace: 'rewrite-hosts.yml'
remove: remove:
- '(.*\\.)?facebook.com$' - '(.*\\.)?facebook.com$'
... - ...
low_priority: low_priority:
- '(.*\\.)?google(\\..*)?$' - '(.*\\.)?google(\\..*)?$'
... - ...
high_priority: high_priority:
- '(.*\\.)?wikipedia.org$' - '(.*\\.)?wikipedia.org$'
... - ...
The ``rewrite-hosts.yml`` from the example above must be in the folder in which The ``rewrite-hosts.yml`` from the example above must be in the folder in which
the ``settings.yml`` file is already located (``/etc/searxng``). The file then the ``settings.yml`` file is already located (``/etc/searxng``). The file then