diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2020-01-28 10:59:03 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-28 10:59:03 +0000 |
| commit | e64ff38217a1ba49afd4bb1c595121d94cbb2e33 (patch) | |
| tree | d8461b0392143da9d8ec9ae598b8a12c50914104 /docs/admin/api.rst | |
| parent | 0e7b6c9a032d67bf5cbdcfc062d8466c18a62abd (diff) | |
| parent | bda189565589b0065152f5a9fba4565404f9bd9a (diff) | |
Merge branch 'master' into fix-infinite-scroll
Diffstat (limited to 'docs/admin/api.rst')
| -rw-r--r-- | docs/admin/api.rst | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/admin/api.rst b/docs/admin/api.rst new file mode 100644 index 000000000..7804a8664 --- /dev/null +++ b/docs/admin/api.rst @@ -0,0 +1,96 @@ +.. _adminapi: + +================== +Administration API +================== + +Get configuration data +====================== + +.. code:: http + + GET /config HTTP/1.1 + +Sample response +--------------- + +.. code:: json + + { + "autocomplete": "", + "categories": [ + "map", + "it", + "images", + ], + "default_locale": "", + "default_theme": "oscar", + "engines": [ + { + "categories": [ + "map" + ], + "enabled": true, + "name": "openstreetmap", + "shortcut": "osm" + }, + { + "categories": [ + "it" + ], + "enabled": true, + "name": "arch linux wiki", + "shortcut": "al" + }, + { + "categories": [ + "images" + ], + "enabled": true, + "name": "google images", + "shortcut": "goi" + }, + { + "categories": [ + "it" + ], + "enabled": false, + "name": "bitbucket", + "shortcut": "bb" + }, + ], + "instance_name": "searx", + "locales": { + "de": "Deutsch (German)", + "en": "English", + "eo": "Esperanto (Esperanto)", + }, + "plugins": [ + { + "enabled": true, + "name": "HTTPS rewrite" + }, + { + "enabled": false, + "name": "Vim-like hotkeys" + } + ], + "safe_search": 0 + } + + +Embed search bar +================ + +The search bar can be embedded into websites. Just paste the example into the +HTML of the site. URL of the searx instance and values are customizable. + +.. code:: html + + <form method="post" action="https://searx.me/"> + <!-- search --> <input type="text" name="q" /> + <!-- categories --> <input type="hidden" name="categories" value="general,social media" /> + <!-- language --> <input type="hidden" name="lang" value="all" /> + <!-- locale --> <input type="hidden" name="locale" value="en" /> + <!-- date filter --> <input type="hidden" name="time_range" value="month" /> + </form> |