diff options
Diffstat (limited to 'docs/admin/engines')
| -rw-r--r-- | docs/admin/engines/nosql-engines.rst | 8 | ||||
| -rw-r--r-- | docs/admin/engines/settings.rst | 57 | ||||
| -rw-r--r-- | docs/admin/engines/sql-engines.rst | 8 |
3 files changed, 58 insertions, 15 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 8f4ee12da..f85c6a75f 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -70,14 +70,26 @@ Global Settings .. code:: yaml general: - debug: false # Debug mode, only for development - instance_name: "SearXNG" # displayed name - contact_url: false # mailto:contact@example.com + debug: false + instance_name: "SearXNG" + privacypolicy_url: false + donation_url: https://docs.searxng.org/donate.html + contact_url: false + enable_metrics: true ``debug`` : ``$SEARXNG_DEBUG`` Allow a more detailed log if you run SearXNG directly. Display *detailed* error messages in the browser too, so this must be deactivated in production. +``donation_url`` : + At default the donation link points to the `SearXNG project + <https://docs.searxng.org/donate.html>`_. Set value to ``true`` to use your + own donation page written in the :ref:`searx/info/en/donate.md + <searx.infopage>` and use ``false`` to disable the donation link altogether. + +``privacypolicy_url``: + Link to privacy policy. + ``contact_url``: Contact ``mailto:`` address or WEB form. @@ -195,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. @@ -213,31 +229,50 @@ 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 + center_alignment: false default_theme: simple 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 specific instance of searx, a locale can be defined using an ISO language code, like ``fr``, ``en``, ``de``. +``query_in_title`` : + When true, the result page's titles contains the query it decreases the + privacy, since the browser can records the page titles. + +``infinite_scroll``: + When true, automatically loads the next page when scrolling to bottom of the current page. + +``center_alignment`` : default ``false`` + When enabled, the results are centered instead of being in the left (or RTL) + side of the screen. This setting only affects the *desktop layout* + (:origin:`min-width: @tablet <searx/static/themes/simple/src/less/definitions.less>`) + ``default_theme`` : Name of the theme you want to use by default on your SearXNG instance. ``theme_args.simple_style``: Style of simple theme: ``auto``, ``light``, ``dark`` -``query_in_title`` : - When true, the result page's titles contains the query it decreases the - privacy, since the browser can records the page titles. - ``results_on_new_tab``: Open result links in a new tab by default. @@ -405,6 +440,7 @@ engine is shown. Most of the options have a default value or even are optional. engine: example shortcut: demo base_url: 'https://{language}.example.com/' + send_accept_language_header: false categories: general timeout: 3.0 api_key: 'apikey' @@ -453,6 +489,13 @@ engine is shown. Most of the options have a default value or even are optional. use multiple sites using only one engine, or updating the site URL without touching at the code. +``send_accept_language_header`` : + Several engines that support languages (or regions) deal with the HTTP header + ``Accept-Language`` to build a response that fits to the locale. When this + option is activated, the language (locale) that is selected by the user is used + to build and send a ``Accept-Language`` header in the request to the origin + search engine. + ``categories`` : optional Define in which categories this engine will be active. Most of the time, it is defined in the code of the engine, but in a few cases it is useful, like when 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: |