summaryrefslogtreecommitdiff
path: root/docs/utils/searx.sh.rst
diff options
context:
space:
mode:
authorAdam Tauber <asciimoo@gmail.com>2020-06-18 19:34:32 +0200
committerGitHub <noreply@github.com>2020-06-18 19:34:32 +0200
commit4a8a16559af18ab38d796aad303a827c8c640fa2 (patch)
tree3e056ebdc13610fa4e6a4f73ac9d0d044f10ba78 /docs/utils/searx.sh.rst
parent0dc5bdb6ef602d00456eb1db96d45e2f42b2b7a4 (diff)
parent0616684baa58b86cac5df6546432d4372f965fe2 (diff)
Merge pull request #1803 from return42/filtron
Tooling Box to setup & maintain searx instances and services.
Diffstat (limited to 'docs/utils/searx.sh.rst')
-rw-r--r--docs/utils/searx.sh.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst
new file mode 100644
index 000000000..dd4442f94
--- /dev/null
+++ b/docs/utils/searx.sh.rst
@@ -0,0 +1,39 @@
+
+.. _searx.sh:
+
+==================
+``utils/searx.sh``
+==================
+
+.. sidebar:: further reading
+
+ - :ref:`architecture`
+ - :ref:`installation`
+ - :ref:`installation nginx`
+ - :ref:`installation apache`
+
+To simplify installation and maintenance of a searx instance you can use the
+script :origin:`utils/searx.sh`.
+
+Install
+=======
+
+In most cases you will install searx simply by running the command:
+
+.. code:: bash
+
+ sudo -H ./utils/searx.sh install all
+
+The script adds a ``${SERVICE_USER}`` (default:``searx``) and installs searx
+into this user account. The installation is described in chapter
+:ref:`installation basic`.
+
+.. _intranet reverse proxy:
+
+Overview
+========
+
+The ``--help`` output of the script is largely self-explanatory
+(:ref:`toolboxing common`):
+
+.. program-output:: ../utils/searx.sh --help