diff options
author | Markus Heiser <markus.heiser@darmarit.de> | 2020-02-04 13:13:17 +0100 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarit.de> | 2020-02-04 13:13:17 +0100 |
commit | 9278f0fb45bab21247085a709c0e4bef743752db (patch) | |
tree | 7d3e3fb057f767ed10ded7c1487bdb4d6c0b6d71 /docs/utils/searx.sh.rst | |
parent | 8ca86f46d3dfd81a69d2c2d1515bb163f327826c (diff) | |
download | searxng-9278f0fb45bab21247085a709c0e4bef743752db.tar.gz searxng-9278f0fb45bab21247085a709c0e4bef743752db.zip |
docs: add some documentation about the tooling box ./utils/*
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/utils/searx.sh.rst')
-rw-r--r-- | docs/utils/searx.sh.rst | 53 |
1 files changed, 50 insertions, 3 deletions
diff --git a/docs/utils/searx.sh.rst b/docs/utils/searx.sh.rst index fb606c0b0..1e3f954bb 100644 --- a/docs/utils/searx.sh.rst +++ b/docs/utils/searx.sh.rst @@ -5,6 +5,11 @@ ``utils/searx.sh`` ================== +.. sidebar:: further reading + + - :ref:`installation` + - :ref:`architecture` + 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: @@ -14,8 +19,50 @@ running the command: sudo -H ./utils/searx.sh install all The script adds a ``${SERVICE_USER}`` (default:``searx``) and installs searx -into this user account. The ``--help`` output of the script is largely -self-explanatory: +into this user account. The installation is described in chapter +:ref:`installation basic`. -.. program-output:: ../utils/searx.sh --help +.. _intranet reverse proxy: + +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 pacman -S uwsgi + +Overview +======== + +The ``--help`` output of the script is largely self-explanatory +(:ref:`toolboxing common`): + +.. program-output:: ../utils/searx.sh --help |