From ccf3d89e8f755e839b02f18156049accc9f261ab Mon Sep 17 00:00:00 2001 From: Adam Tauber Date: Thu, 5 Mar 2020 02:49:34 +0100 Subject: [PATCH 1/2] [fix] update dead link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index eb2c58ea2..a7b75d6e2 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,7 @@ Go to the `searx-docker `__ project. Without Docker -------------- -For all of the details, follow this `step by step installation `__. +For all of the details, follow this `step by step installation `__. Note: the documentation needs to be updated. From 3d03fb305050a42661999b47597694616d532bf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?No=C3=A9mi=20V=C3=A1nyi?= Date: Fri, 28 Feb 2020 22:32:28 +0100 Subject: [PATCH 2/2] Add new post to blog about private engines --- docs/blog/index.rst | 1 + docs/blog/private-engines.rst | 63 +++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 docs/blog/private-engines.rst diff --git a/docs/blog/index.rst b/docs/blog/index.rst index 52fa3f126..94847ad62 100644 --- a/docs/blog/index.rst +++ b/docs/blog/index.rst @@ -8,3 +8,4 @@ Blog python3 admin intro-offline + private-engines diff --git a/docs/blog/private-engines.rst b/docs/blog/private-engines.rst new file mode 100644 index 000000000..c26b3ed1c --- /dev/null +++ b/docs/blog/private-engines.rst @@ -0,0 +1,63 @@ +================================== +Limit access to your searx engines +================================== + +Administrators might find themselves wanting to limit access to some of the +enabled engines on their instances. It might be because they do not want to +expose some private information through an offline engine. Or they +would rather share engines only with their trusted friends or colleagues. + +Private engines +=============== + +To solve this issue private engines were introduced in :pull:`1823`. +A new option was added to engines named `tokens`. It expects a list +of strings. If the user making a request presents one of the tokens +of an engine, he/she is able to access information about the engine +and make search requests. + +Example configuration to restrict access to the Arch Linux Wiki engine: + +.. code:: yaml + + - name : arch linux wiki + engine : archlinux + shortcut : al + tokens : [ 'my-secret-token' ] + + +Unless a user has configured the right token, the engine is going +to be hidden from him/her. It is not going to be included in the +list of engines on the Preferences page and in the output of +`/config` REST API call. + +Tokens can be added to one's configuration on the Preferences page +under "Engine tokens". The input expects a comma separated list of +strings. + +The distribution of the tokens from the administrator to the users +is not carved in stone. As providing access to such engines +implies that the admin knows and trusts the user, we do not see +necessary to come up with a strict process. Instead, +we would like to add guidelines to the documentation of the feature. + +Next steps +========== + +Now that searx has support for both offline engines and private engines, +it is possible to add concrete engines which benefit from these features. +For example engines which search on the local host running the instance. +Be it searching your file system or querying a private database. Be creative +and come up with new solutions which fit your use case. + +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 // 2020.02.28 22:26