summaryrefslogtreecommitdiff
path: root/docs/admin/engines
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2022-07-30 13:45:12 +0200
committerGitHub <noreply@github.com>2022-07-30 13:45:12 +0200
commit645c2a2ca1cf40ab9429366ac70c69d1ac8fd004 (patch)
tree943270e4998815d360713e21615082293300c877 /docs/admin/engines
parent0cf5310933ee4f6bff4a941f7296686bd671671f (diff)
parente5323b8aa285d61bf011bbe7ca8f02818f19ed79 (diff)
Merge pull request #1332 from return42/searxng-install
Upgrade installation scripts and documentation
Diffstat (limited to 'docs/admin/engines')
-rw-r--r--docs/admin/engines/nosql-engines.rst8
-rw-r--r--docs/admin/engines/settings.rst13
-rw-r--r--docs/admin/engines/sql-engines.rst8
3 files changed, 21 insertions, 8 deletions
diff --git a/docs/admin/engines/nosql-engines.rst b/docs/admin/engines/nosql-engines.rst
index a50b9c367..68fd0e8bc 100644
--- a/docs/admin/engines/nosql-engines.rst
+++ b/docs/admin/engines/nosql-engines.rst
@@ -42,11 +42,11 @@ Extra Dependencies
For using :ref:`engine redis_server` or :ref:`engine mongodb` you need to
install additional packages in Python's Virtual Environment of your SearXNG
-instance. To switch into the environment (:ref:`searx-src`) you can use
-:ref:`searx.sh`::
+instance. To switch into the environment (:ref:`searxng-src`) you can use
+:ref:`searxng.sh`::
- $ sudo utils/searx.sh shell
- (searx-pyenv)$ pip install ...
+ $ sudo utils/searxng.sh instance cmd bash
+ (searxng-pyenv)$ pip install ...
.. _engine redis_server:
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index 71ad29b43..0b4b984d7 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -207,10 +207,14 @@ Global Settings
``secret_key`` : ``$SEARXNG_SECRET``
Used for cryptography purpose.
+.. _limiter:
+
``limiter`` :
Rate limit the number of request on the instance, block some bots. The
:ref:`limiter plugin` requires a :ref:`settings redis` database.
+.. _image_proxy:
+
``image_proxy`` :
Allow your instance of SearXNG of being able to proxy images. Uses memory space.
@@ -225,9 +229,13 @@ Global Settings
``ui:``
-------
+.. _cache busting:
+ https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#caching_static_assets_with_cache_busting
+
.. code:: yaml
ui:
+ static_use_hash: false
default_locale: ""
query_in_title: false
infinite_scroll: false
@@ -236,6 +244,11 @@ Global Settings
theme_args:
simple_style: auto
+.. _static_use_hash:
+
+``static_use_hash`` :
+ Enables `cache busting`_ of static files.
+
``default_locale`` :
SearXNG interface language. If blank, the locale is detected by using the
browser language. If it doesn't work, or you are deploying a language
diff --git a/docs/admin/engines/sql-engines.rst b/docs/admin/engines/sql-engines.rst
index d91383214..6b6a4cb68 100644
--- a/docs/admin/engines/sql-engines.rst
+++ b/docs/admin/engines/sql-engines.rst
@@ -98,11 +98,11 @@ Extra Dependencies
For using :ref:`engine postgresql` or :ref:`engine mysql_server` you need to
install additional packages in Python's Virtual Environment of your SearXNG
-instance. To switch into the environment (:ref:`searx-src`) you can use
-:ref:`searx.sh`::
+instance. To switch into the environment (:ref:`searxng-src`) you can use
+:ref:`searxng.sh`::
- $ sudo utils/searx.sh shell
- (searx-pyenv)$ pip install ...
+ $ sudo utils/searxng.sh instance cmd bash
+ (searxng-pyenv)$ pip install ...
.. _engine postgresql: