summaryrefslogtreecommitdiff
path: root/docs/utils/searx.sh.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/utils/searx.sh.rst')
-rw-r--r--docs/utils/searx.sh.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst
new file mode 100644
index 000000000..fb606c0b0
--- /dev/null
+++ b/docs/utils/searx.sh.rst
@@ -0,0 +1,21 @@
+
+.. _searx.sh:
+
+==================
+``utils/searx.sh``
+==================
+
+To simplify installation and maintenance of a searx instance you can use the
+script :origin:`utils/searx.sh`. 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 ``--help`` output of the script is largely
+self-explanatory:
+
+.. program-output:: ../utils/searx.sh --help
+