summaryrefslogtreecommitdiff
path: root/docs/utils/searx.sh.rst
diff options
context:
space:
mode:
authorNoémi Ványi <kvch@users.noreply.github.com>2020-06-28 20:28:12 +0200
committerGitHub <noreply@github.com>2020-06-28 20:28:12 +0200
commit93cbd85b8a5becdf69e6d70dd7c60f7122531262 (patch)
tree90d202af89e02fc3e83d5bdf4a924b05ff197261 /docs/utils/searx.sh.rst
parent385e9b5c9e2d1caa73f99dac0bf1be1c46505121 (diff)
parentf9f5974968ce767c24eea8c8a651d0e3945fc01b (diff)
Merge branch 'master' into duckduckgo_correction
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