summaryrefslogtreecommitdiff
path: root/docs/utils/searxng.sh.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-06-14 10:02:50 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2022-07-30 13:39:35 +0200
commited8a1690296cfc55f67dc0a4dac6dee06a47bd06 (patch)
treec2d2a4c8e5369b4f9a65d12c23c2dd0cb05d58f0 /docs/utils/searxng.sh.rst
parent782f73540e2d383ea122716507ccd9582918ab51 (diff)
[doc] update documentation of the installation procedures
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils/searxng.sh.rst')
-rw-r--r--docs/utils/searxng.sh.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/utils/searxng.sh.rst b/docs/utils/searxng.sh.rst
new file mode 100644
index 000000000..0558f22a8
--- /dev/null
+++ b/docs/utils/searxng.sh.rst
@@ -0,0 +1,36 @@
+
+.. _searxng.sh:
+
+====================
+``utils/searxng.sh``
+====================
+
+.. sidebar:: further reading
+
+ - :ref:`architecture`
+ - :ref:`installation`
+ - :ref:`installation nginx`
+ - :ref:`installation apache`
+
+To simplify installation and maintenance of a SearXNG instance you can use the
+script :origin:`utils/searxng.sh`.
+
+Install
+=======
+
+In most cases you will install SearXNG simply by running the command:
+
+.. code:: bash
+
+ sudo -H ./utils/searx.sh install all
+
+The installation is described in chapter :ref:`installation basic`.
+
+.. _searxng.sh overview:
+
+Overview
+========
+
+The ``--help`` output of the script is largely self-explanatory:
+
+.. program-output:: ../utils/searxng.sh --help