docs: generic documentation from the installation scripts

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

Makefile

@@ -60,13 +60,21 @@ run:  pyenvinstall
 # ----
 
 PHONY += docs
-docs:  pyenvinstall sphinx-doc
+
+docs:  pyenvinstall sphinx-doc prebuild-includes
 	$(call cmd,sphinx,html,docs,docs)
 
 PHONY += docs-live
-docs-live:  pyenvinstall sphinx-live
+docs-live:  pyenvinstall sphinx-live prebuild-includes
 	$(call cmd,sphinx_autobuild,html,docs,docs)
 
+prebuild-includes:
+	@mkdir -p $(DOCS_BUILD)/includes
+	@./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst
+	@./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst
+	@./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst
+
+
 $(GH_PAGES)::
 	@echo "doc available at --> $(DOCS_URL)"
 

docs/admin/index.rst

@@ -7,8 +7,12 @@ Administrator documentation
    :caption: Contents
 
    installation
+   installation-searx
+   installation-uwsgi
    installation-nginx
    installation-apache
+   installation-docker
+   update-searx
    settings
    api
    architecture

docs/admin/installation-docker.rst

@@ -0,0 +1,28 @@
+.. _installation docker:
+
+===================
+Docker installation
+===================
+
+.. contents:: Contents
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+Make sure you have installed Docker.  For instance, you can deploy searx like this:
+
+.. code:: sh
+
+    docker pull wonderfall/searx
+    docker run -d --name searx -p $PORT:8888 wonderfall/searx
+
+Go to ``http://localhost:$PORT``.
+
+See https://hub.docker.com/r/wonderfall/searx/ for more informations.  It's also
+possible to build searx from the embedded Dockerfile.
+
+.. code:: sh
+
+   git clone https://github.com/asciimoo/searx.git
+   cd searx
+   docker build -t whatever/searx .

docs/admin/installation-searx.rst

@@ -0,0 +1,85 @@
+.. _installation basic:
+
+=========================
+Step by step installation
+=========================
+
+.. contents:: Contents
+   :depth: 2
+   :local:
+   :backlinks: entry
+
+Step by step installation with virtualenv.  For Ubuntu, be sure to have enable
+universe repository.
+
+Install packages
+================
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START distro-packages
+   :end-before: END distro-packages
+
+.. hint::
+
+   This installs also the packages needed by :ref:`searx uwsgi`
+
+Create user
+===========
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START create user
+   :end-before: END create user
+
+Start a interactive shell from new created user and clone searx:
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START clone searx
+   :end-before: END clone searx
+
+In the same shell create *virtualenv*:
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START create virtualenv
+   :end-before: END create virtualenv
+
+To install searx's dependencies, exit the searx *bash* session you opened above
+and restart a new.  Before install, first check if your *virualenv* was sourced
+from the login (*~/.profile*):
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START manage.sh update_packages
+   :end-before: END manage.sh update_packages
+
+.. tip::
+
+   Open a second terminal for the configuration tasks and left the ``(searx)$``
+   terminal open for the tasks below.
+
+
+Configuration
+==============
+
+Create a copy of the :origin:`searx/settings.yml` configuration file in system's
+*/etc* folder.  Configure like shown below -- replace ``searx@\$(uname -n)`` with
+a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary.
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START searx config
+   :end-before: END searx config
+
+
+Check
+=====
+
+To check your searx setup, optional enable debugging and start the *webapp*.
+Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a
+configuration file.
+
+.. include:: ../../build/docs/includes/searx.rst
+   :start-after: START check searx installation
+   :end-before: END check searx installation
+
+If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the
+debug option in ``settings.yml``. You can now exit searx user bash (enter exit
+command twice).  At this point searx is not demonized; uwsgi allows this.
+

docs/admin/installation-uwsgi.rst

