summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/arch_public.dot8
-rw-r--r--docs/admin/engines/configured_engines.rst14
-rw-r--r--docs/admin/engines/settings.rst27
-rw-r--r--docs/admin/filtron.rst2
4 files changed, 41 insertions, 10 deletions
diff --git a/docs/admin/arch_public.dot b/docs/admin/arch_public.dot
index b838685e7..c4ee5f3c1 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://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"];
+ rp [label="Reverse Proxy", href="https://docs.searxng.org/utils/filtron.sh.html#public-reverse-proxy"];
+ filtron [label="Filtron", href="https://docs.searxng.org/utils/filtron.sh.html"];
+ morty [label="Morty", href="https://docs.searxng.org/utils/morty.sh.html"];
static [label="Static files", href="url to configure static files"];
- uwsgi [label="uwsgi", href="https://searxng.github.io/searxng/utils/searx.sh.html"]
+ uwsgi [label="uwsgi", href="https://docs.searxng.org/utils/searx.sh.html"]
searx1 [label="Searx #1"];
searx2 [label="Searx #2"];
searx3 [label="Searx #3"];
diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst
index 0060d1b74..c7b6a1f52 100644
--- a/docs/admin/engines/configured_engines.rst
+++ b/docs/admin/engines/configured_engines.rst
@@ -16,11 +16,18 @@ Explanation of the :ref:`general engine configuration` shown in the table
SearXNG supports {{engines | length}} search engines (of which {{enabled_engine_count}} are enabled by default).
- {% for category, engines in engines.items() | groupby('1.categories.0') %}
+ {% for category, engines in categories_as_tabs.items() %}
{{category}} search engines
---------------------------------------
+ {% for group, engines in engines | group_engines_in_tab %}
+
+ {% if loop.length > 1 %}
+ {{group}}
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ {% endif %}
+
.. flat-table::
:header-rows: 2
:stub-columns: 1
@@ -39,9 +46,9 @@ Explanation of the :ref:`general engine configuration` shown in the table
- Safe search
- Time range
- {% for name, mod in engines | sort_engines %}
+ {% for mod in engines %}
- * - `{{name}} <{{mod.about and mod.about.website}}>`_
+ * - `{{mod.name}} <{{mod.about and mod.about.website}}>`_
- ``!{{mod.shortcut}}``
- {%- if 'searx.engines.' + mod.__name__ in documented_modules %}
:py:mod:`~searx.engines.{{mod.__name__}}`
@@ -65,3 +72,4 @@ Explanation of the :ref:`general engine configuration` shown in the table
{% endfor %}
{% endfor %}
+ {% endfor %}
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index 9f96a2b68..c96dd3329 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -46,7 +46,7 @@ Global Settings
brand:
issue_url: https://github.com/searxng/searxng/issues
- docs_url: https://searxng/searxng.github.io/searxng
+ docs_url: https://docs.searxng.org
public_instances: https://searx.space
wiki_url: https://github.com/searxng/searxng/wiki
@@ -81,6 +81,9 @@ Global Settings
``contact_url``:
Contact ``mailto:`` address or WEB form.
+``enable_metrics``:
+ Enabled by default. Record various anonymous metrics availabled at ``/stats``,
+ ``/stats/errors`` and ``/preferences``.
.. _settings global server:
@@ -249,6 +252,26 @@ Communication with search engines.
``max_redirects`` :
30 by default. Maximum redirect before it is an error.
+``categories_as_tabs:``
+-----------------------
+
+A list of the categories that are displayed as tabs in the user interface.
+Categories not listed here can still be searched with the :ref:`search-syntax`.
+
+.. code-block:: yaml
+
+ categories_as_tabs:
+ general:
+ images:
+ videos:
+ news:
+ map:
+ music:
+ it:
+ science:
+ files:
+ social media:
+
.. _settings engine:
Engine settings
@@ -309,7 +332,7 @@ engine is shown. Most of the options have a default value or even are optional.
search engine.
``shortcut`` :
- Code used to execute bang requests (in this case using ``!bi`` or ``?bi``)
+ Code used to execute bang requests (in this case using ``!bi``)
``base_url`` : optional
Part of the URL that should be stable across every request. Can be useful to
diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst
index 9587d76cb..f08149ae9 100644
--- a/docs/admin/filtron.rst
+++ b/docs/admin/filtron.rst
@@ -23,7 +23,7 @@ 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
-such infratructures in chapter: :ref:`architecture`.
+such infrastructures in chapter: :ref:`architecture`.
filtron & go