diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_themes/searxng/static/searxng.css | 3 | ||||
| -rw-r--r-- | docs/admin/engines/settings.rst | 57 | ||||
| -rw-r--r-- | docs/src/searx.shared.redisdb.rst | 8 | ||||
| -rw-r--r-- | docs/user/search_syntax.rst | 24 |
4 files changed, 68 insertions, 24 deletions
diff --git a/docs/_themes/searxng/static/searxng.css b/docs/_themes/searxng/static/searxng.css index e6f93412d..64f6d4700 100644 --- a/docs/_themes/searxng/static/searxng.css +++ b/docs/_themes/searxng/static/searxng.css @@ -33,6 +33,9 @@ p.sidebar-title, .sidebar p { list-style-type: disclosure-closed; } +.sphinxsidebar .current > a { + font-weight: bold; +} /* admonitions */ diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index a829b870c..1c7ee4a86 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -142,6 +142,36 @@ Global Settings ``default_http_headers``: Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__ + +.. _settings redis: + +``redis:`` +---------- + +.. _Redis.from_url(url): https://redis-py.readthedocs.io/en/stable/connections.html#redis.client.Redis.from_url + +``url`` + URL to connect redis database, see `Redis.from_url(url)`_ & :ref:`redis db`:: + + redis://[[username]:[password]]@localhost:6379/0 + rediss://[[username]:[password]]@localhost:6379/0 + unix://[[username]:[password]]@/path/to/socket.sock?db=0 + +.. admonition:: Tip for developers + + To set up a redis instance simply use:: + + $ ./manage redis.build + $ sudo -H ./manage redis.install + + To get access rights to this instance, your developer account needs to be + added to the *searxng-redis* group:: + + $ sudo -H ./manage redis.addgrp "${USER}" + # don't forget to logout & login to get member of group + +.. _settings outgoing: + ``outgoing:`` ------------- @@ -353,6 +383,33 @@ engine is shown. Most of the options have a default value or even are optional. engines, and so won't be described here. +Example: Multilingual Search +---------------------------- + +SearXNG does not support true multilingual search. You have to use the language +prefix in your search query when searching in a different language. + +But there is a workaround: By adding a new search engine with a different +language, SearXNG will search in your default and other language. + +Example configuration in settings.yml for a German and English speaker: + +.. code-block:: yaml + + search: + default_lang : "de" + ... + + engines: + - name : google english + engine : google + language : en + ... + +When searching, the default google engine will return German results and +"google english" will return English results. + + .. _settings use_default_settings: use_default_settings diff --git a/docs/src/searx.shared.redisdb.rst b/docs/src/searx.shared.redisdb.rst new file mode 100644 index 000000000..265d87617 --- /dev/null +++ b/docs/src/searx.shared.redisdb.rst @@ -0,0 +1,8 @@ +.. _redis db: + +======== +Redis DB +======== + +.. automodule:: searx.shared.redisdb + :members: diff --git a/docs/user/search_syntax.rst b/docs/user/search_syntax.rst index e9ed3e870..346b3162d 100644 --- a/docs/user/search_syntax.rst +++ b/docs/user/search_syntax.rst @@ -37,27 +37,3 @@ Image search: Custom language in wikipedia: - :search:`:hu !wp hackerspace <?q=%3Ahu%20%21wp%20hackerspace>` - -Multilingual Search -=================== - -SearXNG does not support true multilingual search. -You have to use the language prefix in your search query when searching in a different language. - -But there is a workaround: -By adding a new search engine with a different language, SearXNG will search in your default and other language. - -Example configuration in settings.yml for a German and English speaker: - .. code-block:: yaml - - search: - language : "de" - ... - - engines: - - name : google english - engine : google - language : english - ... - -When searching, the default google engine will return German results and "google english" will return English results. |