[doc] build from commit b876d0bed0

_sources/utils/index.rst.txt

@@ -0,0 +1,30 @@
+.. _searx_utils:
+.. _toolboxing:
+
+==================
+DevOps tooling box
+==================
+
+In the folder :origin:`utils/` we maintain some tools useful for administrators
+and developers.
+
+.. toctree::
+   :maxdepth: 2
+
+   searxng.sh
+
+
+Common command environments
+===========================
+
+The scripts in our tooling box often dispose of common environments:
+
+.. _FORCE_TIMEOUT:
+
+``FORCE_TIMEOUT`` : environment
+  Sets timeout for interactive prompts. If you want to run a script in batch
+  job, with defaults choices, set ``FORCE_TIMEOUT=0``.  By example; to install a
+  SearXNG server and nginx proxy use::
+
+    $ FORCE_TIMEOUT=0 ./utils/searxng.sh install all
+    $ FORCE_TIMEOUT=0 ./utils/searxng.sh install nginx

_sources/utils/searxng.sh.rst.txt

@@ -0,0 +1,42 @@
+
+.. _searxng.sh:
+
+====================
+``utils/searxng.sh``
+====================
+
+To simplify the installation and maintenance of a SearXNG instance you can use the
+script :origin:`utils/searxng.sh`.
+
+.. sidebar:: further reading
+
+   - :ref:`architecture`
+   - :ref:`installation`
+   - :ref:`installation nginx`
+   - :ref:`installation apache`
+
+.. contents::
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+
+Install
+=======
+
+In most cases you will install SearXNG simply by running the command:
+
+.. code::  bash
+
+   sudo -H ./utils/searxng.sh install all
+
+The installation is described in chapter :ref:`installation basic`.
+
+.. _searxng.sh overview:
+
+Command Help
+============
+
+The ``--help`` output of the script is largely self-explanatory:
+
+.. program-output:: ../utils/searxng.sh --help