diff options
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/arch_public.dot | 8 | ||||
| -rw-r--r-- | docs/admin/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/admin/installation-searx.rst | 2 | ||||
| -rw-r--r-- | docs/admin/installation.rst | 9 | ||||
| -rw-r--r-- | docs/admin/settings.rst | 15 | ||||
| -rw-r--r-- | docs/admin/update-searx.rst | 56 |
6 files changed, 67 insertions, 25 deletions
diff --git a/docs/admin/arch_public.dot b/docs/admin/arch_public.dot index 0d826078d..b838685e7 100644 --- a/docs/admin/arch_public.dot +++ b/docs/admin/arch_public.dot @@ -4,11 +4,11 @@ digraph G { edge [fontname="Sans"]; browser [label="Browser", shape=Mdiamond]; - rp [label="Reverse Proxy", href="https://searx.github.io/searx/utils/filtron.sh.html#public-reverse-proxy"]; - filtron [label="Filtron", href="https://searx.github.io/searx/utils/filtron.sh.html"]; - morty [label="Morty", href="https://searx.github.io/searx/utils/morty.sh.html"]; + rp [label="Reverse Proxy", href="https://searxng.github.io/searxng/utils/filtron.sh.html#public-reverse-proxy"]; + filtron [label="Filtron", href="https://searxng.github.io/searxng/utils/filtron.sh.html"]; + morty [label="Morty", href="https://searxng.github.io/searxng/utils/morty.sh.html"]; static [label="Static files", href="url to configure static files"]; - uwsgi [label="uwsgi", href="https://searx.github.io/searx/utils/searx.sh.html"] + uwsgi [label="uwsgi", href="https://searxng.github.io/searxng/utils/searx.sh.html"] searx1 [label="Searx #1"]; searx2 [label="Searx #2"]; searx3 [label="Searx #3"]; diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst index 464e765eb..edc518ab1 100644 --- a/docs/admin/architecture.rst +++ b/docs/admin/architecture.rst @@ -16,7 +16,7 @@ Architecture Herein you will find some hints and suggestions about typical architectures of searx infrastructures. -We start with a contribution from :pull:`@dalf <1776#issuecomment-567917320>`. +We start with a contribution from :pull-searx:`@dalf <1776#issuecomment-567917320>`. It shows a *reference* setup for public searx instances which can build up and maintained by the scripts from our :ref:`toolboxing`. diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index adea0166f..5c9985e8b 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -80,7 +80,7 @@ Configuration To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup :ref:`use default settings <settings use_default_settings>` from -:origin:`searx/settings.yml` and is recommended since :pull:`2291` is merged. +:origin:`searx/settings.yml` and is recommended since :pull-searx:`2291` is merged. For a *minimal setup*, configure like shown below – replace ``searx@$(uname -n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 8a066dec7..722458152 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 + $ git clone https://github.com/searxng/searxng.git searx $ cd searx +.. sidebar:: further read + + - :ref:`toolboxing` + - :ref:`update searx` + - :ref:`inspect searx` + **Install** :ref:`searx service <searx.sh>` This installs searx as described in :ref:`installation basic`. diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index 622218279..d0773467d 100644 --- a/docs/admin/settings.rst +++ b/docs/admin/settings.rst @@ -43,15 +43,16 @@ Global Settings general: debug : False # Debug mode, only for development - instance_name : "searx" # displayed name - git_url: https://github.com/searx/searx + instance_name : "searxng" # displayed name + contact_url: False # mailto:contact@example.com + + brand: + git_url: https://github.com/searxng/searxng git_branch: master - issue_url: https://github.com/searx/searx/issues - docs_url: https://searx.github.io/searx + issue_url: https://github.com/searxng/searxng/issues + docs_url: https://searxng/searxng.github.io/searxng public_instances: https://searx.space - contact_url: False # mailto:contact@example.com - wiki_url: https://github.com/searx/searx/wiki - twitter_url: https://twitter.com/Searx_engine + wiki_url: https://github.com/searxng/searxng/wiki ``debug`` : Allow a more detailed log if you run searx directly. Display *detailed* error diff --git a/docs/admin/update-searx.rst b/docs/admin/update-searx.rst index c74c9568a..a87f27ede 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 <searx.sh>` + +.. code:: sh + + sudo -H ./utils/searx.sh update searx + +**Update** :ref:`filtron reverse proxy <filtron.sh>` + .. 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/filtron.sh update filtron + +**Update** :ref:`result proxy <morty.sh>` + +.. 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 <searx.sh>` + +.. code:: sh + + sudo -H ./utils/searx.sh inspect service + +**Inspect** :ref:`filtron reverse proxy <filtron.sh>` + +.. code:: sh -Restart uwsgi: + sudo -H ./utils/filtron.sh inspect service -.. tabs:: +**Inspect** :ref:`result proxy <morty.sh>` - .. group-tab:: Ubuntu / debian +.. code:: bash - .. code:: sh + $ sudo -H ./utils/morty.sh inspect service - sudo -H systemctl restart uwsgi |