diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2022-06-14 10:02:50 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2022-07-30 13:39:35 +0200 |
| commit | ed8a1690296cfc55f67dc0a4dac6dee06a47bd06 (patch) | |
| tree | c2d2a4c8e5369b4f9a65d12c23c2dd0cb05d58f0 /docs/admin/installation.rst | |
| parent | 782f73540e2d383ea122716507ccd9582918ab51 (diff) | |
[doc] update documentation of the installation procedures
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin/installation.rst')
| -rw-r--r-- | docs/admin/installation.rst | 100 |
1 files changed, 4 insertions, 96 deletions
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 91f82e504..f650480cb 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -14,99 +14,7 @@ Installation - :ref:`installation scripts` - :ref:`installation basic` -The :ref:`installation basic` is good enough for intranet usage and it is a -excellent illustration of *how a SearXNG instance is build up*. If you place your -instance public to the internet you should really consider to install a -:ref:`filtron reverse proxy <filtron.sh>` and for privacy a :ref:`result proxy -<morty.sh>` is mandatory. - -Therefore, if you do not have any special preferences, its recommend to use the -:ref:`installation docker` or the `Installation scripts`_ from our :ref:`tooling -box <toolboxing>` as described below. - -.. _installation scripts: - -Installation scripts -==================== - -.. sidebar:: Update OS first! - - To avoid unwanted side effects, update your OS before installing SearXNG. - -The following will install a setup as shown in :ref:`architecture`. First you -need to get a clone. The clone is only needed for the installation procedure -and some maintenance tasks (alternatively you can create your own fork). - -For the installation procedure, use a *sudoer* login to run the scripts. If you -install from ``root``, take into account that the scripts are creating a -``searx``, a ``filtron`` and a ``morty`` user. In the installation procedure -these new created users do need read access to the clone of searx, which is not -the case if you clone into a folder below ``/root``. - -.. code:: bash - - $ cd ~/Downloads - $ git clone https://github.com/searxng/searxng.git searxng - $ cd searxng - -.. sidebar:: further read - - - :ref:`toolboxing` - - :ref:`update searxng` - - :ref:`inspect searxng` - -**Install** :ref:`SearXNG service <searx.sh>` - -This installs SearXNG as described in :ref:`installation basic`. - -.. code:: bash - - $ sudo -H ./utils/searx.sh install all - -**Install** :ref:`filtron reverse proxy <filtron.sh>` - -.. code:: bash - - $ sudo -H ./utils/filtron.sh install all - -**Install** :ref:`result proxy <morty.sh>` - -.. code:: bash - - $ sudo -H ./utils/morty.sh install all - -If all services are running fine, you can add it to your HTTP server: - -**Install** HTTP - -- :ref:`installation apache` -- :ref:`installation nginx` - -**Install** :ref:`external plugins <dev plugin>` - -Use SearXNG's ``shell`` to install external plugins. In the example below we -install the SearXNG plugins from **The Green Web Foundation** `[ref] -<https://www.thegreenwebfoundation.org/news/searching-the-green-web-with-searx/>`__: - -.. code:: bash - - $ sudo -H ./utils/searx.sh shell - // exit with [CTRL-D] - (searx-pyenv) searx@ryzen:~$ pip install git+https://github.com/return42/tgwf-searx-plugins - -In the :ref:`settings.yml` activate the ``plugins:`` section and add module -``only_show_green_results`` from tgwf-searx-plugins. - -.. code:: yaml - - plugins: - - only_show_green_results - -.. _git stash: https://git-scm.com/docs/git-stash - -.. tip:: - - About script's installation options have a look at chapter :ref:`toolboxing - setup`. How to brand your instance see chapter :ref:`settings global`. To - *stash* your instance's setup, `git stash`_ your clone's :origin:`.config.sh` - file . +The :ref:`installation basic` is a excellent illustration of *how a SearXNG +instance is build up* (see :ref:`architecture uWSGI`). If you do not have any +special preferences, its recommend to use the :ref:`installation docker` or the +:ref:`installation scripts`. |