1
0
mirror of https://github.com/searxng/searxng.git synced 2024-11-22 04:01:40 +01:00

[doc] engine: Yacy

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2023-08-03 19:52:52 +02:00 committed by Markus Heiser
parent ca518c6803
commit 1b030d4b41
3 changed files with 60 additions and 11 deletions

View File

@ -0,0 +1,13 @@
.. _yacy engine:
====
Yacy
====
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. automodule:: searx.engines.yacy
:members:

View File

@ -1,11 +1,44 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
# lint: pylint
"""YaCy_ is a free distributed search engine, built on the principles of
peer-to-peer (P2P) networks.
API: Dev:APIyacysearch_
Releases:
- https://github.com/yacy/yacy_search_server/tags
- https://download.yacy.net/
.. _Yacy: https://yacy.net/
.. _Dev:APIyacysearch: https://wiki.yacy.net/index.php/Dev:APIyacysearch
Configuration
=============
The engine has the following (additional) settings:
.. code:: yaml
- name: yacy
engine: yacy
shortcut: ya
base_url: http://localhost:8090
# Yacy search mode. 'global' or 'local'.
search_mode: 'global'
number_of_results: 5
http_digest_auth_user: ""
http_digest_auth_pass: ""
Implementations
===============
"""
Yacy (Web, Images, Videos, Music, Files)
"""
# pylint: disable=fixme
from json import loads
from dateutil import parser
from urllib.parse import urlencode
from dateutil import parser
from httpx import DigestAuth
@ -27,8 +60,16 @@ paging = True
number_of_results = 5
http_digest_auth_user = ""
http_digest_auth_pass = ""
search_mode = 'global' # 'global', 'local'. By default, in yacy this is 'global'.
search_mode = 'global'
"""Yacy search mode ``global`` or ``local``. By default, Yacy operates in ``global``
mode.
``global``
Peer-to-Peer search
``local``
Privacy or Stealth mode, restricts the search to local yacy instance.
"""
# search-url
base_url = 'http://localhost:8090'
search_url = (
@ -43,7 +84,6 @@ search_url = (
search_types = {'general': 'text', 'images': 'image', 'files': 'app', 'music': 'audio', 'videos': 'video'}
# do search-request
def request(query, params):
offset = (params['pageno'] - 1) * number_of_results
search_type = search_types.get(params.get('category'), '0')
@ -66,7 +106,6 @@ def request(query, params):
return params
# get response from search-request
def response(resp):
results = []

View File

@ -1756,13 +1756,10 @@ engines:
# engine: yacy
# shortcut: ya
# base_url: http://localhost:8090
# required if you aren't using HTTPS for your local yacy instance'
# # required if you aren't using HTTPS for your local yacy instance'
# enable_http: true
# number_of_results: 5
# timeout: 3.0
# Yacy search mode. 'global' or 'local'. by default, Yacy operates in 'global' mode.
# 'global' = Peer-to-Peer search
# 'local' = Privacy or Stealth mode, restricts the search to local yacy instance.
# # Yacy search mode. 'global' or 'local'.
# search_mode: 'global'
- name: rumble