|
@@ -27,7 +27,8 @@ First, searx will try to load settings.yml from these locations:
|
|
|
1. the full path specified in the ``SEARX_SETTINGS_PATH`` environment variable.
|
|
|
2. ``/etc/searx/settings.yml``
|
|
|
|
|
|
-If these files don't exist (or are empty or can't be read), searx uses the :origin:`searx/settings.yml` file.
|
|
|
+If these files don't exist (or are empty or can't be read), searx uses the
|
|
|
+:origin:`searx/settings.yml` file.
|
|
|
|
|
|
|
|
|
.. _settings global:
|
|
@@ -35,16 +36,46 @@ If these files don't exist (or are empty or can't be read), searx uses the :orig
|
|
|
Global Settings
|
|
|
===============
|
|
|
|
|
|
+``general:``
|
|
|
+------------
|
|
|
+
|
|
|
.. code:: yaml
|
|
|
|
|
|
general:
|
|
|
debug : False # Debug mode, only for development
|
|
|
instance_name : "searx" # displayed name
|
|
|
+ git_url: https://github.com/searx/searx
|
|
|
+ git_branch: master
|
|
|
+ issue_url: https://github.com/searx/searx/issues
|
|
|
+ docs_url: https://searx.github.io/searx
|
|
|
+ public_instances: https://searx.space
|
|
|
+ contact_url: False # mailto:contact@example.com
|
|
|
+ wiki_url: https://github.com/searx/searx/wiki
|
|
|
+ twitter_url: https://twitter.com/Searx_engine
|
|
|
|
|
|
``debug`` :
|
|
|
Allow a more detailed log if you run searx directly. Display *detailed* error
|
|
|
messages in the browser too, so this must be deactivated in production.
|
|
|
|
|
|
+``contact_url``:
|
|
|
+ Contact ``mailto:`` address or WEB form.
|
|
|
+
|
|
|
+``git_url`` and ``git_branch``:
|
|
|
+ Changes this, to point to your searx fork (branch).
|
|
|
+
|
|
|
+``docs_url``
|
|
|
+ If you host your own documentation, change this URL.
|
|
|
+
|
|
|
+``wiki_url``:
|
|
|
+ Link to your wiki (or ``False``)
|
|
|
+
|
|
|
+``twitter_url``:
|
|
|
+ Link to your tweets (or ``False``)
|
|
|
+
|
|
|
+
|
|
|
+``server:``
|
|
|
+-----------
|
|
|
+
|
|
|
.. code:: yaml
|
|
|
|
|
|
server:
|
|
@@ -90,6 +121,8 @@ Global Settings
|
|
|
``default_http_headers``:
|
|
|
Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
|
|
|
|
|
|
+``outgoing:``
|
|
|
+-------------
|
|
|
|
|
|
.. code:: yaml
|
|
|
|
|
@@ -139,6 +172,10 @@ Global Settings
|
|
|
If you use multiple network interfaces, define from which IP the requests must
|
|
|
be made. This parameter is ignored when ``proxies`` is set.
|
|
|
|
|
|
+
|
|
|
+``locales:``
|
|
|
+------------
|
|
|
+
|
|
|
.. code:: yaml
|
|
|
|
|
|
locales:
|
|
@@ -244,61 +281,76 @@ Engine settings
|
|
|
use_default_settings
|
|
|
====================
|
|
|
|
|
|
-.. note::
|
|
|
-
|
|
|
- If searx is cloned from a git repository, most probably there is no need to have an user settings.
|
|
|
-
|
|
|
-The user defined settings.yml can relied on the default configuration :origin:`searx/settings.yml` using ``use_default_settings: True``.
|
|
|
+.. sidebar:: ``use_default_settings: True``
|
|
|
|
|
|
-In the following example, the actual settings are the default settings defined in :origin:`searx/settings.yml` with the exception of the ``secret_key`` and the ``bind_address``:
|
|
|
-
|
|
|
-.. code-block:: yaml
|
|
|
-
|
|
|
- use_default_settings: True
|
|
|
- server:
|
|
|
- secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
- bind_address: "0.0.0.0"
|
|
|
-
|
|
|
-With ``use_default_settings: True``, each settings can be override in a similar way, the ``engines`` section is merged according to the engine ``name``.
|
|
|
-
|
|
|
-In this example, searx will load all the engine and the arch linux wiki engine has a :ref:`token<private engines>`:
|
|
|
-
|
|
|
-.. code-block:: yaml
|
|
|
-
|
|
|
- use_default_settings: True
|
|
|
- server:
|
|
|
- secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
- engines:
|
|
|
- - name: arch linux wiki
|
|
|
- tokens: ['$ecretValue']
|
|
|
-
|
|
|
-It is possible to remove some engines from the default settings. The following example is similar to the above one, but searx doesn't load the the google engine:
|
|
|
-
|
|
|
-.. code-block:: yaml
|
|
|
-
|
|
|
- use_default_settings:
|
|
|
- engines:
|
|
|
- remove:
|
|
|
- - google
|
|
|
- server:
|
|
|
- secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
- engines:
|
|
|
- - name: arch linux wiki
|
|
|
- tokens: ['$ecretValue']
|
|
|
-
|
|
|
-As an alternative, it is possible to specify the engines to keep. In the following example, searx has only two engines:
|
|
|
-
|
|
|
-.. code-block:: yaml
|
|
|
-
|
|
|
- use_default_settings:
|
|
|
- engines:
|
|
|
- keep_only:
|
|
|
- - google
|
|
|
- - duckduckgo
|
|
|
- server:
|
|
|
- secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
- engines:
|
|
|
- - name: google
|
|
|
- tokens: ['$ecretValue']
|
|
|
- - name: duckduckgo
|
|
|
- tokens: ['$ecretValue']
|
|
|
+ - :ref:`settings location`
|
|
|
+ - :ref:`use_default_settings.yml`
|
|
|
+ - :origin:`/etc/searx/settings.yml <utils/templates/etc/searx/use_default_settings.yml>`
|
|
|
+
|
|
|
+The user defined ``settings.yml`` is loaded from the :ref:`settings location`
|
|
|
+and can relied on the default configuration :origin:`searx/settings.yml` using:
|
|
|
+
|
|
|
+ ``use_default_settings: True``
|
|
|
+
|
|
|
+``server:``
|
|
|
+ In the following example, the actual settings are the default settings defined
|
|
|
+ in :origin:`searx/settings.yml` with the exception of the ``secret_key`` and
|
|
|
+ the ``bind_address``:
|
|
|
+
|
|
|
+ .. code-block:: yaml
|
|
|
+
|
|
|
+ use_default_settings: True
|
|
|
+ server:
|
|
|
+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
+ bind_address: "0.0.0.0"
|
|
|
+
|
|
|
+``engines:``
|
|
|
+ With ``use_default_settings: True``, each settings can be override in a
|
|
|
+ similar way, the ``engines`` section is merged according to the engine
|
|
|
+ ``name``. In this example, searx will load all the engine and the arch linux
|
|
|
+ wiki engine has a :ref:`token<private engines>`:
|
|
|
+
|
|
|
+ .. code-block:: yaml
|
|
|
+
|
|
|
+ use_default_settings: True
|
|
|
+ server:
|
|
|
+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
+ engines:
|
|
|
+ - name: arch linux wiki
|
|
|
+ tokens: ['$ecretValue']
|
|
|
+
|
|
|
+``engines:`` / ``remove:``
|
|
|
+ It is possible to remove some engines from the default settings. The following
|
|
|
+ example is similar to the above one, but searx doesn't load the the google
|
|
|
+ engine:
|
|
|
+
|
|
|
+ .. code-block:: yaml
|
|
|
+
|
|
|
+ use_default_settings:
|
|
|
+ engines:
|
|
|
+ remove:
|
|
|
+ - google
|
|
|
+ server:
|
|
|
+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
+ engines:
|
|
|
+ - name: arch linux wiki
|
|
|
+ tokens: ['$ecretValue']
|
|
|
+
|
|
|
+``engines:`` / ``keep_only:``
|
|
|
+ As an alternative, it is possible to specify the engines to keep. In the
|
|
|
+ following example, searx has only two engines:
|
|
|
+
|
|
|
+ .. code-block:: yaml
|
|
|
+
|
|
|
+ use_default_settings:
|
|
|
+ engines:
|
|
|
+ keep_only:
|
|
|
+ - google
|
|
|
+ - duckduckgo
|
|
|
+ server:
|
|
|
+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
|
|
|
+ engines:
|
|
|
+ - name: google
|
|
|
+ tokens: ['$ecretValue']
|
|
|
+ - name: duckduckgo
|
|
|
+ tokens: ['$ecretValue']
|