mirror of https://github.com/searx/searx
202 lines
13 KiB
HTML
202 lines
13 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>Administration API — Searx Documentation (Searx-0.17.0.tex)</title>
|
|
<link rel="stylesheet" href="../_static/searx.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinx_tabs/tabs.css" />
|
|
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
<script src="../_static/jquery.js"></script>
|
|
<script src="../_static/underscore.js"></script>
|
|
<script src="../_static/doctools.js"></script>
|
|
<script src="../_static/language_data.js"></script>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="Architecture" href="architecture.html" />
|
|
<link rel="prev" title="settings.yml" href="settings.html" />
|
|
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
|
|
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="architecture.html" title="Architecture"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="settings.html" title="settings.yml"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-0.17.0.tex)</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Administration API</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<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="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/config</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</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="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
|
<span class="nt">"autocomplete"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="nt">"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="nt">"default_locale"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
|
<span class="nt">"default_theme"</span><span class="p">:</span> <span class="s2">"oscar"</span><span class="p">,</span>
|
|
<span class="nt">"engines"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s2">"map"</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"openstreetmap"</span><span class="p">,</span>
|
|
<span class="nt">"shortcut"</span><span class="p">:</span> <span class="s2">"osm"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s2">"it"</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"arch linux wiki"</span><span class="p">,</span>
|
|
<span class="nt">"shortcut"</span><span class="p">:</span> <span class="s2">"al"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s2">"images"</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"google images"</span><span class="p">,</span>
|
|
<span class="nt">"shortcut"</span><span class="p">:</span> <span class="s2">"goi"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"categories"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="s2">"it"</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"bitbucket"</span><span class="p">,</span>
|
|
<span class="nt">"shortcut"</span><span class="p">:</span> <span class="s2">"bb"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"instance_name"</span><span class="p">:</span> <span class="s2">"searx"</span><span class="p">,</span>
|
|
<span class="nt">"locales"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="nt">"de"</span><span class="p">:</span> <span class="s2">"Deutsch (German)"</span><span class="p">,</span>
|
|
<span class="nt">"en"</span><span class="p">:</span> <span class="s2">"English"</span><span class="p">,</span>
|
|
<span class="nt">"eo"</span><span class="p">:</span> <span class="s2">"Esperanto (Esperanto)"</span><span class="p">,</span>
|
|
<span class="p">},</span>
|
|
<span class="nt">"plugins"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"HTTPS rewrite"</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Vim-like hotkeys"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">],</span>
|
|
<span class="nt">"safe_search"</span><span class="p">:</span> <span class="mi">0</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="embed-search-bar">
|
|
<h2>Embed search bar<a class="headerlink" href="#embed-search-bar" title="Permalink to this headline">¶</a></h2>
|
|
<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="highlight-html notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">form</span> <span class="na">method</span><span class="o">=</span><span class="s">"post"</span> <span class="na">action</span><span class="o">=</span><span class="s">"https://searx.me/"</span><span class="p">></span>
|
|
<span class="c"><!-- search --></span> <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"text"</span> <span class="na">name</span><span class="o">=</span><span class="s">"q"</span> <span class="p">/></span>
|
|
<span class="c"><!-- categories --></span> <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"hidden"</span> <span class="na">name</span><span class="o">=</span><span class="s">"categories"</span> <span class="na">value</span><span class="o">=</span><span class="s">"general,social media"</span> <span class="p">/></span>
|
|
<span class="c"><!-- language --></span> <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"hidden"</span> <span class="na">name</span><span class="o">=</span><span class="s">"lang"</span> <span class="na">value</span><span class="o">=</span><span class="s">"all"</span> <span class="p">/></span>
|
|
<span class="c"><!-- locale --></span> <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"hidden"</span> <span class="na">name</span><span class="o">=</span><span class="s">"locale"</span> <span class="na">value</span><span class="o">=</span><span class="s">"en"</span> <span class="p">/></span>
|
|
<span class="c"><!-- date filter --></span> <span class="p"><</span><span class="nt">input</span> <span class="na">type</span><span class="o">=</span><span class="s">"hidden"</span> <span class="na">name</span><span class="o">=</span><span class="s">"time_range"</span> <span class="na">value</span><span class="o">=</span><span class="s">"month"</span> <span class="p">/></span>
|
|
<span class="p"></</span><span class="nt">form</span><span class="p">></span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<span id="sidebar-top"></span>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
<p class="logo"><a href="../index.html">
|
|
<img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
|
|
</a></p>
|
|
|
|
|
|
<h3>Project Links</h3>
|
|
<ul>
|
|
<li><a href="https://github.com/searx/searx">Source</a>
|
|
|
|
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
|
|
|
|
<li><a href="https://searx.space/">Public instances</a>
|
|
|
|
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
|
|
</ul><h3>Navigation</h3>
|
|
<ul>
|
|
<li><a href="../index.html">Overview</a>
|
|
<ul>
|
|
<li><a href="index.html">Administrator documentation</a>
|
|
<ul>
|
|
<li>Previous: <a href="settings.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a>
|
|
<li>Next: <a href="architecture.html" title="next chapter">Architecture</a></ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2015-2020, Adam Tauber, Noémi Ványi.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
<script src="../_static/version_warning_offset.js"></script>
|
|
|
|
</body>
|
|
</html> |