From 1dae0c0be09d5c9e287bdea6aa5bf7ec4f4782ec Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Nov 2021 18:27:26 +0100 Subject: [brand] SearXNG - docs rename links and fix documentation Signed-off-by: Markus Heiser --- docs/admin/architecture.rst | 12 ++-- docs/admin/engines/settings.rst | 4 +- docs/admin/engines/sql-engines.rst | 4 +- docs/admin/filtron.rst | 8 +-- docs/admin/index.rst | 4 +- docs/admin/installation-apache.rst | 24 ++++---- docs/admin/installation-docker.rst | 4 +- docs/admin/installation-nginx.rst | 18 +++--- docs/admin/installation-searx.rst | 120 ------------------------------------ docs/admin/installation-searxng.rst | 120 ++++++++++++++++++++++++++++++++++++ docs/admin/installation-uwsgi.rst | 26 ++++---- docs/admin/installation.rst | 10 +-- docs/admin/morty.rst | 8 +-- docs/admin/update-searx.rst | 59 ------------------ docs/admin/update-searxng.rst | 59 ++++++++++++++++++ 15 files changed, 240 insertions(+), 240 deletions(-) delete mode 100644 docs/admin/installation-searx.rst create mode 100644 docs/admin/installation-searxng.rst delete mode 100644 docs/admin/update-searx.rst create mode 100644 docs/admin/update-searxng.rst (limited to 'docs/admin') diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst index 45d952282..db99c9f55 100644 --- a/docs/admin/architecture.rst +++ b/docs/admin/architecture.rst @@ -6,12 +6,12 @@ Architecture .. sidebar:: Further reading - - Reverse Proxy: :ref:`Apache ` & :ref:`nginx ` - - Filtron: :ref:`searx filtron` - - Morty: :ref:`searx morty` - - uWSGI: :ref:`searx uwsgi` - - Searx: :ref:`installation basic` + - Reverse Proxy: :ref:`Apache ` & :ref:`nginx ` + - Filtron: :ref:`searxng filtron` + - Morty: :ref:`searxng morty` + - uWSGI: :ref:`searxng uwsgi` + - SearXNG: :ref:`installation basic` Herein you will find some hints and suggestions about typical architectures of SearXNG infrastructures. diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index c67b45669..b04de7cb3 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -94,7 +94,7 @@ Global Settings port: 8888 bind_address: "127.0.0.1" # address to listen on secret_key: "ultrasecretkey" # change this! - image_proxy: false # proxying image results through searx + image_proxy: false # proxying image results through SearXNG default_locale: "" # default interface locale default_theme: oscar # ui theme default_http_headers: @@ -293,7 +293,7 @@ engine is shown. Most of the options have a default value or even are optional. ``timeout`` : optional Timeout of the search with the current search engine. **Be careful, it will - modify the global timeout of searx.** + modify the global timeout of SearXNG.** ``api_key`` : optional In a few cases, using an API needs the use of a secret key. How to obtain them diff --git a/docs/admin/engines/sql-engines.rst b/docs/admin/engines/sql-engines.rst index 713ef9a40..9d24913a9 100644 --- a/docs/admin/engines/sql-engines.rst +++ b/docs/admin/engines/sql-engines.rst @@ -127,7 +127,7 @@ find an example configuration below: - name: my_database engine: postgresql database: my_database - username: searx + username: searxng password: password query_str: 'SELECT * from my_table WHERE my_column = %(query)s' @@ -155,7 +155,7 @@ example configuration for quering a MySQL server: - name: my_database engine: mysql_server database: my_database - username: searx + username: searxng password: password limit: 5 query_str: 'SELECT * from my_table WHERE my_column=%(query)s' diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst index dd3cfc675..1c32c1b37 100644 --- a/docs/admin/filtron.rst +++ b/docs/admin/filtron.rst @@ -1,5 +1,5 @@ -.. _searx filtron: +.. _searxng filtron: ========================== How to protect an instance @@ -8,7 +8,7 @@ How to protect an instance .. sidebar:: further reading - :ref:`filtron.sh` - - :ref:`nginx searx site` + - :ref:`nginx searxng site` .. contents:: Contents @@ -19,7 +19,7 @@ How to protect an instance .. _filtron: https://github.com/asciimoo/filtron SearXNG depends on external search services. To avoid the abuse of these services -it is advised to limit the number of requests processed by searx. +it is advised to limit the number of requests processed by SearXNG. An application firewall, filtron_ solves exactly this problem. Filtron is just a middleware between your web server (nginx, apache, ...) and searx, we describe @@ -188,4 +188,4 @@ Use it along with ``nginx`` with the following example configuration. Requests are coming from port 4004 going through filtron and then forwarded to port 8888 where a SearXNG is being run. For a complete setup see: :ref:`nginx -searx site`. +searxng site`. diff --git a/docs/admin/index.rst b/docs/admin/index.rst index 3139db99c..940707d8f 100644 --- a/docs/admin/index.rst +++ b/docs/admin/index.rst @@ -7,12 +7,12 @@ Administrator documentation :caption: Contents installation - installation-searx + installation-searxng installation-uwsgi installation-nginx installation-apache installation-docker - update-searx + update-searxng engines/index api architecture diff --git a/docs/admin/installation-apache.rst b/docs/admin/installation-apache.rst index c15e3f5a0..b60e20ad1 100644 --- a/docs/admin/installation-apache.rst +++ b/docs/admin/installation-apache.rst @@ -47,13 +47,13 @@ Install with apache ---- -**Install** :ref:`apache searx site` using :ref:`filtron.sh ` +**Install** :ref:`apache searxng site` using :ref:`filtron.sh ` .. code:: bash $ sudo -H ./utils/filtron.sh apache install -**Install** :ref:`apache searx site` using :ref:`morty.sh ` +**Install** :ref:`apache searxng site` using :ref:`morty.sh ` .. code:: bash @@ -163,7 +163,7 @@ How this default intro site is configured, depends on the linux distribution less /etc/httpd/conf.d/welcome.conf -.. _apache searx site: +.. _apache searxng site: Apache Reverse Proxy ==================== @@ -192,14 +192,14 @@ except in :ref:`The Debian Layout`. sudo -H a2enmod proxy sudo -H a2enmod proxy_http - In :ref:`The Debian Layout` you create a ``searx.conf`` with the + In :ref:`The Debian Layout` you create a ``searxng.conf`` with the ```` directive and save this file in the *sites available* folder at ``/etc/apache2/sites-available``. To enable the - ``searx.conf`` use :man:`a2ensite`: + ``searxng.conf`` use :man:`a2ensite`: .. code:: sh - sudo -H a2ensite searx.conf + sudo -H a2ensite searxng.conf .. group-tab:: Arch Linux @@ -230,7 +230,7 @@ except in :ref:`The Debian Layout`. With ProxyPreserveHost_ the incoming Host HTTP request header is passed to the proxied host. -.. _apache searx via filtron plus morty: +.. _apache searxng via filtron plus morty: .. tabs:: @@ -262,7 +262,7 @@ proxied host. - 2. Configure reverse proxy for :ref:`morty `, listening on + 2. Configure reverse proxy for :ref:`morty `, listening on *localhost 3000* .. code:: apache @@ -286,7 +286,7 @@ proxied host. - For a fully result proxification add :ref:`morty's ` **public + For a fully result proxification add :ref:`morty's ` **public URL** to your :origin:`searx/settings.yml`: .. code:: yaml @@ -302,10 +302,10 @@ proxied host. uWSGI support ============= -Be warned, with this setup, your instance isn't :ref:`protected `, nevertheless it is good enough for intranet usage. In modern Linux distributions, the `mod_proxy_uwsgi`_ is compiled into the *normal* apache -package and you need to install only the :ref:`uWSGI ` package: +package and you need to install only the :ref:`uWSGI ` package: .. tabs:: @@ -337,7 +337,7 @@ For socket communication, you have to activate ``socket = /run/uwsgi/app/searx/socket`` and comment out the ``http = 127.0.0.1:8888`` configuration in your :ref:`uwsgi ini file `. If not already exists, create a folder for the unix sockets, which can be used by the -searx account (see :ref:`create searx user`): +SearXNG account (see :ref:`create searxng user`): .. code:: bash diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index ecf9c833f..cd91af382 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -25,8 +25,8 @@ Docker installation If you intend to create a public instance using Docker, use our well maintained searxng-docker_ image which includes - - :ref:`protection ` `[filtron]`_, - - a :ref:`result proxy ` `[morty]`_ and + - :ref:`protection ` `[filtron]`_, + - a :ref:`result proxy ` `[morty]`_ and - a HTTPS reverse proxy `[caddy]`_. Make sure you have `installed Docker `_ and diff --git a/docs/admin/installation-nginx.rst b/docs/admin/installation-nginx.rst index 1d982bc8f..fdbcdf032 100644 --- a/docs/admin/installation-nginx.rst +++ b/docs/admin/installation-nginx.rst @@ -34,13 +34,13 @@ Install with nginx ---- -**Install** :ref:`nginx searx site` using :ref:`filtron.sh ` +**Install** :ref:`nginx searxng site` using :ref:`filtron.sh ` .. code:: bash $ sudo -H ./utils/filtron.sh nginx install -**Install** :ref:`nginx searx site` using :ref:`morty.sh ` +**Install** :ref:`nginx searxng site` using :ref:`morty.sh ` .. code:: bash @@ -126,7 +126,7 @@ depends on the linux distribution: include /etc/nginx/conf.d/*.conf; -.. _nginx searx site: +.. _nginx searxng site: A nginx SearXNG site ==================== @@ -163,7 +163,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. Create configuration at ``/etc/nginx/conf.d/searxng`` and place a symlink to sites-enabled: -.. _nginx searx via filtron plus morty: +.. _nginx searxng via filtron plus morty: .. tabs:: @@ -195,7 +195,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. } - 2. Configure reverse proxy for :ref:`morty `, listening on + 2. Configure reverse proxy for :ref:`morty `, listening on *localhost 3000*: .. code:: nginx @@ -212,7 +212,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. proxy_set_header X-Scheme $scheme; } - For a fully result proxification add :ref:`morty's ` **public + For a fully result proxification add :ref:`morty's ` **public URL** to your :origin:`searx/settings.yml`: .. code:: yaml @@ -228,7 +228,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. .. group-tab:: proxy or uWSGI - Be warned, with this setup, your instance isn't :ref:`protected `. Nevertheless it is good enough for intranet usage and it is a excellent example of; *how different services can be set up*. The next example shows a reverse proxy configuration wrapping the :ref:`searx-uWSGI @@ -281,7 +281,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. } If not already exists, create a folder for the unix sockets, which can be - used by the searx account: + used by the SearXNG account: .. code:: bash @@ -290,7 +290,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. .. group-tab:: \.\. at subdir URL - Be warned, with these setups, your instance isn't :ref:`protected `. The examples are just here to demonstrate how to export the SearXNG application from a subdirectory URL ``https://example.org/searx/``. diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst deleted file mode 100644 index 3aa655e85..000000000 --- a/docs/admin/installation-searx.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _installation basic: - -========================= -Step by step installation -========================= - -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - -Step by step installation with virtualenv. For Ubuntu, be sure to have enable -universe repository. - -.. _install packages: - -Install packages -================ - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START distro-packages - :end-before: END distro-packages - -.. hint:: - - This installs also the packages needed by :ref:`searx uwsgi` - -.. _create searx user: - -Create user -=========== - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START create user - :end-before: END create user - -.. _searx-src: - -Install SearXNG & dependencies -============================== - -Start a interactive shell from new created user and clone searx: - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START clone searx - :end-before: END clone searx - -In the same shell create *virtualenv*: - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START create virtualenv - :end-before: END create virtualenv - -To install searx's dependencies, exit the SearXNG *bash* session you opened above -and restart a new. Before install, first check if your *virtualenv* was sourced -from the login (*~/.profile*): - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START manage.sh update_packages - :end-before: END manage.sh update_packages - -.. tip:: - - Open a second terminal for the configuration tasks and leave the ``(searx)$`` - terminal open for the tasks below. - - -.. _use_default_settings.yml: - -Configuration -============= - -.. sidebar:: ``use_default_settings: True`` - - - :ref:`settings global` - - :ref:`settings location` - - :ref:`settings use_default_settings` - - :origin:`/etc/searxng/settings.yml ` - -To create a initial ``/etc/searxng/settings.yml`` you can start with a copy of -the file :origin:`utils/templates/etc/searxng/settings.yml`. This setup -:ref:`use default settings ` from -:origin:`searx/settings.yml`. - -For a *minimal setup*, configure like shown below – replace ``searx@$(uname --n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit -``/etc/searxng/settings.yml`` to your needs. - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx config - :end-before: END searx config - -.. tabs:: - - .. group-tab:: Use default settings - - .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml - :language: yaml - - .. group-tab:: searx/settings.yml - - .. literalinclude:: ../../searx/settings.yml - :language: yaml - - -Check -===== - -To check your SearXNG setup, optional enable debugging and start the *webapp*. -SearXNG looks at the exported environment ``$SEARXNG_SETTINGS_PATH`` for a -configuration file. - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START check searx installation - :end-before: END check searx installation - -If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the -debug option in ``settings.yml``. You can now exit SearXNG user bash (enter exit -command twice). At this point SearXNG is not demonized; uwsgi allows this. - diff --git a/docs/admin/installation-searxng.rst b/docs/admin/installation-searxng.rst new file mode 100644 index 000000000..b14139310 --- /dev/null +++ b/docs/admin/installation-searxng.rst @@ -0,0 +1,120 @@ +.. _installation basic: + +========================= +Step by step installation +========================= + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +Step by step installation with virtualenv. For Ubuntu, be sure to have enable +universe repository. + +.. _install packages: + +Install packages +================ + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START distro-packages + :end-before: END distro-packages + +.. hint:: + + This installs also the packages needed by :ref:`searxng uwsgi` + +.. _create searxng user: + +Create user +=========== + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START create user + :end-before: END create user + +.. _searx-src: + +Install SearXNG & dependencies +============================== + +Start a interactive shell from new created user and clone searx: + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START clone searxng + :end-before: END clone searxng + +In the same shell create *virtualenv*: + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START create virtualenv + :end-before: END create virtualenv + +To install searx's dependencies, exit the SearXNG *bash* session you opened above +and restart a new. Before install, first check if your *virtualenv* was sourced +from the login (*~/.profile*): + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START manage.sh update_packages + :end-before: END manage.sh update_packages + +.. tip:: + + Open a second terminal for the configuration tasks and leave the ``(searx)$`` + terminal open for the tasks below. + + +.. _use_default_settings.yml: + +Configuration +============= + +.. sidebar:: ``use_default_settings: True`` + + - :ref:`settings global` + - :ref:`settings location` + - :ref:`settings use_default_settings` + - :origin:`/etc/searxng/settings.yml ` + +To create a initial ``/etc/searxng/settings.yml`` you can start with a copy of +the file :origin:`utils/templates/etc/searxng/settings.yml`. This setup +:ref:`use default settings ` from +:origin:`searx/settings.yml`. + +For a *minimal setup*, configure like shown below – replace ``searx@$(uname +-n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit +``/etc/searxng/settings.yml`` to your needs. + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START searxng config + :end-before: END searxng config + +.. tabs:: + + .. group-tab:: Use default settings + + .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml + :language: yaml + + .. group-tab:: searx/settings.yml + + .. literalinclude:: ../../searx/settings.yml + :language: yaml + + +Check +===== + +To check your SearXNG setup, optional enable debugging and start the *webapp*. +SearXNG looks at the exported environment ``$SEARXNG_SETTINGS_PATH`` for a +configuration file. + +.. kernel-include:: $DOCS_BUILD/includes/searx.rst + :start-after: START check searxng installation + :end-before: END check searxng installation + +If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the +debug option in ``settings.yml``. You can now exit SearXNG user bash (enter exit +command twice). At this point SearXNG is not demonized; uwsgi allows this. + diff --git a/docs/admin/installation-uwsgi.rst b/docs/admin/installation-uwsgi.rst index 1fb24ca8f..1021283f9 100644 --- a/docs/admin/installation-uwsgi.rst +++ b/docs/admin/installation-uwsgi.rst @@ -1,4 +1,4 @@ -.. _searx uwsgi: +.. _searxng uwsgi: ===== uwsgi @@ -105,24 +105,24 @@ restart the uwsgi application. .. group-tab:: Ubuntu / debian .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-description ubuntu-20.04 - :end-before: END searx uwsgi-description ubuntu-20.04 + :start-after: START searxng uwsgi-description ubuntu-20.04 + :end-before: END searxng uwsgi-description ubuntu-20.04 .. hotfix: a bug group-tab need this comment .. group-tab:: Arch Linux .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-description arch - :end-before: END searx uwsgi-description arch + :start-after: START searxng uwsgi-description arch + :end-before: END searxng uwsgi-description arch .. hotfix: a bug group-tab need this comment .. group-tab:: Fedora / RHEL .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-description fedora - :end-before: END searx uwsgi-description fedora + :start-after: START searxng uwsgi-description fedora + :end-before: END searxng uwsgi-description fedora .. tabs:: @@ -130,21 +130,21 @@ restart the uwsgi application. .. group-tab:: Ubuntu / debian .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-appini ubuntu-20.04 - :end-before: END searx uwsgi-appini ubuntu-20.04 + :start-after: START searxng uwsgi-appini ubuntu-20.04 + :end-before: END searxng uwsgi-appini ubuntu-20.04 .. hotfix: a bug group-tab need this comment .. group-tab:: Arch Linux .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-appini arch - :end-before: END searx uwsgi-appini arch + :start-after: START searxng uwsgi-appini arch + :end-before: END searxng uwsgi-appini arch .. hotfix: a bug group-tab need this comment .. group-tab:: Fedora / RHEL .. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx uwsgi-appini fedora - :end-before: END searx uwsgi-appini fedora + :start-after: START searxng uwsgi-appini fedora + :end-before: END searxng uwsgi-appini fedora diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 59f142aff..ccb5314c1 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -27,7 +27,7 @@ Installation scripts .. sidebar:: Update OS first! - To avoid unwanted side effects, update your OS before installing searx. + 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 @@ -42,14 +42,14 @@ the case if you clone into a folder below ``/root``. .. code:: bash $ cd ~/Downloads - $ git clone https://github.com/searxng/searxng.git searx - $ cd searx + $ git clone https://github.com/searxng/searxng.git searxng + $ cd searxng .. sidebar:: further read - :ref:`toolboxing` - - :ref:`update searx` - - :ref:`inspect searx` + - :ref:`update searxng` + - :ref:`inspect searxng` **Install** :ref:`SearXNG service ` diff --git a/docs/admin/morty.rst b/docs/admin/morty.rst index d19a91361..b6bd2ea56 100644 --- a/docs/admin/morty.rst +++ b/docs/admin/morty.rst @@ -1,5 +1,5 @@ -.. _searx morty: +.. _searxng morty: ========================= How to setup result proxy @@ -15,7 +15,7 @@ How to setup result proxy By default SearXNG can only act as an image proxy for result images, but it is possible to proxify all the result URLs with an external service, morty_. -To use this feature, morty has to be installed and activated in searx's +To use this feature, morty has to be installed and activated in SearXNG's ``settings.yml``. Add the following snippet to your ``settings.yml`` and restart searx: @@ -30,8 +30,8 @@ instances without a HTTP proxy. If your morty service is public, the url is the address of the reverse proxy (e.g ``https://example.org/morty``). For more information about *result proxy* have a look at *"SearXNG via filtron -plus morty"* in the :ref:`nginx ` and -:ref:`apache ` sections. +plus morty"* in the :ref:`nginx ` and +:ref:`apache ` sections. ``url`` Is the address of the running morty service. diff --git a/docs/admin/update-searx.rst b/docs/admin/update-searx.rst deleted file mode 100644 index ea58a9954..000000000 --- a/docs/admin/update-searx.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _update searx: - -============= -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:`SearXNG service ` - -.. code:: sh - - sudo -H ./utils/searx.sh update searx - -**Update** :ref:`filtron reverse proxy ` - -.. code:: sh - - sudo -H ./utils/filtron.sh update filtron - -**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:`SearXNG 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 - diff --git a/docs/admin/update-searxng.rst b/docs/admin/update-searxng.rst new file mode 100644 index 000000000..4c541bf57 --- /dev/null +++ b/docs/admin/update-searxng.rst @@ -0,0 +1,59 @@ +.. _update searxng: + +============= +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:`SearXNG service ` + +.. code:: sh + + sudo -H ./utils/searx.sh update searx + +**Update** :ref:`filtron reverse proxy ` + +.. code:: sh + + sudo -H ./utils/filtron.sh update filtron + +**Update** :ref:`result proxy ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh update morty + +.. _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 ` + +.. code:: sh + + sudo -H ./utils/filtron.sh inspect service + +**Inspect** :ref:`result proxy ` + +.. code:: bash + + $ sudo -H ./utils/morty.sh inspect service + -- cgit v1.2.3