123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180 |
-
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Administration API — searx 0.12.0 documentation</title>
- <link rel="stylesheet" href="../_static/style.css" type="text/css" />
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
- <script type="text/javascript" src="../_static/documentation_options.js"></script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
- <link rel="index" title="Index" href="../genindex.html" />
- <link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="How to protect an instance" href="filtron.html" />
- <link rel="prev" title="Installation" href="../dev/install/installation.html" />
-
-
- <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
- <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
-
- </head><body>
-
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <div class="section" id="administration-api">
- <span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>
- <div class="section" id="get-configuration-data">
- <h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>
- <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
- </pre></div>
- </div>
- <div class="section" id="sample-response">
- <h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>
- <div class="code sh highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"autocomplete"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"categories"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"map"</span><span class="p">,</span>
- <span class="s2">"it"</span><span class="p">,</span>
- <span class="s2">"images"</span><span class="p">,</span>
- <span class="p">],</span>
- <span class="s2">"default_locale"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"default_theme"</span><span class="p">:</span> <span class="s2">"oscar"</span><span class="p">,</span>
- <span class="s2">"engines"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"categories"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"map"</span>
- <span class="p">],</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"openstreetmap"</span><span class="p">,</span>
- <span class="s2">"shortcut"</span><span class="p">:</span> <span class="s2">"osm"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"categories"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"it"</span>
- <span class="p">],</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"arch linux wiki"</span><span class="p">,</span>
- <span class="s2">"shortcut"</span><span class="p">:</span> <span class="s2">"al"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"categories"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"images"</span>
- <span class="p">],</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"google images"</span><span class="p">,</span>
- <span class="s2">"shortcut"</span><span class="p">:</span> <span class="s2">"goi"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"categories"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"it"</span>
- <span class="p">],</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitbucket"</span><span class="p">,</span>
- <span class="s2">"shortcut"</span><span class="p">:</span> <span class="s2">"bb"</span>
- <span class="p">},</span>
- <span class="p">],</span>
- <span class="s2">"instance_name"</span><span class="p">:</span> <span class="s2">"searx"</span><span class="p">,</span>
- <span class="s2">"locales"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"de"</span><span class="p">:</span> <span class="s2">"Deutsch (German)"</span><span class="p">,</span>
- <span class="s2">"en"</span><span class="p">:</span> <span class="s2">"English"</span><span class="p">,</span>
- <span class="s2">"eo"</span><span class="p">:</span> <span class="s2">"Esperanto (Esperanto)"</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="s2">"plugins"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"HTTPS rewrite"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Vim-like hotkeys"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s2">"safe_search"</span><span class="p">:</span> <span class="mi">0</span>
- <span class="p">}</span>
- </pre></div>
- </div>
- </div>
- </div>
- </div>
- <div class="section" id="embed-search-bar">
- <h1>Embed search bar<a class="headerlink" href="#embed-search-bar" title="Permalink to this headline">¶</a></h1>
- <p>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.</p>
- <div class="code html highlight-default notranslate"><div class="highlight"><pre><span></span><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>
- </pre></div>
- </div>
- </div>
-
-
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
- <h3><a href="../index.html">Table Of Contents</a></h3>
- <ul>
- <li><a class="reference internal" href="#">Administration API</a><ul>
- <li><a class="reference internal" href="#get-configuration-data">Get configuration data</a><ul>
- <li><a class="reference internal" href="#sample-response">Sample response</a></li>
- </ul>
- </li>
- </ul>
- </li>
- <li><a class="reference internal" href="#embed-search-bar">Embed search bar</a></li>
- </ul>
- <div class="sidebar_container body">
- <h1>Searx</h1>
- <ul>
- <li><a href="../index.html">Home</a></li>
- <li><a href="https://github.com/asciimoo/searx">Source</a></li>
- <li><a href="../blog/blog.html">Blog</a></li>
- <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
- <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
- </ul>
- <hr />
- <ul>
- <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
- </ul>
- </div>
- <div role="note" aria-label="source link">
- <h3>This Page</h3>
- <ul class="this-page-menu">
- <li><a href="../_sources/admin/api.rst.txt"
- rel="nofollow">Show Source</a></li>
- </ul>
- </div>
- <div id="searchbox" style="display: none" role="search">
- <h3>Quick search</h3>
- <div class="searchformwrapper">
- <form class="search" action="../search.html" method="get">
- <input type="text" name="q" />
- <input type="submit" value="Go" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
- </div>
- <script type="text/javascript">$('#searchbox').show(0);</script>
- </div>
- </div>
- <div class="clearer"></div>
- </div>
- <div class="footer">
- © Copyright 2015-2017, Adam Tauber.
- </div>
- </body>
- </html>
|