Browse Source

docs: proofreading of all the installation topics

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 5 years ago
parent
commit
ebde9d10fd

+ 8 - 6
docs/admin/architecture.rst

@@ -4,12 +4,14 @@
 Architecture
 Architecture
 ============
 ============
 
 
-.. sidebar:: Tooling box
-
-   - :ref:`searx & uwsgi <searx.sh>`
-   - :ref:`filtron <filtron.sh>`
-   - :ref:`reverse proxy`
-   - :ref:`morty <morty.sh>`
+.. sidebar:: Further reading
+
+   - 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
 Herein you will find some hints and suggestions about typical architectures of
 searx infrastructures.
 searx infrastructures.

+ 16 - 0
docs/admin/installation-apache.rst

@@ -45,6 +45,22 @@ Install with apache
    :local:
    :local:
    :backlinks: entry
    :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
 The apache HTTP server
 ======================
 ======================
 
 

+ 8 - 0
docs/admin/installation-nginx.rst

@@ -19,6 +19,14 @@ Install with nginx
 .. _SCRIPT_NAME:
 .. _SCRIPT_NAME:
    https://werkzeug.palletsprojects.com/en/1.0.x/wsgi/#werkzeug.wsgi.get_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
 .. contents:: Contents
    :depth: 2
    :depth: 2
    :local:
    :local:

+ 1 - 1
docs/admin/installation-uwsgi.rst

@@ -4,7 +4,7 @@
 uwsgi
 uwsgi
 =====
 =====
 
 
-.. sidebar:: further read
+.. sidebar:: further reading
 
 
    - `systemd.unit`_
    - `systemd.unit`_
    - `uWSGI Emperor`_
    - `uWSGI Emperor`_

+ 1 - 1
docs/admin/installation.rst

@@ -31,7 +31,7 @@ and some maintenance tasks (alternatively you can create your own fork).
 
 
 .. code:: bash
 .. code:: bash
 
 
-   $ cd ~/Download
+   $ cd ~/Downloads
    $ git clone https://github.com/asciimoo/searx searx
    $ git clone https://github.com/asciimoo/searx searx
    $ cd searx
    $ cd searx
 
 

+ 4 - 0
docs/admin/morty.rst

@@ -5,6 +5,10 @@
 How to setup result proxy
 How to setup result proxy
 =========================
 =========================
 
 
+.. sidebar:: further reading
+
+   - :ref:`morty.sh`
+
 .. _morty: https://github.com/asciimoo/morty
 .. _morty: https://github.com/asciimoo/morty
 .. _morty's README: https://github.com/asciimoo/morty
 .. _morty's README: https://github.com/asciimoo/morty
 
 

+ 2 - 29
docs/utils/filtron.sh.rst

@@ -7,9 +7,10 @@
 
 
 .. sidebar:: further reading
 .. sidebar:: further reading
 
 
-   - :ref:`installation`
    - :ref:`searx filtron`
    - :ref:`searx filtron`
    - :ref:`architecture`
    - :ref:`architecture`
+   - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
+     <installation apache>`)
 
 
 .. _Go: https://golang.org/
 .. _Go: https://golang.org/
 .. _filtron: https://github.com/asciimoo/filtron
 .. _filtron: https://github.com/asciimoo/filtron
@@ -77,31 +78,3 @@ The ``--help`` output of the script is largely self-explanatory
 (:ref:`toolboxing common`):
 (:ref:`toolboxing common`):
 
 
 .. program-output:: ../utils/filtron.sh --help
 .. 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

+ 4 - 1
docs/utils/morty.sh.rst

@@ -11,8 +11,9 @@
 
 
 .. sidebar:: further reading
 .. sidebar:: further reading
 
 
-   - :ref:`installation`
    - :ref:`architecture`
    - :ref:`architecture`
+   - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
+     <installation apache>`)
    - :ref:`searx morty`
    - :ref:`searx morty`
 
 
 To simplify installation and maintenance of a morty_ instance you can use the
 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
    :start-after: START install systemd unit
    :end-before: END install systemd unit
    :end-before: END install systemd unit
 
 
+.. _morty.sh overview:
+
 Overview
 Overview
 ========
 ========
 
 

+ 3 - 44
docs/utils/searx.sh.rst

@@ -7,9 +7,10 @@
 
 
 .. sidebar:: further reading
 .. sidebar:: further reading
 
 
-   - :ref:`installation`
    - :ref:`architecture`
    - :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
 To simplify installation and maintenance of a searx instance you can use the
 script :origin:`utils/searx.sh`.
 script :origin:`utils/searx.sh`.
@@ -36,45 +37,3 @@ The ``--help`` output of the script is largely self-explanatory
 (:ref:`toolboxing common`):
 (:ref:`toolboxing common`):
 
 
 .. program-output:: ../utils/searx.sh --help
 .. 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