git.iko.soy/searx
on v1.0.0 help sign in
searx/docs/admin/api.rst
96 lines 2.1 kB history raw
1.. _adminapi:
3==================
4Administration API
5==================
7Get configuration data
8======================
10.. code:: http
12 GET /config HTTP/1.1
14Sample response
15---------------
17.. code:: json
19 {
20 "autocomplete": "",
21 "categories": [
22 "map",
23 "it",
24 "images",
25 ],
26 "default_locale": "",
27 "default_theme": "oscar",
28 "engines": [
29 {
30 "categories": [
31 "map"
32 ],
33 "enabled": true,
34 "name": "openstreetmap",
35 "shortcut": "osm"
36 },
37 {
38 "categories": [
39 "it"
40 ],
41 "enabled": true,
42 "name": "arch linux wiki",
43 "shortcut": "al"
44 },
45 {
46 "categories": [
47 "images"
48 ],
49 "enabled": true,
50 "name": "google images",
51 "shortcut": "goi"
52 },
53 {
54 "categories": [
55 "it"
56 ],
57 "enabled": false,
58 "name": "bitbucket",
59 "shortcut": "bb"
60 },
61 ],
62 "instance_name": "searx",
63 "locales": {
64 "de": "Deutsch (German)",
65 "en": "English",
66 "eo": "Esperanto (Esperanto)",
67 },
68 "plugins": [
69 {
70 "enabled": true,
71 "name": "HTTPS rewrite"
72 },
73 {
74 "enabled": false,
75 "name": "Vim-like hotkeys"
76 }
77 ],
78 "safe_search": 0
79 }
82Embed search bar
83================
85The search bar can be embedded into websites. Just paste the example into the
86HTML of the site. URL of the searx instance and values are customizable.
88.. code:: html
90 <form method="post" action="https://searx.me/">
91 <!-- search --> <input type="text" name="q" />
92 <!-- categories --> <input type="hidden" name="categories" value="general,social media" />
93 <!-- language --> <input type="hidden" name="lang" value="all" />
94 <!-- locale --> <input type="hidden" name="locale" value="en" />
95 <!-- date filter --> <input type="hidden" name="time_range" value="month" />
96 </form>