@@ -0,0 +1,82 @@
+.. _searx uwsgi:
+
+=====
+uwsgi
+=====
+
+Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this
+content:
+
+.. code:: ini
+
+   [uwsgi]
+
+   # uWSGI core
+   # ----------
+   #
+   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core
+
+   # Who will run the code
+   uid = searx
+   gid = searx
+
+   # chdir to specified directory before apps loading
+   chdir = /usr/local/searx/searx-src/searx
+
+   # disable logging for privacy
+   disable-logging = true
+
+   # The right granted on the created socket
+   chmod-socket = 666
+
+   # Plugin to use and interpretor config
+   single-interpreter = true
+
+   # enable master process
+   master = true
+
+   # load apps in each worker instead of the master
+   lazy-apps = true
+
+   # load uWSGI plugins
+   plugin = python3,http
+
+   # By default the Python plugin does not initialize the GIL.  This means your
+   # app-generated threads will not run.  If you need threads, remember to enable
+   # them with enable-threads.  Running uWSGI in multithreading mode (with the
+   # threads options) will automatically enable threading support. This *strange*
+   # default behaviour is for performance reasons.
+   enable-threads = true
+
+   # plugin: python
+   # --------------
+   #
+   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python
+
+   # load a WSGI module
+   module = searx.webapp
+
+   # set PYTHONHOME/virtualenv
+   virtualenv = /usr/local/searx/searx-pyenv
+
+   # add directory (or glob) to pythonpath
+   pythonpath = /usr/local/searx/searx-src
+
+
+   # plugin http
+   # -----------
+   #
+   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http
+
+   # Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html
+   http = 127.0.0.1:8888
+
+Activate the uwsgi application and restart:
+
+.. code:: sh
+
+    cd /etc/uwsgi/apps-enabled
+    ln -s ../apps-available/searx.ini
+    /etc/init.d/uwsgi restart
+
+

docs/admin/installation.rst

@@ -4,234 +4,63 @@
 Installation
 ============
 
-.. sidebar:: Searx server setup
+*You're spoilt for choice*, choose your preferred method of installation.
 
-   - :ref:`installation nginx`
+- :ref:`installation docker`
-   - :ref:`installation apache`
+- `Installation scripts`_
+- :ref:`installation basic`
 
-   If you do not have any special preferences, it is recommend to use
+The :ref:`installation basic` is good enough for intranet usage and it is a
-   :ref:`searx.sh`.
+excellent illustration of *how a searx instance is build up*.  If you place your
+instance public to the internet you should really consider to install a
+:ref:`filtron reverse proxy <filtron.sh>` and for privacy a :ref:`result proxy
+<morty.sh>` is mandatory.
 
-.. contents:: Contents
+Therefore, if you do not have any special preferences, its recommend to use the
-   :depth: 2
+:ref:`installation docker` or the `Installation scripts`_ from our :ref:`tooling
-   :local:
+box <toolboxing>` as described below.
-   :backlinks: entry
 
-.. _installation basic:
 
-Basic installation
+Installation scripts
-==================
+====================
 
-Step by step installation with virtualenv.  For Ubuntu, be sure to have enable
+The following will install a setup as shown in :ref:`architecture`.  First you
-universe repository.
+need to get a clone.  The clone is only needed for the installation procedure
+and some maintenance tasks (alternatively you can create your own fork).
 
-Install packages:
+.. code:: bash
 
-.. tabs::
+   $ cd ~/Download
+   $ git clone https://github.com/asciimoo/searx searx
+   $ cd searx
 
-   .. group-tab:: Ubuntu / debian
+.. hint::
 
-      .. code-block:: sh
+   The *tooling box* is not yet merged into `asciimoo/searx master
+   <https://github.com/asciimoo/searx>`_.  As long as PR is not merged, you need
+   to merge the PR into your local clone (see below).  The discussion takes
+   place in :pull:`1803`.  To merge the :pull:`1803` in your local branch use:
 
-         $ sudo -H apt-get install -m \
+   .. code:: bash
-                   git build-essential
-                   libxslt-dev python3-dev python3-babel python3-venv \
-                   zlib1g-dev libffi-dev libssl-dev
 
-Install searx:
+      $ git pull origin refs/pull/1803/head
 
-.. code:: sh
+**Install** :ref:`searx service <searx.sh>`
 
