From ebde9d10fd84de74ea99385dae4d95bcf932bcf3 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Thu, 9 Apr 2020 15:04:23 +0200
Subject: [PATCH] docs: proofreading of all the installation topics

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/admin/architecture.rst        | 12 ++++----
 docs/admin/installation-apache.rst | 16 ++++++++++
 docs/admin/installation-nginx.rst  |  8 +++++
 docs/admin/installation-uwsgi.rst  |  2 +-
 docs/admin/installation.rst        |  2 +-
 docs/admin/morty.rst               |  4 +++
 docs/utils/filtron.sh.rst          | 31 ++------------------
 docs/utils/morty.sh.rst            |  5 +++-
 docs/utils/searx.sh.rst            | 47 ++----------------------------
 9 files changed, 46 insertions(+), 81 deletions(-)

diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst
index fbc3bf483..464e765eb 100644
--- a/docs/admin/architecture.rst
+++ b/docs/admin/architecture.rst
@@ -4,12 +4,14 @@
 Architecture
 ============
 
-.. sidebar:: Tooling box
+.. sidebar:: Further reading
 
-   - :ref:`searx & uwsgi <searx.sh>`
-   - :ref:`filtron <filtron.sh>`
-   - :ref:`reverse proxy`
-   - :ref:`morty <morty.sh>`
+   - Reverse Proxy: :ref:`Apache <apache searx site>` & :ref:`nginx <nginx searx
+     site>`
+   - Filtron: :ref:`searx filtron`
+   - Morty: :ref:`searx morty`
+   - uWSGI: :ref:`searx uwsgi`
+   - Searx: :ref:`installation basic`
 
 Herein you will find some hints and suggestions about typical architectures of
 searx infrastructures.
diff --git a/docs/admin/installation-apache.rst b/docs/admin/installation-apache.rst
index 0b6cc38df..217e57718 100644
--- a/docs/admin/installation-apache.rst
+++ b/docs/admin/installation-apache.rst
@@ -45,6 +45,22 @@ Install with apache
    :local:
    :backlinks: entry
 
+----
+
+**Install** :ref:`apache searx site` using :ref:`filtron.sh <filtron.sh overview>`
+
+.. code:: bash
+
+   $ sudo -H ./utils/filtron.sh apache install
+
+**Install** :ref:`apache searx site` using :ref:`morty.sh <morty.sh overview>`
+
+.. code:: bash
+
+   $ sudo -H ./utils/morty.sh apache install
+
+----
+
 The apache HTTP server
 ======================
 
diff --git a/docs/admin/installation-nginx.rst b/docs/admin/installation-nginx.rst
index b02c555f6..e62c60df6 100644
--- a/docs/admin/installation-nginx.rst
+++ b/docs/admin/installation-nginx.rst
@@ -19,6 +19,14 @@ Install with nginx
 .. _SCRIPT_NAME:
    https://werkzeug.palletsprojects.com/en/1.0.x/wsgi/#werkzeug.wsgi.get_script_name
 
+.. sidebar:: further reading
+
+   - nginx_
+   - `nginx beginners guide`_
+   - `nginx server configuration`_
+   - `Getting Started wiki`_
+   - `uWSGI support from nginx`_
+
 .. contents:: Contents
    :depth: 2
    :local:
diff --git a/docs/admin/installation-uwsgi.rst b/docs/admin/installation-uwsgi.rst
index 67a8e127a..72498c0bf 100644
--- a/docs/admin/installation-uwsgi.rst
+++ b/docs/admin/installation-uwsgi.rst
@@ -4,7 +4,7 @@
 uwsgi
 =====
 
-.. sidebar:: further read
+.. sidebar:: further reading
 
    - `systemd.unit`_
    - `uWSGI Emperor`_
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst
index 81fc4d3e2..bfc0742de 100644
--- a/docs/admin/installation.rst
+++ b/docs/admin/installation.rst
@@ -31,7 +31,7 @@ and some maintenance tasks (alternatively you can create your own fork).
 
 .. code:: bash
 
