summaryrefslogtreecommitdiff
path: root/searx/engines/elasticsearch.py
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2023-06-30 18:07:02 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2023-07-01 22:45:19 +0200
commit5720844fcdc8601798e10544e2fd25ce4f2ad099 (patch)
treeaf611e4aef436253f4fda9504d06e05e2621114d /searx/engines/elasticsearch.py
parent8e8d8dabe9b17c9db8db7432c6bc063d9ae980d1 (diff)
downloadsearxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.tar.gz
searxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.zip
[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 <markus.heiser@darmarit.de>
Diffstat (limited to 'searx/engines/elasticsearch.py')
-rw-r--r--searx/engines/elasticsearch.py42
1 files changed, 40 insertions, 2 deletions
diff --git a/searx/engines/elasticsearch.py b/searx/engines/elasticsearch.py
index f6e207b4d..7bddab1cb 100644
--- a/searx/engines/elasticsearch.py
+++ b/searx/engines/elasticsearch.py
@@ -1,6 +1,44 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
-"""
- Elasticsearch
+""".. sidebar:: info
+
+ - :origin:`elasticsearch.py <searx/engines/elasticsearch.py>`
+ - `Elasticsearch <https://www.elastic.co/elasticsearch/>`_
+ - `Elasticsearch Guide
+ <https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html>`_
+ - `Install Elasticsearch
+ <https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html>`_
+
+Elasticsearch_ supports numerous ways to query the data it is storing. At the
+moment the engine supports the most popular search methods (``query_type``):
+
+- ``match``,
+- ``simple_query_string``,
+- ``term`` and
+- ``terms``.
+
+If none of the methods fit your use case, you can select ``custom`` query type
+and provide the JSON payload to submit to Elasticsearch in
+``custom_query_json``.
+
+Example
+=======
+
+The following is an example configuration for an Elasticsearch_ instance with
+authentication configured to read from ``my-index`` index.
+
+.. code:: yaml
+
+ - name: elasticsearch
+ shortcut: es
+ engine: elasticsearch
+ base_url: http://localhost:9200
+ username: elastic
+ password: changeme
+ index: my-index
+ query_type: match
+ # custom_query_json: '{ ... }'
+ enable_http: true
+
"""
from json import loads, dumps