summaryrefslogtreecommitdiff
path: root/docs/utils/searx.sh.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2020-06-19 04:50:36 +0000
committerGitHub <noreply@github.com>2020-06-19 04:50:36 +0000
commit6337d515dd11d2014a775b67103eda51c7fc38e2 (patch)
treefdd3f1e67a8e08d28b137348834aa6c72e4513ab /docs/utils/searx.sh.rst
parent5dd235463a11bec2e3546e89f2b31d2a5aa40326 (diff)
parentc83007a6bcd2a7f765e7655b91cc6714fbc4ab01 (diff)
Merge branch 'master' into new-readme
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