git.iko.soy/searx
on fce2d49 help sign in
searx/docs/admin/settings.rst
190 lines 5.8 kB history raw
1.. _settings.yml:
3================
4``settings.yml``
5================
7This page describe the options possibilities of the :origin:`searx/settings.yml`
8file.
10.. sidebar:: Further reading ..
12 - :ref:`search API`
14.. contents:: Contents
15 :depth: 2
16 :local:
17 :backlinks: entry
19.. _settings global:
21Global Settings
22===============
24.. code:: yaml
26 server:
27 port : 8888
28 secret_key : "ultrasecretkey" # change this!
29 debug : False # debug mode, only for development
30 request_timeout : 2.0 # seconds
31 base_url : False # set custom base_url (or False)
32 themes_path : "" # custom ui themes path
33 default_theme : oscar # ui theme
34 useragent_suffix : "" # suffix of searx_useragent, could contain
35 # informations like admins email address
36 image_proxy : False # proxying image results through searx
37 default_locale : "" # default interface locale
39 # uncomment below section if you want to use a proxy
41 #outgoing_proxies :
42 # http : http://127.0.0.1:8080
43 # https: http://127.0.0.1:8080
45 # uncomment below section only if you have more than one network interface
46 # which can be the source of outgoing search requests
48 #source_ips:
49 # - 1.1.1.1
50 # - 1.1.1.2
52 locales:
53 en : English
54 de : Deutsch
55 he : Hebrew
56 hu : Magyar
57 fr : Français
58 es : Español
59 it : Italiano
60 nl : Nederlands
61 ja : 日本語 (Japanese)
62 tr : Türkçe
63 ru : Russian
64 ro : Romanian
67``port`` :
68 Port number of the searx web application if you run it directly using ``python
69 searx/webapp.py``. Doesn't apply to searx running on Apache or Nginx.
71``secret_key`` :
72 Used for cryptography purpose.
74``debug`` :
75 Allow a more detailed log if you run searx directly. Display *detailed* error
76 messages in the browser too, so this must be deactivated in production.
78``request_timeout`` :
79 Global timeout of the requests made to others engines in seconds. A bigger
80 timeout will allow to wait for answers from slow engines, but in consequence
81 will slow searx reactivity (the result page may take the time specified in the
82 timeout to load)
84``base_url`` :
85 The base URL where searx is deployed. Used to create correct inbound links.
87``themes_path`` :
88 Path to where the themes are located. If you didn't develop anything, leave it
89 blank.
91``default_theme`` :
92 Name of the theme you want to use by default on you searx instance.
94``useragent_suffix`` :
95 Suffix to the user-agent searx uses to send requests to others engines. If an
96 engine wish to block you, a contact info here may be useful to avoid that.
98``image_proxy`` :
99 Allow your instance of searx of being able to proxy images. Uses memory space.
101``default_locale`` :
102 Aearx interface language. If blank, the locale is detected by using the
103 browser language. If it doesn't work, or you are deploying a language
104 specific instance of searx, a locale can be defined using an ISO language
105 code, like ``fr``, ``en``, ``de``.
107.. _requests proxies: http://requests.readthedocs.io/en/latest/user/advanced/#proxies
108.. _PR SOCKS support: https://github.com/kennethreitz/requests/pull/478
110``outgoing_proxies`` :
111 Define a proxy you wish to use, see `requests proxies`_. SOCKS proxies are
112 not supported / see `PR SOCKS support`.
114``source_ips`` :
115 If you use multiple nework interfaces, define from which IP the requests must
116 be made.
118``locales`` :
119 Locales codes and their names. Available translations of searx interface.
122.. _settings engine:
124Engine settings
125===============
127.. sidebar:: Further reading ..
129 - :ref:`engines-dev`
131.. code:: yaml
133 - name : bing
134 engine : bing
135 shortcut : bi
136 base_url : 'https://{language}.wikipedia.org/'
137 categories : general
138 timeout : 3.0
139 api_key : 'apikey'
140 disabled : True
141 language : en_US
143``name`` :
144 Name that will be used accross searx to define this engine. In settings, on
145 the result page...
147``engine`` :
148 Name of the python file used to handle requests and responses to and from this
149 search engine.
151``shortcut`` :
152 Code used to execute bang requests (in this case using ``!bi`` or ``?bi``)
154``base_url`` : optional
155 Part of the URL that should be stable accross every request. Can be useful to
156 use multiple sites using only one engine, or updating the site URL without
157 touching at the code.
159``categories`` : optional
160 Define in which categories this engine will be active. Most of the time, it is
161 defined in the code of the engine, but in a few cases it is useful, like when
162 describing multiple search engine using the same code.
164``timeout`` : optional
165 Timeout of the search with the current search engine. **Be careful, it will
166 modify the global timeout of searx.**
168``api_key`` : optional
169 In a few cases, using an API needs the use of a secret key. How to obtain them
170 is described in the file.
172``disabled`` : optional
173 To disable by default the engine, but not deleting it. It will allow the user
174 to manually activate it in the settings.
176``language`` : optional
177 If you want to use another language for a specific engine, you can define it
178 by using the full ISO code of language and country, like ``fr_FR``, ``en_US``,
179 ``de_DE``.
181``weigth`` : default ``1``
182 Weighting of the results of this engine.
184``display_error_messages`` : default ``True``
185 When an engine returns an error, the message is displayed on the user interface.
187.. note::
189 A few more options are possible, but they are pretty specific to some
190 engines, and so won't be described here.