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/update-searxng.rst | 60 +++++++++++++++---------------------------- 1 file changed, 20 insertions(+), 40 deletions(-) (limited to 'docs/admin/update-searxng.rst') diff --git a/docs/admin/update-searxng.rst b/docs/admin/update-searxng.rst index 4c541bf57..24bdf4f5f 100644 --- a/docs/admin/update-searxng.rst +++ b/docs/admin/update-searxng.rst @@ -1,59 +1,39 @@ -.. _update searxng: +=================== +SearXNG maintenance +=================== -============= -How to update -============= +.. sidebar:: further read -How to update depends on the :ref:`installation` method. If you have used the -:ref:`installation scripts`, use ``update`` command from the scripts. + - :ref:`toolboxing` + - :ref:`uWSGI maintenance` -**Update** :ref:`SearXNG service ` +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry -.. code:: sh +.. _update searxng: - sudo -H ./utils/searx.sh update searx +How to update +============= -**Update** :ref:`filtron reverse proxy ` +How to update depends on the :ref:`installation` method. If you have used the +:ref:`installation scripts`, use ``update`` command from the :ref:`searxng.sh` +script. .. code:: sh - sudo -H ./utils/filtron.sh update filtron - -**Update** :ref:`result proxy ` - -.. code:: bash - - $ sudo -H ./utils/morty.sh update morty + sudo -H ./utils/searxng.sh instance update .. _inspect searxng: -====================== How to inspect & debug ====================== -.. sidebar:: further read - - - :ref:`toolboxing` - - :ref:`Makefile` - How to debug depends on the :ref:`installation` method. If you have used the -:ref:`installation scripts`, use ``inspect`` command from the scripts. - -**Inspect** :ref:`SearXNG service ` - -.. code:: sh - - sudo -H ./utils/searx.sh inspect service - -**Inspect** :ref:`filtron reverse proxy ` +:ref:`installation scripts`, use ``inspect`` command from the :ref:`searxng.sh` +script. .. code:: sh - sudo -H ./utils/filtron.sh inspect service - -**Inspect** :ref:`result proxy ` - -.. code:: bash - - $ sudo -H ./utils/morty.sh inspect service - + sudo -H ./utils/searxng.sh instance inspect -- 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/update-searxng.rst | 76 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) (limited to 'docs/admin/update-searxng.rst') 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 -- 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/update-searxng.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/admin/update-searxng.rst') diff --git a/docs/admin/update-searxng.rst b/docs/admin/update-searxng.rst index 4eba7633c..15735b0ba 100644 --- a/docs/admin/update-searxng.rst +++ b/docs/admin/update-searxng.rst @@ -18,7 +18,7 @@ How to update ============= How to update depends on the :ref:`installation` method. If you have used the -:ref:`installation scripts`, use ``update`` command from the :ref:`searxng.sh` +:ref:`installation scripts`, use the ``update`` command from the :ref:`searxng.sh` script. .. code:: sh @@ -31,7 +31,7 @@ How to inspect & debug ====================== How to debug depends on the :ref:`installation` method. If you have used the -:ref:`installation scripts`, use ``inspect`` command from the :ref:`searxng.sh` +:ref:`installation scripts`, use the ``inspect`` command from the :ref:`searxng.sh` script. .. code:: sh -- cgit v1.2.3