From ed8a1690296cfc55f67dc0a4dac6dee06a47bd06 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 14 Jun 2022 10:02:50 +0200 Subject: [doc] update documentation of the installation procedures Signed-off-by: Markus Heiser --- docs/admin/installation.rst | 100 ++------------------------------------------ 1 file changed, 4 insertions(+), 96 deletions(-) (limited to 'docs/admin/installation.rst') 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 ` and for privacy a :ref:`result proxy -` 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 ` 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 ` - -This installs SearXNG as described in :ref:`installation basic`. - -.. code:: bash - - $ sudo -H ./utils/searx.sh install all - -**Install** :ref:`filtron reverse proxy ` - -.. code:: bash - - $ sudo -H ./utils/filtron.sh install all - -**Install** :ref:`result proxy ` - -.. 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 ` - -Use SearXNG's ``shell`` to install external plugins. In the example below we -install the SearXNG plugins from **The Green Web Foundation** `[ref] -`__: - -.. 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`. -- cgit v1.2.3 From 6fbffe9d208e3fc267eef4c421ba1810d6292cb0 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 16 Jun 2022 18:54:24 +0200 Subject: [docs] add section "Migrate and stay tuned!" Signed-off-by: Markus Heiser --- docs/admin/installation.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'docs/admin/installation.rst') diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index f650480cb..8b2b4b3e5 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -4,10 +4,6 @@ Installation ============ -.. sidebar:: info - - :ref:`installation switch2ng` - *You're spoilt for choice*, choose your preferred method of installation. - :ref:`installation docker` @@ -18,3 +14,9 @@ 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`. + +.. attention:: + + SearXNG is growing rapidly, you should regularly read our :ref:`migrate and + stay tuned` section. If you want to upgrade an existing instance or migrate + from searx to SearXNG, you should read this section first! -- cgit v1.2.3 From e5323b8aa285d61bf011bbe7ca8f02818f19ed79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9on=20Tiek=C3=B6tter?= Date: Tue, 21 Jun 2022 14:48:46 +0200 Subject: [docs] corrections from @tiekoetter's review --- docs/admin/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/admin/installation.rst') diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 8b2b4b3e5..cae51be63 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -10,7 +10,7 @@ Installation - :ref:`installation scripts` - :ref:`installation basic` -The :ref:`installation basic` is a excellent illustration of *how a SearXNG +The :ref:`installation basic` is an 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`. -- cgit v1.2.3