@@ -0,0 +1,114 @@
1+===============================
2+Query your local search engines
3+===============================
4+
5+From now on, searx lets you to query your locally running search engines. The following
6+ones are supported now:
7+
8+* `Elasticsearch`_
9+* `Meilisearch`_
10+* `Solr`_
11+
12+All of the engines above are added to ``settings.yml`` just commented out, as you have to
13+``base_url`` for all them.
14+
15+Please note that if you are not using HTTPS to access these engines, you have to enable
16+HTTP requests by setting ``enable_http`` to ``True``.
17+
18+Futhermore, if you do not want to expose these engines on a public instance, you can
19+still add them and limit the access by setting ``tokens`` as described in the `blog post about
20+private engines`_.
21+
22+Configuring searx for search engines
23+====================================
24+
25+Each search engine is powerful, capable of full-text search.
26+
27+Elasticsearch
28+-------------
29+
30+Elasticsearch supports numerous ways to query the data it is storing. At the moment
31+the engine supports the most popular search methods: ``match``, ``simple_query_string``, ``term`` and ``terms``.
32+
33+If none of the methods fit your use case, you can select ``custom`` query type and provide the JSON payload
34+searx has to submit to Elasticsearch in ``custom_query_json``.
35+
36+The following is an example configuration for an Elasticsearch instance with authentication
37+configured to read from ``my-index`` index.
38+
39+.. code:: yaml
40+
41+ - name : elasticsearch
42+ shortcut : es
43+ engine : elasticsearch
44+ base_url : http://localhost:9200
45+ username : elastic
46+ password : changeme
47+ index : my-index
48+ query_type : match
49+ enable_http : True
50+
51+
52+Meilisearch
53+-----------
54+
55+This search engine is aimed at individuals and small companies. It is designed for
56+small-scale (less than 10 million documents) data collections. E.g. it is great for storing
57+web pages you have visited and searching in the contents later.
58+
59+The engine supports faceted search, so you can search in a subset of documents of the collection.
60+Futhermore, you can search in Meilisearch instances that require authentication by setting ``auth_token``.
61+
62+Here is a simple example to query a Meilisearch instance:
63+
64+.. code:: yaml
65+
66+ - name : meilisearch
67+ engine : meilisearch
68+ shortcut: mes
69+ base_url : http://localhost:7700
70+ index : my-index
71+ enable_http: True
72+
73+
74+Solr
75+----
76+
77+Solr is a popular search engine based on Lucene, just like Elasticsearch.
78+But instead of searching in indices, you can search in collections.
79+
80+This is an example configuration for searching in the collection ``my-collection`` and get
81+the results in ascending order.
82+
83+.. code:: yaml
84+
85+ - name : solr
86+ engine : solr
87+ shortcut : slr
88+ base_url : http://localhost:8983
89+ collection : my-collection
90+ sort : asc
91+ enable_http : True
92+
93+
94+Next steps
95+==========
96+
97+The next step is to add support for various SQL databases.
98+
99+Acknowledgement
100+===============
101+
102+This development was sponsored by `Search and Discovery Fund`_ of `NLnet Foundation`_ .
103+
104+.. _blog post about private engines: private-engines.html#private-engines
105+.. _Elasticsearch: https://www.elastic.co/elasticsearch/
106+.. _Meilisearch: https://www.meilisearch.com/
107+.. _Solr: https://solr.apache.org/
108+.. _Search and Discovery Fund: https://nlnet.nl/discovery
109+.. _NLnet Foundation: https://nlnet.nl/
110+
111+
112+| Happy hacking.
113+| kvch // 2021.04.07 23:16
114+