-    sudo -H useradd searx --system --disabled-password -d /usr/local/searx
+This installs searx as described in :ref:`installation basic`.
-    sudo -H usermod -a -G shadow searx
-    cd /usr/local/searx
-    sudo -H git clone https://github.com/asciimoo/searx.git searx-src
-    sudo -H chown searx:searx -R /usr/local/searx
 
-Install virtualenv:
+.. code:: bash
 
-.. code:: sh
+   $ sudo -H ./utils/searx.sh install all
 
-    sudo -H -u searx -i
+**Install** :ref:`filtron reverse proxy <filtron.sh>`
-    (searx)$ python3 -m venv searx-pyenv
-    (searx)$ echo 'source ~/searx-pyenv/bin/activate' > ~/.profile
 
-Exit the searx bash and restart a new to install the searx dependencies:
+.. code:: bash
 
-.. code:: sh
+   $ sudo -H ./utils/filtron.sh install all
 
-    sudo -H -u searx -i
+**Install** :ref:`result proxy <morty.sh>`
-    (searx)$ cd searx-src
-    (searx)$ ./manage.sh update_packages
 
-Configuration
+.. code:: bash
-==============
 
-.. code:: sh
+   $ sudo -H ./utils/morty.sh install all
-
-    sudo -H -u searx -i
-    (searx)$ cd searx-src
-    (searx)$ sed -i -e "s/ultrasecretkey/`openssl rand -hex 16`/g" searx/settings.yml
-
-Edit searx/settings.yml if necessary.
-
-Check
-=====
-
-Start searx:
-
-.. code:: sh
-
-    sudo -H -u searx -i
-    (searx)$ cd searx-src
-    (searx)$ python3 searx/webapp.py
-
-Go to http://localhost:8888
-
-If everything works fine, disable the debug option in settings.yml:
-
-.. code:: sh
-
-    sed -i -e "s/debug : True/debug : False/g" searx/settings.yml
-
-At this point searx is not demonized ; uwsgi allows this.  You can exit the
-virtualenv and the searx user bash (enter exit command twice).
-
-uwsgi
-=====
-
-Install packages:
-
-.. tabs::
-
-   .. group-tab:: Ubuntu / debian
-
-      .. code-block:: bash
-
-         sudo -H apt-get install uwsgi uwsgi-plugin-python3
-
-Create the configuration file ``/etc/uwsgi/apps-available/searx.ini`` with this
-content:
-
-.. code:: ini
-
-   [uwsgi]
-
-   # uWSGI core
-   # ----------
-   #
-   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#uwsgi-core
-
-   # Who will run the code
-   uid = searx
-   gid = searx
-
-   # chdir to specified directory before apps loading
-   chdir = /usr/local/searx/searx-src/searx
-
-   # disable logging for privacy
-   disable-logging = true
-
-   # The right granted on the created socket
-   chmod-socket = 666
-
-   # Plugin to use and interpretor config
-   single-interpreter = true
-
-   # enable master process
-   master = true
-
-   # load apps in each worker instead of the master
-   lazy-apps = true
-
-   # load uWSGI plugins
-   plugin = python3,http
-
-   # By default the Python plugin does not initialize the GIL.  This means your
-   # app-generated threads will not run.  If you need threads, remember to enable
-   # them with enable-threads.  Running uWSGI in multithreading mode (with the
-   # threads options) will automatically enable threading support. This *strange*
-   # default behaviour is for performance reasons.
-   enable-threads = true
-
-   # plugin: python
-   # --------------
-   #
-   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-python
-
-   # load a WSGI module
-   module = searx.webapp
-
-   # set PYTHONHOME/virtualenv
-   virtualenv = /usr/local/searx/searx-pyenv
-
-   # add directory (or glob) to pythonpath
-   pythonpath = /usr/local/searx/searx-src
-
-
-   # plugin http
-   # -----------
-   #
-   # https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http
-
-   # Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html
-   http = 127.0.0.1:8888
-
-Activate the uwsgi application and restart:
-
-.. code:: sh
-
-    cd /etc/uwsgi/apps-enabled
-    ln -s ../apps-available/searx.ini
-    /etc/init.d/uwsgi restart
-
-
-How to update
-=============
-
-.. code:: sh
-
-    sudo -H -u searx -i
-    (searx)$ git stash
-    (searx)$ git pull origin master
-    (searx)$ git stash apply
-    (searx)$ ./manage.sh update_packages
-
-Restart uwsgi:
-
-.. tabs::
-
-   .. group-tab:: Ubuntu / debian
-
-      .. code:: sh
-
-         sudo -H systemctl restart uwsgi
-
-Docker
-======
-
-Make sure you have installed Docker. For instance, you can deploy searx like this:
-
-.. code:: sh
-
-    docker pull wonderfall/searx
-    docker run -d --name searx -p $PORT:8888 wonderfall/searx
-
-Go to ``http://localhost:$PORT``.
-
-See https://hub.docker.com/r/wonderfall/searx/ for more informations.  It's also
-possible to build searx from the embedded Dockerfile.
-
-.. code:: sh
-
-   git clone https://github.com/asciimoo/searx.git
-   cd searx
-   docker build -t whatever/searx .
-
-References
-==========
-
-* https://about.okhin.fr/posts/Searx/ with some additions
-
-* How to: `Setup searx in a couple of hours with a free SSL certificate
-  <https://www.reddit.com/r/privacytoolsIO/comments/366kvn/how_to_setup_your_own_privacy_respecting_search/>`__

