git.iko.soy/searx
on master help sign in
docs: proofreading of all the installation topics

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

commitebde9d10fd84de74ea99385dae4d95bcf932bcf3 authorMarkus Heiser <markus.heiser@darmarit.de> dateThu 9 Apr 2020, 15:04 (7 years ago) parent44edc92
9 files changed+47−82
compare with master
unifiedsplit
docs/admin/architecture.rst+8−6 docs/admin/installation-apache.rst+16 docs/admin/installation-nginx.rst+8 docs/admin/installation-uwsgi.rst+1−1 docs/admin/installation.rst+1−1 docs/admin/morty.rst+4 docs/utils/filtron.sh.rst+2−29 docs/utils/morty.sh.rst+4−1 docs/utils/searx.sh.rst+3−44
docs/admin/architecture.rst+8−6
@@ -4,12 +4,14 @@
44Architecture
55============
66
7−.. sidebar:: Tooling box
8−
9− - :ref:`searx & uwsgi <searx.sh>`
10− - :ref:`filtron <filtron.sh>`
11− - :ref:`reverse proxy`
12− - :ref:`morty <morty.sh>`
7+.. sidebar:: Further reading
8+
9+ - Reverse Proxy: :ref:`Apache <apache searx site>` & :ref:`nginx <nginx searx
10+ site>`
11+ - Filtron: :ref:`searx filtron`
12+ - Morty: :ref:`searx morty`
13+ - uWSGI: :ref:`searx uwsgi`
14+ - Searx: :ref:`installation basic`
1315
1416Herein you will find some hints and suggestions about typical architectures of
1517searx infrastructures.
docs/admin/installation-apache.rst+16
@@ -45,6 +45,22 @@ Install with apache
4545 :local:
4646 :backlinks: entry
4747
48+----
49+
50+**Install** :ref:`apache searx site` using :ref:`filtron.sh <filtron.sh overview>`
51+
52+.. code:: bash
53+
54+ $ sudo -H ./utils/filtron.sh apache install
55+
56+**Install** :ref:`apache searx site` using :ref:`morty.sh <morty.sh overview>`
57+
58+.. code:: bash
59+
60+ $ sudo -H ./utils/morty.sh apache install
61+
62+----
63+
4864The apache HTTP server
4965======================
5066
docs/admin/installation-nginx.rst+8
@@ -19,6 +19,14 @@ Install with nginx
1919.. _SCRIPT_NAME:
2020 https://werkzeug.palletsprojects.com/en/1.0.x/wsgi/#werkzeug.wsgi.get_script_name
2121
22+.. sidebar:: further reading
23+
24+ - nginx_
25+ - `nginx beginners guide`_
26+ - `nginx server configuration`_
27+ - `Getting Started wiki`_
28+ - `uWSGI support from nginx`_
29+
2230.. contents:: Contents
2331 :depth: 2
2432 :local:
docs/admin/installation-uwsgi.rst+1−1
@@ -4,7 +4,7 @@
44uwsgi
55=====
66
7−.. sidebar:: further read
7+.. sidebar:: further reading
88
99 - `systemd.unit`_
1010 - `uWSGI Emperor`_
docs/admin/installation.rst+1−1
@@ -31,7 +31,7 @@ and some maintenance tasks (alternatively you can create your own fork).
3131
3232.. code:: bash
3333
34− $ cd ~/Download
34+ $ cd ~/Downloads
3535 $ git clone https://github.com/asciimoo/searx searx
3636 $ cd searx
3737
docs/admin/morty.rst+4
@@ -5,6 +5,10 @@
55How to setup result proxy
66=========================
77
8+.. sidebar:: further reading
9+
10+ - :ref:`morty.sh`
11+
812.. _morty: https://github.com/asciimoo/morty
913.. _morty's README: https://github.com/asciimoo/morty
1014
docs/utils/filtron.sh.rst+2−29
@@ -7,9 +7,10 @@
77
88.. sidebar:: further reading
99
10− - :ref:`installation`
1110 - :ref:`searx filtron`
1211 - :ref:`architecture`
12+ - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
13+ <installation apache>`)
1314
1415.. _Go: https://golang.org/
1516.. _filtron: https://github.com/asciimoo/filtron
@@ -77,31 +78,3 @@ The ``--help`` output of the script is largely self-explanatory
7778(:ref:`toolboxing common`):
7879
7980.. program-output:: ../utils/filtron.sh --help
80−
81−.. _reverse proxy:
82−
83−Public Reverse Proxy
84−====================
85−
86−To install searx in your public HTTP server use:
87−
88−.. code:: bash
89−
90− sudo -H ./utils/filtron.sh apache install
91−
92−.. tabs::
93−
94− .. group-tab:: apache
95−
96− .. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:filtron
97− :language: apache
98−
99− .. tabs::
100−
101− .. group-tab:: Ubuntu / debian
102−
103− .. code-block:: sh
104−
105− $ sudo -H a2enmod headers
106− $ sudo -H a2enmod proxy
107− $ sudo -H a2enmod proxy_http
docs/utils/morty.sh.rst+4−1
@@ -11,8 +11,9 @@
1111
1212.. sidebar:: further reading
1313
14− - :ref:`installation`
1514 - :ref:`architecture`
15+ - :ref:`installation` (:ref:`nginx <installation nginx>` & :ref:`apache
16+ <installation apache>`)
1617 - :ref:`searx morty`
1718
1819To simplify installation and maintenance of a morty_ instance you can use the
@@ -67,6 +68,8 @@ Install morty software and systemd unit:
6768 :start-after: START install systemd unit
6869 :end-before: END install systemd unit
6970
71+.. _morty.sh overview:
72+
7073Overview
7174========
7275
docs/utils/searx.sh.rst+3−44
@@ -7,9 +7,10 @@
77
88.. sidebar:: further reading
99
10− - :ref:`installation`
1110 - :ref:`architecture`
12− - :ref:`filtron.sh`
11+ - :ref:`installation`
12+ - :ref:`installation nginx`
13+ - :ref:`installation apache`
1314
1415To simplify installation and maintenance of a searx instance you can use the
1516script :origin:`utils/searx.sh`.
@@ -36,45 +37,3 @@ The ``--help`` output of the script is largely self-explanatory
3637(:ref:`toolboxing common`):
3738
3839.. program-output:: ../utils/searx.sh --help
39−
40−
41−Intranet Reverse Proxy
42−======================
43−
44−.. warning::
45−
46− This setup is **not** suitable **for public instances**, go on with
47− :ref:`reverse proxy`!
48−
49−To install searx in your intranet HTTP server use:
50−
51−.. code:: bash
52−
53− sudo -H ./utils/searx.sh apache install
54−
55−.. tabs::
56−
57− .. group-tab:: apache
58−
59− .. literalinclude:: ../../utils/templates/etc/apache2/sites-available/searx.conf:uwsgi
60− :language: apache
61−
62− .. tabs::
63−
64− .. group-tab:: Ubuntu / debian
65−
66− .. code-block:: sh
67−
68− $ sudo -H apt install libapache2-mod-uwsgi
69−
70− .. group-tab:: Arch Linux
71−
72− .. code-block:: sh
73−
74− $ sudo -H pacman -S uwsgi
75−
76− .. group-tab:: Fedora / RHEL
77−
78− .. code-block:: sh
79−
80− $ sudo -H dnf install uwsgi