diff options
Diffstat (limited to 'docs/admin')
| -rw-r--r-- | docs/admin/buildhosts.rst | 6 | ||||
| -rw-r--r-- | docs/admin/engines/configured_engines.rst | 89 | ||||
| -rw-r--r-- | docs/admin/engines/index.rst | 7 | ||||
| -rw-r--r-- | docs/admin/installation-docker.rst | 2 | ||||
| -rw-r--r-- | docs/admin/installation-scripts.rst | 4 | ||||
| -rw-r--r-- | docs/admin/installation.rst | 2 |
6 files changed, 12 insertions, 98 deletions
diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index 6926469ef..d4d5ecb91 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -14,7 +14,7 @@ Buildhosts :local: :backlinks: entry -To get best results from build, its recommend to install additional packages +To get best results from build, it's recommend to install additional packages on build hosts (see :ref:`searxng.sh`).:: sudo -H ./utils/searxng.sh install buildhost @@ -51,7 +51,7 @@ Build docs Most of the sphinx requirements are installed from :origin:`setup.py` and the docs can be build from scratch with ``make docs.html``. For better math and image processing additional packages are needed. The XeTeX_ needed not only for -PDF creation, its also needed for :ref:`math` when HTML output is build. +PDF creation, it's also needed for :ref:`math` when HTML output is build. To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered as images (``sphinx.ext.imgmath`` extension). @@ -128,7 +128,7 @@ Lint shell scripts .. _ShellCheck: https://github.com/koalaman/shellcheck -To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool. +To lint shell scripts, we use ShellCheck_ - a shell script static analysis tool. .. SNIP sh lint requirements diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst deleted file mode 100644 index 9507c77df..000000000 --- a/docs/admin/engines/configured_engines.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. _configured engines: - -================== -Configured Engines -================== - -.. sidebar:: Further reading .. - - - :ref:`settings categories_as_tabs` - - :ref:`engines-dev` - - :ref:`settings engine` - - :ref:`general engine configuration` - -.. jinja:: searx - - SearXNG supports {{engines | length}} search engines of which - {{enabled_engine_count}} are enabled by default. - - Engines can be assigned to multiple :ref:`categories <engine categories>`. - The UI displays the tabs that are configured in :ref:`categories_as_tabs - <settings categories_as_tabs>`. In addition to these UI categories (also - called *tabs*), engines can be queried by their name or the categories they - belong to, by using a :ref:`\!bing syntax <search-syntax>`. - -.. contents:: Contents - :depth: 2 - :local: - :backlinks: entry - -.. jinja:: searx - - {% for category, engines in categories_as_tabs.items() %} - - tab ``!{{category.replace(' ', '_')}}`` - --------------------------------------- - - {% for group, group_bang, engines in engines | group_engines_in_tab %} - - {% if loop.length > 1 %} - {% if group_bang %}group ``{{group_bang}}``{% else %}{{group}}{% endif %} - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - {% endif %} - - .. flat-table:: - :header-rows: 2 - :stub-columns: 1 - :widths: 10 1 10 1 1 1 1 1 1 1 - - * - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`) - - :cspan:`3` :ref:`Supported features <engine file>` - - * - Name - - !bang - - Module - - Disabled - - Timeout - - Weight - - Paging - - Locale - - Safe search - - Time range - - {% for mod in engines %} - - * - `{{mod.name}} <{{mod.about and mod.about.website}}>`_ - {%- if mod.about and mod.about.language %} - ({{mod.about.language | upper}}) - {%- endif %} - - ``!{{mod.shortcut}}`` - - {%- if 'searx.engines.' + mod.__name__ in documented_modules %} - :py:mod:`~searx.engines.{{mod.__name__}}` - {%- else %} - :origin:`{{mod.__name__}} <searx/engines/{{mod.__name__}}.py>` - {%- endif %} - - {{(mod.disabled and "y") or ""}} - - {{mod.timeout}} - - {{mod.weight or 1 }} - {% if mod.engine_type == 'online' %} - - {{(mod.paging and "y") or ""}} - - {{(mod.language_support and "y") or ""}} - - {{(mod.safesearch and "y") or ""}} - - {{(mod.time_range_support and "y") or ""}} - {% else %} - - :cspan:`3` not applicable ({{mod.engine_type}}) - {% endif %} - - {% endfor %} - {% endfor %} - {% endfor %} diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst index f488731ea..92c723817 100644 --- a/docs/admin/engines/index.rst +++ b/docs/admin/engines/index.rst @@ -10,10 +10,13 @@ Engines & Settings - :ref:`engine settings` & :ref:`engine file` .. toctree:: - :maxdepth: 1 + :maxdepth: 3 settings - configured_engines + +.. toctree:: + :maxdepth: 1 + private-engines recoll sql-engines diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst index 1457d6a6b..eb52c5828 100644 --- a/docs/admin/installation-docker.rst +++ b/docs/admin/installation-docker.rst @@ -123,7 +123,7 @@ stoped. To get rid of a container use ``container rm``: This might remove all docker items, not only those from SearXNG. -If you won't use docker anymore and want to get rid of all conatiners & images +If you won't use docker anymore and want to get rid of all containers & images use the following *prune* command: .. code:: sh diff --git a/docs/admin/installation-scripts.rst b/docs/admin/installation-scripts.rst index e256a2461..2d43f5e37 100644 --- a/docs/admin/installation-scripts.rst +++ b/docs/admin/installation-scripts.rst @@ -42,7 +42,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the For the installation procedure, use a *sudoer* login to run the scripts. If you install from ``root``, take into account that the scripts are creating a ``searxng`` user. In the installation procedure this new created user does - need read access to the cloned SearXNG repository, which is not the case if you clone + need to have read access to the cloned SearXNG repository, which is not the case if you clone it into a folder below ``/root``! .. sidebar:: further read @@ -52,7 +52,7 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the .. _caddy: https://hub.docker.com/_/caddy When all services are installed and running fine, you can add SearXNG to your -HTTP server. We do not have any preferences for the HTTP server, you can use +HTTP server. We do not have any preferences regarding the HTTP server, you can use whatever you prefer. We use caddy in our :ref:`docker image <installation docker>` and we have diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index cae51be63..54d901f76 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -12,7 +12,7 @@ Installation The :ref:`installation basic` is an excellent illustration of *how a SearXNG instance is build up* (see :ref:`architecture uWSGI`). If you do not have any -special preferences, its recommend to use the :ref:`installation docker` or the +special preferences, it's recommended to use the :ref:`installation docker` or the :ref:`installation scripts`. .. attention:: |