summaryrefslogtreecommitdiff
path: root/docs/admin/api.rst
diff options
context:
space:
mode:
authorNoémi Ványi <sitbackandwait@gmail.com>2016-09-06 18:16:29 +0200
committerNoémi Ványi <sitbackandwait@gmail.com>2016-09-06 18:16:29 +0200
commit013139b036e31043e25991112a34588011650243 (patch)
tree6c1d00b9467730073111b02598a035aefe89b103 /docs/admin/api.rst
parenta2bd1e57d36bb51667e080a29b0fd27d4ad1c9c6 (diff)
add embedded search to docs
Diffstat (limited to 'docs/admin/api.rst')
-rw-r--r--docs/admin/api.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/admin/api.rst b/docs/admin/api.rst
index 94508a28c..8d6162247 100644
--- a/docs/admin/api.rst
+++ b/docs/admin/api.rst
@@ -76,3 +76,19 @@ Sample response
],
"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 query --> <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>