@@ -27,7 +27,8 @@ First, searx will try to load settings.yml from these locations:
27271. the full path specified in the ``SEARX_SETTINGS_PATH`` environment variable.
28282. ``/etc/searx/settings.yml``
2929
30−If these files don't exist (or are empty or can't be read), searx uses the :origin:`searx/settings.yml` file.
30+If these files don't exist (or are empty or can't be read), searx uses the
31+:origin:`searx/settings.yml` file.
3132
3233
3334.. _settings global:
@@ -35,16 +36,46 @@ If these files don't exist (or are empty or can't be read), searx uses the :orig
3536Global Settings
3637===============
3738
39+``general:``
40+------------
41+
3842.. code:: yaml
3943
4044 general:
4145 debug : False # Debug mode, only for development
4246 instance_name : "searx" # displayed name
47+ git_url: https://github.com/searx/searx
48+ git_branch: master
49+ issue_url: https://github.com/searx/searx/issues
50+ docs_url: https://searx.github.io/searx
51+ public_instances: https://searx.space
52+ contact_url: False # mailto:contact@example.com
53+ wiki_url: https://github.com/searx/searx/wiki
54+ twitter_url: https://twitter.com/Searx_engine
4355
4456``debug`` :
4557 Allow a more detailed log if you run searx directly. Display *detailed* error
4658 messages in the browser too, so this must be deactivated in production.
4759
60+``contact_url``:
61+ Contact ``mailto:`` address or WEB form.
62+
63+``git_url`` and ``git_branch``:
64+ Changes this, to point to your searx fork (branch).
65+
66+``docs_url``
67+ If you host your own documentation, change this URL.
68+
69+``wiki_url``:
70+ Link to your wiki (or ``False``)
71+
72+``twitter_url``:
73+ Link to your tweets (or ``False``)
74+
75+
76+``server:``
77+-----------
78+
4879.. code:: yaml
4980
5081 server:
@@ -90,6 +121,8 @@ Global Settings
90121``default_http_headers``:
91122 Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
92123
124+``outgoing:``
125+-------------
93126
94127.. code:: yaml
95128
@@ -139,6 +172,10 @@ Global Settings
139172 If you use multiple network interfaces, define from which IP the requests must
140173 be made. This parameter is ignored when ``proxies`` is set.
141174
175+
176+``locales:``
177+------------
178+
142179.. code:: yaml
143180
144181 locales:
@@ -244,61 +281,76 @@ Engine settings
244281use_default_settings
245282====================
246283
247−.. note::
248−
249− If searx is cloned from a git repository, most probably there is no need to have an user settings.
250−
251−The user defined settings.yml can relied on the default configuration :origin:`searx/settings.yml` using ``use_default_settings: True``.
284+.. sidebar:: ``use_default_settings: True``
252285
253−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``:
254−
255−.. code-block:: yaml
256−
257− use_default_settings: True
258− server:
259− secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
260− bind_address: "0.0.0.0"
261−
262−With ``use_default_settings: True``, each settings can be override in a similar way, the ``engines`` section is merged according to the engine ``name``.
263−
264−In this example, searx will load all the engine and the arch linux wiki engine has a :ref:`token<private engines>`:
265−
266−.. code-block:: yaml
267−
268− use_default_settings: True
269− server:
270− secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
271− engines:
272− - name: arch linux wiki
273− tokens: ['$ecretValue']
274−
275−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:
276−
277−.. code-block:: yaml
278−
279− use_default_settings:
280− engines:
281− remove:
282− - google
283− server:
284− secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
285− engines:
286− - name: arch linux wiki
287− tokens: ['$ecretValue']
288−
289−As an alternative, it is possible to specify the engines to keep. In the following example, searx has only two engines:
290−
291−.. code-block:: yaml
292−
293− use_default_settings:
294− engines:
295− keep_only:
296− - google
297− - duckduckgo
298− server:
299− secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
300− engines:
301− - name: google
302− tokens: ['$ecretValue']
303− - name: duckduckgo
304− tokens: ['$ecretValue']
286+ - :ref:`settings location`
287+ - :ref:`use_default_settings.yml`
288+ - :origin:`/etc/searx/settings.yml <utils/templates/etc/searx/use_default_settings.yml>`
289+
290+The user defined ``settings.yml`` is loaded from the :ref:`settings location`
291+and can relied on the default configuration :origin:`searx/settings.yml` using:
292+
293+ ``use_default_settings: True``
294+
295+``server:``
296+ In the following example, the actual settings are the default settings defined
297+ in :origin:`searx/settings.yml` with the exception of the ``secret_key`` and
298+ the ``bind_address``:
299+
300+ .. code-block:: yaml
301+
302+ use_default_settings: True
303+ server:
304+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
305+ bind_address: "0.0.0.0"
306+
307+``engines:``
308+ With ``use_default_settings: True``, each settings can be override in a
309+ similar way, the ``engines`` section is merged according to the engine
310+ ``name``. In this example, searx will load all the engine and the arch linux
311+ wiki engine has a :ref:`token<private engines>`:
312+
313+ .. code-block:: yaml
314+
315+ use_default_settings: True
316+ server:
317+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
318+ engines:
319+ - name: arch linux wiki
320+ tokens: ['$ecretValue']
321+
322+``engines:`` / ``remove:``
323+ It is possible to remove some engines from the default settings. The following
324+ example is similar to the above one, but searx doesn't load the the google
325+ engine:
326+
327+ .. code-block:: yaml
328+
329+ use_default_settings:
330+ engines:
331+ remove:
332+ - google
333+ server:
334+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
335+ engines:
336+ - name: arch linux wiki
337+ tokens: ['$ecretValue']
338+
339+``engines:`` / ``keep_only:``
340+ As an alternative, it is possible to specify the engines to keep. In the
341+ following example, searx has only two engines:
342+
343+ .. code-block:: yaml
344+
345+ use_default_settings:
346+ engines:
347+ keep_only:
348+ - google
349+ - duckduckgo
350+ server:
351+ secret_key: "uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"
352+ engines:
353+ - name: google
354+ tokens: ['$ecretValue']
355+ - name: duckduckgo
356+ tokens: ['$ecretValue']