forked from zaclys/searxng
e9fff4fde6
Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
97 lines
2.0 KiB
ReStructuredText
97 lines
2.0 KiB
ReStructuredText
.. _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>
|