diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 8a066dec..9bb102c4 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -39,13 +39,18 @@ install from ``root``, take into account that the scripts are creating a 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/searx/searx searx $ cd searx +.. sidebar:: further read + + - :ref:`toolboxing` + - :ref:`update searx` + - :ref:`inspect searx` + **Install** :ref:`searx service ` This installs searx as described in :ref:`installation basic`. diff --git a/docs/admin/update-searx.rst b/docs/admin/update-searx.rst index c74c9568..a87f27ed 100644 --- a/docs/admin/update-searx.rst +++ b/docs/admin/update-searx.rst @@ -4,20 +4,56 @@ 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 scripts. + +**Update** :ref:`searx service ` + .. code:: sh - sudo -H -u searx -i - (searx)$ git stash - (searx)$ git pull origin master - (searx)$ git stash apply - (searx)$ ./manage.sh update_packages + sudo -H ./utils/searx.sh update searx -Restart uwsgi: +**Update** :ref:`filtron reverse proxy ` -.. tabs:: +.. code:: sh - .. group-tab:: Ubuntu / debian + sudo -H ./utils/filtron.sh update filtron - .. code:: sh +**Update** :ref:`result proxy ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh update morty + +.. _inspect searx: + +====================== +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:`searx service ` + +.. code:: sh + + sudo -H ./utils/searx.sh inspect service + +**Inspect** :ref:`filtron reverse proxy ` + +.. code:: sh + + sudo -H ./utils/filtron.sh inspect service + +**Inspect** :ref:`result proxy ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh inspect service - sudo -H systemctl restart uwsgi diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 32baa570..699641dd 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -1,9 +1,9 @@ .. _searx_utils: .. _toolboxing: -======================================== -Tooling box ``utils`` for administrators -======================================== +=================== +Admin's tooling box +=================== In the folder :origin:`utils/` we maintain some tools useful for administrators.