-   $ cd ~/Download
+   $ cd ~/Downloads
    $ git clone https://github.com/asciimoo/searx searx
    $ cd searx
 
diff --git a/docs/admin/morty.rst b/docs/admin/morty.rst
index 48ff5b9c4..2858fde3c 100644
--- a/docs/admin/morty.rst
+++ b/docs/admin/morty.rst
@@ -5,6 +5,10 @@
 How to setup result proxy
 =========================
 
+.. sidebar:: further reading
+
+   - :ref:`morty.sh`
+
 .. _morty: https://github.com/asciimoo/morty
 .. _morty's README: https://github.com/asciimoo/morty
 
diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst
index a3c1aed41..6c83bdf78 100644
--- a/docs/utils/filtron.sh.rst
+++ b/docs/utils/filtron.sh.rst
@@ -7,9 +7,10 @@
 
 .. sidebar:: further reading
 
-   - :ref:`installation`
    - :ref:`searx filtron`
    - :ref:`architecture`
+   - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
+     <installation apache>`)
 
 .. _Go: https://golang.org/
 .. _filtron: https://github.com/asciimoo/filtron
@@ -77,31 +78,3 @@ The ``--help`` output of the script is largely self-explanatory
 (:ref:`toolboxing common`):
 
 .. program-output:: ../utils/filtron.sh --help
-
-.. _reverse proxy:
-
-Public Reverse Proxy
-====================
-
-To install searx in your public HTTP server use:
-
-.. code::  bash
-
-   sudo -H ./utils/filtron.sh apache install
-
-.. tabs::
-
-   .. group-tab:: apache
-
-      .. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:filtron
-	 :language: apache
-
-      .. tabs::
-
-	 .. group-tab:: Ubuntu / debian
-
-	       .. code-block:: sh
-
-		  $ sudo -H a2enmod headers
-		  $ sudo -H a2enmod proxy
-		  $ sudo -H a2enmod proxy_http
diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst
index 34f0c9b5e..89629bea0 100644
--- a/docs/utils/morty.sh.rst
+++ b/docs/utils/morty.sh.rst
@@ -11,8 +11,9 @@
 
 .. sidebar:: further reading
 
-   - :ref:`installation`
    - :ref:`architecture`
+   - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
+     <installation apache>`)
    - :ref:`searx morty`
 
 To simplify installation and maintenance of a morty_ instance you can use the
@@ -67,6 +68,8 @@ Install morty software and systemd unit:
    :start-after: START install systemd unit
    :end-before: END install systemd unit
 
+.. _morty.sh overview:
+
 Overview
 ========
 
diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst
index 905f765dd..dd4442f94 100644
--- a/docs/utils/searx.sh.rst
+++ b/docs/utils/searx.sh.rst
@@ -7,9 +7,10 @@
 
 .. sidebar:: further reading
 
-   - :ref:`installation`
    - :ref:`architecture`
-   - :ref:`filtron.sh`
+   - :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`.
@@ -36,45 +37,3 @@ The ``--help`` output of the script is largely self-explanatory
 (:ref:`toolboxing common`):
 
 .. program-output:: ../utils/searx.sh --help
-
-
-Intranet Reverse Proxy
-======================
-
-.. warning::
-
-   This setup is **not** suitable **for public instances**, go on with
-   :ref:`reverse proxy`!
-
-To install searx in your intranet HTTP server use:
-
-.. code::  bash
-
-   sudo -H ./utils/searx.sh apache install
-
-.. tabs::
-
-   .. group-tab:: apache
-
-      .. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:uwsgi
-         :language: apache
-
-      .. tabs::
-
-         .. group-tab:: Ubuntu / debian
-
-            .. code-block:: sh
-
-               $ sudo -H apt install libapache2-mod-uwsgi
-
-         .. group-tab:: Arch Linux
-
-            .. code-block:: sh
-
-               $ sudo -H pacman -S uwsgi
-
-         .. group-tab:: Fedora / RHEL
-
-            .. code-block:: sh
-
-               $ sudo -H dnf install uwsgi