From a521d4985ac62d730178dfe9780eed6914fdfbed Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Mon, 21 Mar 2022 10:21:33 +0100
Subject: [PATCH] [docs] document settings.yml: search.languages

Requested-by: @dalf https://github.com/searxng/searxng/pull/996#discussion_r830858139
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
---
 docs/admin/engines/settings.rst | 18 ++++++++++++++++++
 searx/settings.yml              |  9 +++++++++
 2 files changed, 27 insertions(+)

diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index a55e2575..a65d71e9 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -123,6 +123,24 @@ Global Settings
   Default search language - leave blank to detect from browser information or
   use codes from :origin:`searx/languages.py`.
 
+``languages``:
+  List of available languages - leave unset to use all codes from
+  :origin:`searx/languages.py`.  Otherwise list codes of available languages.
+  The ``all`` value is shown as the ``Default language`` in the user interface
+  (in most cases, it is meant to send the query without a language parameter ;
+  in some cases, it means the English language) Example:
+
+  .. code:: yaml
+
+     languages:
+       - all
+       - en
+       - en-US
+       - de
+       - it-IT
+       - fr
+       - fr-BE
+
 ``ban_time_on_fail``:
   Ban time in seconds after engine errors.
 
diff --git a/searx/settings.yml b/searx/settings.yml
index a331b576..f6030857 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -21,6 +21,15 @@ search:
   # Default search language - leave blank to detect from browser information or
   # use codes from 'languages.py'
   default_lang: ""
+  # Available languages
+  # languages:
+  #   - all
+  #   - en
+  #   - en-US
+  #   - de
+  #   - it-IT
+  #   - fr
+  #   - fr-BE
   # ban time in seconds after engine errors
   ban_time_on_fail: 5
   # max ban time in seconds after engine errors