summaryrefslogtreecommitdiff
path: root/docs/blog
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-06-03 10:07:02 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2021-06-04 15:04:38 +0200
commitacb15772025ea84b1f61a9e67a4cb5f9d4685d43 (patch)
treebec7fc5f8c998adc43d388f029b9486ad4a189d2 /docs/blog
parentb88d9d49cc38ee237cce0fd818bb84f01a5f5b88 (diff)
downloadsearxng-acb15772025ea84b1f61a9e67a4cb5f9d4685d43.tar.gz
searxng-acb15772025ea84b1f61a9e67a4cb5f9d4685d43.zip
[docs] move blog article "Offline engines" to dev/offline_engines.rst
The article "Offline engines" should be in developer's documentation next to chapter "Engine overview". Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/blog')
-rw-r--r--docs/blog/index.rst1
-rw-r--r--docs/blog/intro-offline.rst77
2 files changed, 0 insertions, 78 deletions
diff --git a/docs/blog/index.rst b/docs/blog/index.rst
index b5b3aaae6..1b2c39596 100644
--- a/docs/blog/index.rst
+++ b/docs/blog/index.rst
@@ -7,6 +7,5 @@ Blog
:caption: Contents
lxcdev-202006
- intro-offline
private-engines
search-indexer-engines
diff --git a/docs/blog/intro-offline.rst b/docs/blog/intro-offline.rst
deleted file mode 100644
index 3a706d038..000000000
--- a/docs/blog/intro-offline.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-===============================
-Preparation for offline engines
-===============================
-
-Offline engines
-===============
-
-To extend the functionality of searx, 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 as online engines, by adding those to the
-`engines` list of :origin:`settings.yml <searx/settings.yml>`. Thus, searx
-finds the engine file and imports it.
-
-Example skeleton for the new engines:
-
-.. code:: python
-
- from subprocess import PIPE, Popen
-
- categories = ['general']
- offline = True
-
- def init(settings):
- pass
-
- def search(query, params):
- process = Popen(['ls', query], stdout=PIPE)
- return_code = process.wait()
- if return_code != 0:
- raise RuntimeError('non-zero return code', return_code)
-
- results = []
- line = process.stdout.readline()
- while line:
- result = parse_line(line)
- results.append(results)
-
- line = process.stdout.readline()
-
- return results
-
-
-Development progress
-====================
-
-First, a proposal has been created as a Github issue. Then it was moved to the
-wiki as a design document. You can read it here: :wiki:`Offline-engines`.
-
-In this development step, searx core was prepared to accept and perform offline
-searches. Offline search requests are scheduled together with regular offline
-requests.
-
-As offline searches can return arbitrary results depending on the engine, the
-current result templates were insufficient to present such results. Thus, a new
-template is introduced which is caplable of presenting arbitrary key value pairs
-as a table. You can check out the pull request for more details see
-:pull-searx:`1700`.
-
-Next steps
-==========
-
-Today, it is possible to create/run an offline engine. However, it is going to be publicly available for everyone who knows the searx instance. So the next step is to introduce token based access for engines. This way administrators are able to limit the access to private engines.
-
-Acknowledgement
-===============
-
-This development was sponsored by `Search and Discovery Fund`_ of `NLnet Foundation`_ .
-
-.. _Search and Discovery Fund: https://nlnet.nl/discovery
-.. _NLnet Foundation: https://nlnet.nl/
-
-
-| Happy hacking.
-| kvch // 2019.10.21 17:03
-