git.iko.soy/searx
on master help sign in
searx/docs/blog/search-indexer-engines.rst
114 lines 3.3 kB history raw
1===============================
2Query your local search engines
3===============================
5From now on, searx lets you to query your locally running search engines. The following
6ones are supported now:
8* `Elasticsearch`_
9* `Meilisearch`_
10* `Solr`_
12All of the engines above are added to ``settings.yml`` just commented out, as you have to
13``base_url`` for all them.
15Please note that if you are not using HTTPS to access these engines, you have to enable
16HTTP requests by setting ``enable_http`` to ``True``.
18Futhermore, if you do not want to expose these engines on a public instance, you can
19still add them and limit the access by setting ``tokens`` as described in the `blog post about
20private engines`_.
22Configuring searx for search engines
23====================================
25Each search engine is powerful, capable of full-text search.
27Elasticsearch
28-------------
30Elasticsearch supports numerous ways to query the data it is storing. At the moment
31the engine supports the most popular search methods: ``match``, ``simple_query_string``, ``term`` and ``terms``.
33If none of the methods fit your use case, you can select ``custom`` query type and provide the JSON payload
34searx has to submit to Elasticsearch in ``custom_query_json``.
36The following is an example configuration for an Elasticsearch instance with authentication
37configured to read from ``my-index`` index.
39.. code:: yaml
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
52Meilisearch
53-----------
55This search engine is aimed at individuals and small companies. It is designed for
56small-scale (less than 10 million documents) data collections. E.g. it is great for storing
57web pages you have visited and searching in the contents later.
59The engine supports faceted search, so you can search in a subset of documents of the collection.
60Futhermore, you can search in Meilisearch instances that require authentication by setting ``auth_token``.
62Here is a simple example to query a Meilisearch instance:
64.. code:: yaml
66 - name : meilisearch
67 engine : meilisearch
68 shortcut: mes
69 base_url : http://localhost:7700
70 index : my-index
71 enable_http: True
74Solr
75----
77Solr is a popular search engine based on Lucene, just like Elasticsearch.
78But instead of searching in indices, you can search in collections.
80This is an example configuration for searching in the collection ``my-collection`` and get
81the results in ascending order.
83.. code:: yaml
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
94Next steps
95==========
97The next step is to add support for various SQL databases.
99Acknowledgement
100===============
102This development was sponsored by `Search and Discovery Fund`_ of `NLnet Foundation`_ .
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/
112| Happy hacking.
113| kvch // 2021.04.07 23:16