docs/admin/update-searx.rst

@@ -0,0 +1,23 @@
+.. _update searx:
+
+=============
+How to update
+=============
+
+.. code:: sh
+
+    sudo -H -u searx -i
+    (searx)$ git stash
+    (searx)$ git pull origin master
+    (searx)$ git stash apply
+    (searx)$ ./manage.sh update_packages
+
+Restart uwsgi:
+
+.. tabs::
+
+   .. group-tab:: Ubuntu / debian
+
+      .. code:: sh
+
+         sudo -H systemctl restart uwsgi

docs/utils/index.rst

@@ -1,4 +1,3 @@
-
 .. _searx_utils:
 .. _toolboxing:
 
@@ -9,14 +8,6 @@ Tooling box ``utils/*``
 In the folder :origin:`utils/` we maintain some tools useful for admins and
 developers.
 
-.. sidebar:: Work needed!
-
-   Our scripts to maintain services do most support only systemd init process
-   used by debian, ubuntu and many other dists.  In general our scripts are only
-   partially usable on debian systems.  We are working on this limitation, if
-   you have any contribution, please send us your :pull:`PR <../pulls>`, see
-   :ref:`how to contribute`.
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents

utils/filtron.sh

@@ -180,6 +180,10 @@ main() {
                 debug-off)  echo; disable_debug ;;
                 *) usage "$_usage"; exit 42;;
             esac ;;
+        doc)
+            echo
+            echo ".. generic utils/filtron.sh documentation"
+            ;;
 
         *) usage "unknown or missing command $1"; exit 42;;
     esac

utils/lib.sh

@@ -933,7 +933,9 @@ pkg_install() {
     # usage: TITEL='install foobar' pkg_install foopkg barpkg
 
     rst_title "${TITLE:-installation of packages}" section
-    echo -en "\npackage(s)::\n\n  $*\n" | $FMT
+    echo -e "\npackage(s)::\n"
+    # shellcheck disable=SC2068
+    echo "  " $@ | $FMT
 
     if ! ask_yn "Should packages be installed?" Yn 30; then
         return 42
@@ -959,7 +961,9 @@ pkg_remove() {
     # usage: TITEL='remove foobar' pkg_remove foopkg barpkg
 
     rst_title "${TITLE:-remove packages}" section
-    echo -en "\npackage(s)::\n\n  $*\n" | $FMT
+    echo -e "\npackage(s)::\n"
+    # shellcheck disable=SC2068
+    echo "  " $@ | $FMT
 
     if ! ask_yn "Should packages be removed (purge)?" Yn 30; then
         return 42

utils/lxc.sh

@@ -209,6 +209,11 @@ main() {
                 searx-suite) searx_suite_install ;;
             esac
             ;;
+        doc)
+            echo
+            echo ".. generic utils/lxc.sh documentation"
+            ;;
+
         *)
             usage "unknown or missing command $1"; exit 42;;
     esac

utils/morty.sh

@@ -183,6 +183,10 @@ main() {
                 debug-off)  disable_debug ;;
                 *) usage "$_usage"; exit 42;;
             esac ;;
+        doc)
+            echo
+            echo ".. generic utils/morty.sh documentation"
+            ;;
 
         *) usage "ERROR: unknown or missing command $1"; exit 42;;
     esac

utils/searx.sh

@@ -36,25 +36,28 @@ SEARX_UWSGI_APP="searx.ini"
 # shellcheck disable=SC2034
 SEARX_UWSGI_SOCKET="/run/uwsgi/app/searx/socket"
 
-case $DIST_ID in
+# apt packages
-    ubuntu|debian)  # apt packages
+SEARX_PACKAGES_debian="\
-        SEARX_PACKAGES="\
+python3-dev python3-babel python3-venv
- python3-dev python3-babel python3-venv \
+uwsgi uwsgi-plugin-python3
- uwsgi uwsgi-plugin-python3 \
 git build-essential libxslt-dev zlib1g-dev libffi-dev libssl-dev"
-        ;;
+
-    arch)           # pacman packages
+# pacman packages
-        SEARX_PACKAGES="\
+SEARX_PACKAGES_arch="\
- python python-pip python-lxml python-babel \
+python python-pip python-lxml python-babel
- uwsgi uwsgi-plugin-python \
+uwsgi uwsgi-plugin-python
 git base-devel libxml2"
-        ;;
+
-    fedora)          # dnf packages
+# dnf packages
-        SEARX_PACKAGES="\
+SEARX_PACKAGES_fedora="\
- python python-pip python-lxml python-babel \
+python python-pip python-lxml python-babel
- uwsgi uwsgi-plugin-python3 \
+uwsgi uwsgi-plugin-python3
 git @development-tools libxml2"
-        ;;
+
+case $DIST_ID in
+    ubuntu|debian) SEARX_PACKAGES="${SEARX_PACKAGES_debian}" ;;
+    arch) SEARX_PACKAGES="${SEARX_PACKAGES_arch}" ;;
+    fedora) SEARX_PACKAGES="${SEARX_PACKAGES_fedora}" ;;
 esac
 
 # Apache Settings
@@ -206,6 +209,7 @@ main() {
                 remove) remove_apache_site ;;
                 *) usage "$_usage"; exit 42;;
             esac ;;
+        doc) rst-doc;;
 
         *) usage "unknown or missing command $1"; exit 42;;
     esac
@@ -443,7 +447,7 @@ test_local_searx() {
     tee_stderr 0.1 <<EOF | sudo -H -u "${SERVICE_USER}" -i 2>&1 |  prefix_stdout "$_service_prefix"
 export SEARX_SETTINGS_PATH="${SEARX_SETTINGS_PATH}"
 cd ${SEARX_SRC}
-timeout 10 python3 searx/webapp.py &
+timeout 10 python searx/webapp.py &
 sleep 3
 curl --location --verbose --head --insecure $SEARX_INTERNAL_URL
 EOF
@@ -631,6 +635,178 @@ This removes apache site ${APACHE_SEARX_SITE}."
     apache_remove_site "${APACHE_SEARX_SITE}"
 }
 
+rst-doc() {
+    local debian="${SEARX_PACKAGES_debian}"
+    local arch="${SEARX_PACKAGES_arch}"
+    local fedora="${SEARX_PACKAGES_fedora}"
+    debian="$(echo "${debian}" | sed 's/.*/          & \\/' | sed '$ s/.$//')"
+    arch="$(echo "${arch}"     | sed 's/.*/          & \\/' | sed '$ s/.$//')"
+    fedora="$(echo "${fedora}" | sed 's/.*/          & \\/' | sed '$ s/.$//')"
+
+    cat <<EOF
+
+.. START distro-packages
+
+.. tabs::
+
+  .. group-tab:: Ubuntu / debian
+
+    .. code-block:: sh
+
+      $ sudo -H apt-get install -y \\
+${debian}
+
+  .. group-tab:: Arch Linux
+
+    .. code-block:: sh
+
+      $ sudo -H pacman -S --noconfirm \\
+${arch}
+
+  .. group-tab::  Fedora / RHEL
+
+    .. code-block:: sh
+
+      $ sudo -H dnf install -y \\
+${fedora}
+
+.. END distro-packages
+
+
+.. START create user
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+      $ sudo -H useradd --shell /bin/bash --system \\
+          --home-dir "$SERVICE_HOME" \\
+          --comment "Privacy-respecting metasearch engine" $SERVICE_USER
+
+      $ sudo -H mkdir "$SERVICE_HOME"
+      $ sudo -H chown -R "$SERVICE_GROUP:$SERVICE_GROUP" "$SERVICE_HOME"
+
+.. END create user
+
+.. START clone searx
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+       $ sudo -H -u ${SERVICE_USER} -i
+       (${SERVICE_USER})$ git clone "https://github.com/asciimoo/searx.git" "$SEARX_SRC"
+
+.. END clone searx
+
+.. START create virtualenv
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+       (${SERVICE_USER})$ python3 -m venv "${SEARX_PYENV}"
+       (${SERVICE_USER})$ echo ". ${SEARX_PYENV}/bin/activate" >>  "$SERVICE_HOME/.profile"
+
+.. END create virtualenv
+
+.. START manage.sh update_packages
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+       $ sudo -H -u ${SERVICE_USER} -i
+
+       (${SERVICE_USER})$ command -v python && python --version
+       $SEARX_PYENV/bin/python
+       Python 3.8.1
+
+       (${SERVICE_USER})$ cd "$SEARX_SRC"
+       (${SERVICE_USER})$ ./manage.sh update_packages
+
+.. END manage.sh update_packages
+
+.. START searx config
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+       $ sudo -H cp "$SEARX_SRC/searx/settings.yml" "${SEARX_SETTINGS_PATH}"
+       $ sudo -H sed -i -e "s/ultrasecretkey/\$(openssl rand -hex 16)/g" "$SEARX_SETTINGS_PATH"
+       $ sudo -H sed -i -e "s/{instance_name}/searx@\$(uname -n)/g" "$SEARX_SETTINGS_PATH"
+
+.. END searx config
+
+.. START check searx installation
+
+.. tabs::
+
+  .. group-tab:: bash
+
+    .. code-block:: sh
+
+       # enable debug ..
+       $ sudo -H sed -i -e "s/debug : False/debug : True/g" "$SEARX_SETTINGS_PATH"
+
+       # start webapp
+       $ sudo -H -u ${SERVICE_USER} -i
+       (${SERVICE_USER})$ cd ${SEARX_SRC}
+       (${SERVICE_USER})$ export SEARX_SETTINGS_PATH="${SEARX_SETTINGS_PATH}"
+       (${SERVICE_USER})$ python searx/webapp.py
+
+       # disable debug
+       $ sudo -H sed -i -e "s/debug : True/debug : False/g" "$SEARX_SETTINGS_PATH"
+
+Open WEB browser and visit http://$SEARX_INTERNAL_URL .  If you are inside a
+container or in a script, test with curl:
+
+.. tabs::
+
+  .. group-tab:: WEB browser
+
+    .. code-block:: sh
+
+       $ xgd-open http://$SEARX_INTERNAL_URL
+
+  .. group-tab:: curl
+
+    .. code-block:: none
+
+       $ curl --location --verbose --head --insecure $SEARX_INTERNAL_URL
+
+       *   Trying 127.0.0.1:8888...
+       * TCP_NODELAY set
+       * Connected to 127.0.0.1 (127.0.0.1) port 8888 (#0)
+       > HEAD / HTTP/1.1
+       > Host: 127.0.0.1:8888
+       > User-Agent: curl/7.68.0
+       > Accept: */*
+       >
+       * Mark bundle as not supporting multiuse
+       * HTTP 1.0, assume close after body
+       < HTTP/1.0 200 OK
+       HTTP/1.0 200 OK
+       ...
+
+.. END check searx installation
+
+EOF
+
+}
+
+
 # ----------------------------------------------------------------------------
 main "$@"
 # ----------------------------------------------------------------------------