summaryrefslogtreecommitdiff
path: root/docs/utils
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-02-04 16:42:13 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2020-02-04 16:42:13 +0100
commiteedd63ccd504099836d9f528d02daffa6bc826ad (patch)
treef51e0ddbcaaa3c97303625ff597f74eb07457ffb /docs/utils
parenta5eefea61d8a2287a0065f79cbe12d4e415be743 (diff)
downloadsearxng-eedd63ccd504099836d9f528d02daffa6bc826ad.tar.gz
searxng-eedd63ccd504099836d9f528d02daffa6bc826ad.zip
docs: revision of the installation instructions
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils')
-rw-r--r--docs/utils/filtron.sh.rst3
-rw-r--r--docs/utils/index.rst19
-rw-r--r--docs/utils/morty.sh.rst1
-rw-r--r--docs/utils/searx.sh.rst19
4 files changed, 24 insertions, 18 deletions
diff --git a/docs/utils/filtron.sh.rst b/docs/utils/filtron.sh.rst
index 356359753..1bba1b3e4 100644
--- a/docs/utils/filtron.sh.rst
+++ b/docs/utils/filtron.sh.rst
@@ -7,6 +7,7 @@
.. sidebar:: further reading
+ - :ref:`installation`
- :ref:`searx_filtron`
- :ref:`architecture`
@@ -40,8 +41,6 @@ into this user account:
Public Reverse Proxy
====================
-.. tabs::
-
To install searx in your public HTTP server use:
.. code:: bash
diff --git a/docs/utils/index.rst b/docs/utils/index.rst
index 9905d755f..97e2c875f 100644
--- a/docs/utils/index.rst
+++ b/docs/utils/index.rst
@@ -6,24 +6,25 @@
Tooling box ``utils/*``
=======================
+.. 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`.
+
In the folder :origin:`utils/` we maintain some tools useful for admins and
developers.
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
+ :caption: Contents
searx.sh
filtron.sh
morty.sh
-.. admonition:: 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`.
-
.. _toolboxing common:
Common commands
diff --git a/docs/utils/morty.sh.rst b/docs/utils/morty.sh.rst
index 988b16935..9997ffec5 100644
--- a/docs/utils/morty.sh.rst
+++ b/docs/utils/morty.sh.rst
@@ -10,6 +10,7 @@
.. sidebar:: further reading
+ - :ref:`installation`
- :ref:`architecture`
To simplify installation and maintenance of a morty_ instance you can use the
diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst
index 1e3f954bb..988c08438 100644
--- a/docs/utils/searx.sh.rst
+++ b/docs/utils/searx.sh.rst
@@ -9,10 +9,15 @@
- :ref:`installation`
- :ref:`architecture`
+ - :ref:`filtron.sh`
To simplify installation and maintenance of a searx instance you can use the
-script :origin:`utils/searx.sh`. In most cases you will install searx simply by
-running the command:
+script :origin:`utils/searx.sh`.
+
+Install
+=======
+
+In most cases you will install searx simply by running the command:
.. code:: bash
@@ -27,17 +32,17 @@ into this user account. The installation is described in chapter
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
+.. warning::
+
+ This setup is **not** suitable **for public instances**, go on with
+ :ref:`reverse proxy`!
+
.. tabs::
.. group-tab:: apache