From 5720844fcdc8601798e10544e2fd25ce4f2ad099 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 30 Jun 2023 18:07:02 +0200 Subject: [doc] rearranges Settings & Engines docs for better readability We have built up detailed documentation of the *settings* and the *engines* over the past few years. However, this documentation was still spread over various chapters and was difficult to navigate in its entirety. This patch rearranges the Settings & Engines documentation for better readability. To review new ordered docs:: make docs.clean docs.live Signed-off-by: Markus Heiser --- docs/dev/offline_engines.rst | 78 -------------------------------------------- 1 file changed, 78 deletions(-) delete mode 100644 docs/dev/offline_engines.rst (limited to 'docs/dev/offline_engines.rst') diff --git a/docs/dev/offline_engines.rst b/docs/dev/offline_engines.rst deleted file mode 100644 index bfb2664f5..000000000 --- a/docs/dev/offline_engines.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. _offline engines: - -=============== -Offline Engines -=============== - -.. sidebar:: offline engines - - - :ref:`demo offline engine` - - :ref:`sql engines` - - :ref:`engine command` - - :origin:`Redis ` - -To extend the functionality of SearXNG, offline engines are going to be -introduced. An offline engine is an engine which does not need Internet -connection to perform a search and does not use HTTP to communicate. - -Offline engines can be configured, by adding those to the `engines` list of -:origin:`settings.yml `. An example skeleton for offline -engines can be found in :ref:`demo offline engine` (:origin:`demo_offline.py -`). - - -Programming Interface -===================== - -:py:func:`init(engine_settings=None) ` - All offline engines can have their own init function to setup the engine before - accepting requests. The function gets the settings from settings.yml as a - parameter. This function can be omitted, if there is no need to setup anything - in advance. - -:py:func:`search(query, params) ` - - Each offline engine has a function named ``search``. This function is - responsible to perform a search and return the results in a presentable - format. (Where *presentable* means presentable by the selected result - template.) - - The return value is a list of results retrieved by the engine. - -Engine representation in ``/config`` - If an engine is offline, the attribute ``offline`` is set to ``True``. - -.. _offline requirements: - -Extra Dependencies -================== - -If an offline engine depends on an external tool, SearXNG does not install it by -default. When an administrator configures such engine and starts the instance, -the process returns an error with the list of missing dependencies. Also, -required dependencies will be added to the comment/description of the engine, so -admins can install packages in advance. - -If there is a need to install additional packages in *Python's Virtual -Environment* of your SearXNG instance you need to switch into the environment -(:ref:`searxng-src`) first, for this you can use :ref:`searxng.sh`:: - - $ sudo utils/searxng.sh instance cmd bash - (searxng-pyenv)$ pip install ... - - -Private engines (Security) -========================== - -To limit the access to offline engines, if an instance is available publicly, -administrators can set token(s) for each of the :ref:`private engines`. If a -query contains a valid token, then SearXNG performs the requested private -search. If not, requests from an offline engines return errors. - - -Acknowledgement -=============== - -This development was sponsored by `Search and Discovery Fund -`_ of `NLnet Foundation `_ . - -- cgit v1.2.3