From d70ec8826de4459359326d392ed27cbf93c4a6f0 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 19 Jun 2020 18:36:23 +0200 Subject: [PATCH] [doc] admin manual - describe installation of external plugins Signed-off-by: Markus Heiser --- docs/admin/installation.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 722458152..cd6bb62ac 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -73,14 +73,36 @@ This installs searx as described in :ref:`installation basic`. If all services are running fine, you can add it to your HTTP server: +**Install** HTTP + - :ref:`installation apache` - :ref:`installation nginx` +**Install** :ref:`external plugins ` + +Use searx's ``shell`` to install external plugins. In the example below we +install the searx plugins from **The Green Web Foundation** `[ref] +`__: + +.. code:: bash + + $ sudo -H ./utils/searx.sh shell + // exit with [CTRL-D] + (searx-pyenv) searx@ryzen:~$ pip install git+https://github.com/return42/tgwf-searx-plugins + +In the :ref:`settings.yml` activate the ``plugins:`` section and add module +``only_show_green_results`` from tgwf-searx-plugins. + +.. code:: yaml + + plugins: + - only_show_green_results + .. _git stash: https://git-scm.com/docs/git-stash .. tip:: About script's installation options have a look at chapter :ref:`toolboxing setup`. How to brand your instance see chapter :ref:`settings global`. To - *stash* your instance's setup, `git stash`_ your clone's :origin:`Makefile` - and :origin:`.config.sh` file . + *stash* your instance's setup, `git stash`_ your clone's :origin:`.config.sh` + file .