From 6fbffe9d208e3fc267eef4c421ba1810d6292cb0 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 16 Jun 2022 18:54:24 +0200 Subject: [PATCH] [docs] add section "Migrate and stay tuned!" Signed-off-by: Markus Heiser --- docs/admin/index.rst | 1 - docs/admin/installation-switch2ng.rst | 79 --------------------------- docs/admin/installation.rst | 10 ++-- docs/admin/update-searxng.rst | 76 ++++++++++++++++++++++++++ 4 files changed, 82 insertions(+), 84 deletions(-) delete mode 100644 docs/admin/installation-switch2ng.rst diff --git a/docs/admin/index.rst b/docs/admin/index.rst index 17a758885..705167306 100644 --- a/docs/admin/index.rst +++ b/docs/admin/index.rst @@ -13,7 +13,6 @@ Administrator documentation installation-uwsgi installation-nginx installation-apache - installation-switch2ng update-searxng engines/index api diff --git a/docs/admin/installation-switch2ng.rst b/docs/admin/installation-switch2ng.rst deleted file mode 100644 index 0e25b960a..000000000 --- a/docs/admin/installation-switch2ng.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _installation switch2ng: - -============================ -Switch from searx to SearXNG -============================ - -.. sidebar:: info - - - :pull:`456` - - :pull:`A comment about rolling release <446#issuecomment-954730358>` - -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - -If you have a searx installation on your sever and want to switch to SearXNG, -you need to uninstall searx first. If you have an old searx docker installation -replace your docker image / see :ref:`installation docker`. - -If your searx instance was installed *"Step by step"* or by the *"Installation -scripts"*, you need to undo the installation procedure completely. If you have -morty & filtron installed, it is recommended to uninstall these services also. -In case of scripts, to uninstall use the scripts from the origin you installed -searx from or try:: - - $ sudo -H ./utils/filtron.sh remve all - $ sudo -H ./utils/morty.sh remve all - $ sudo -H ./utils/searx.sh remve all - -If you have removed the old searx installation, clone from SearXNG and and start -with your installation procedure (e.g. :ref:`installation scripts`): - -.. code:: bash - - $ cd ~/Downloads - $ git clone https://github.com/searxng/searxng.git searxng - $ cd searxng - $ ... - -``.config.sh`` -============== - -Please take into account; SearXNG has normalized ``.config.sh`` with -``settings.yml`` and some of the environment settings has been removed from or -renamed in the ``.config.sh``: - -- :patch:`[mod] normalize .config.sh with settings.yml ` -- :patch:`[fix] ./utils/filtron.sh - FILTRON_TARGET from YAML settings <7196a9b5>` -- :patch:`SearXNG: SEARXNG_SETTINGS_PATH <253b8503>` - - -Check after Installation -======================== - -Once you have done your installation, you can run a SearXNG *check* procedure, -to see if there are some left overs. In this example there exists a *old* -``/etc/searx/settings.yml``:: - - $ sudo -H ./utils/searxng.sh instance check - - ============================ - SearXNG (check installation) - ============================ - ERROR: settings.yml in /etc/searx/ is deprecated, move file to folder /etc/searxng/ - INFO: SearXNG instance already installed at: /usr/local/searx/searx-src - ... - INFO: Service account searx exists. - INFO: ~searx: python environment is available. - INFO: ~searx: SearXNG software is installed. - INFO: uWSGI app searxng.ini is enabled. - INFO searx : merge the default settings ( /usr/local/searx/searx-src/searx/settings.yml ) and the user setttings ( /etc/searxng/settings.yml ) - INFO searx : max_request_timeout=None - - -To *check* the filtron & morty installations, use similar commands:: - - $ sudo -H /utils/filtron.sh install check - $ sudo -H /utils/morty.sh install check 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! diff --git a/docs/admin/update-searxng.rst b/docs/admin/update-searxng.rst index 24bdf4f5f..4eba7633c 100644 --- a/docs/admin/update-searxng.rst +++ b/docs/admin/update-searxng.rst @@ -37,3 +37,79 @@ script. .. code:: sh sudo -H ./utils/searxng.sh instance inspect + +.. _migrate and stay tuned: + +Migrate and stay tuned! +======================= + +.. sidebar:: info + + - :pull:`1332` + - :pull:`456` + - :pull:`A comment about rolling release <446#issuecomment-954730358>` + +SearXNG is a *rolling release*; each commit to the master branch is a release. +SearXNG is growing rapidly, the services and opportunities are change every now +and then, to name just a few: + +- Bot protection has been switched from filtron to SearXNG's :ref:`limiter + `, this requires a :ref:`Redis ` database. + +- The image proxy morty is no longer needed, it has been replaced by the + :ref:`image proxy ` from SearXNG. + +- To save bandwith :ref:`cache busting ` has been implemented. + To get in use, the ``static-expires`` needs to be set in the :ref:`uwsgi + setup`. + +To stay tuned and get in use of the new features, instance maintainers have to +update the SearXNG code regularly (see :ref:`update searxng`). As the above +examples show, this is not always enough, sometimes services have to be set up +or reconfigured and sometimes services that are no longer needed should be +uninstalled. + +.. hint:: + + First of all: SearXNG is installed by the script :ref:`searxng.sh`. If you + have old filtron, morty or searx setup you should consider complete + uninstall/reinstall. + + +remove obsolete services +------------------------ + +If your searx instance was installed *"Step by step"* or by the *"Installation +scripts"*, you need to undo the installation procedure completely. If you have +morty & filtron installed, it is recommended to uninstall these services also. +In case of scripts, to uninstall use the scripts from the origin you installed +searx from or try:: + + $ sudo -H ./utils/filtron.sh remove all + $ sudo -H ./utils/morty.sh remove all + $ sudo -H ./utils/searx.sh remove all + +.. hint:: + + If you are migrate from searx take into account that the ``.config.sh`` is no + longer used. + + +Check after Installation +------------------------ + +Once you have done your installation, you can run a SearXNG *check* procedure, +to see if there are some left overs. In this example there exists a *old* +``/etc/searx/settings.yml``:: + + $ sudo -H ./utils/searxng.sh instance check + + SearXNG checks + -------------- + ERROR: settings.yml in /etc/searx/ is deprecated, move file to folder /etc/searxng/ + INFO: [OK] (old) account 'searx' does not exists + INFO: [OK] (old) account 'filtron' does not exists + INFO: [OK] (old) account 'morty' does not exists + ... + INFO searx.shared : Use shared_simple implementation + INFO searx.shared.redis : connected redis DB --> default