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