mirror of https://github.com/searx/searx
436 lines
39 KiB
HTML
436 lines
39 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<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>settings.yml — Searx Documentation (Searx-1.1.0.tex)</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/searx.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/sphinx_highlight.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Administration API" href="api.html" />
|
||
<link rel="prev" title="How to update" href="update-searx.html" />
|
||
</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="api.html" title="Administration API"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="update-searx.html" title="How to update"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.1.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=""><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="settings-yml">
|
||
<span id="id1"></span><h1><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code><a class="headerlink" href="#settings-yml" title="Permalink to this heading">¶</a></h1>
|
||
<p>This page describe the options possibilities of the <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">Origin: searx/settings.yml</a>
|
||
file.</p>
|
||
<aside class="sidebar">
|
||
<p class="sidebar-title">Further reading ..</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="installation-searx.html#use-default-settings-yml"><span class="std std-ref">Configuration</span></a></p></li>
|
||
<li><p><a class="reference internal" href="../dev/search_api.html#search-api"><span class="std std-ref">Search API</span></a></p></li>
|
||
</ul>
|
||
</aside>
|
||
<nav class="contents local" id="contents">
|
||
<p class="topic-title">Contents</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#settings-yml-location" id="id2">settings.yml location</a></p></li>
|
||
<li><p><a class="reference internal" href="#global-settings" id="id3">Global Settings</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#general" id="id4"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#server" id="id5"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#outgoing" id="id6"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></p></li>
|
||
<li><p><a class="reference internal" href="#locales" id="id7"><code class="docutils literal notranslate"><span class="pre">locales:</span></code></a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#engine-settings" id="id8">Engine settings</a></p></li>
|
||
<li><p><a class="reference internal" href="#use-default-settings" id="id9">use_default_settings</a></p></li>
|
||
</ul>
|
||
</nav>
|
||
<section id="settings-yml-location">
|
||
<span id="settings-location"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">settings.yml location</a><a class="headerlink" href="#settings-yml-location" title="Permalink to this heading">¶</a></h2>
|
||
<p>First, searx will try to load settings.yml from these locations:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>the full path specified in the <code class="docutils literal notranslate"><span class="pre">SEARX_SETTINGS_PATH</span></code> environment variable.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">/etc/searx/settings.yml</span></code></p></li>
|
||
</ol>
|
||
<p>If these files don’t exist (or are empty or can’t be read), searx uses the
|
||
<a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">Origin: searx/settings.yml</a> file.</p>
|
||
</section>
|
||
<section id="global-settings">
|
||
<span id="settings-global"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Global Settings</a><a class="headerlink" href="#global-settings" title="Permalink to this heading">¶</a></h2>
|
||
<section id="general">
|
||
<h3><a class="toc-backref" href="#id4" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a><a class="headerlink" href="#general" title="Permalink to this heading">¶</a></h3>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">general</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">debug </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># Debug mode, only for development</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">instance_name </span><span class="p">:</span><span class="w"> </span><span class="s">"searx"</span><span class="w"> </span><span class="c1"># displayed name</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">git_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">git_branch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">master</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">issue_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/issues</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">docs_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://searx.github.io/searx</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">public_instances</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://searx.space</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">contact_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># mailto:contact@example.com</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">wiki_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/wiki</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">twitter_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://twitter.com/Searx_engine</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">debug</span></code> :</dt><dd><p>Allow a more detailed log if you run searx directly. Display <em>detailed</em> error
|
||
messages in the browser too, so this must be deactivated in production.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">contact_url</span></code>:</dt><dd><p>Contact <code class="docutils literal notranslate"><span class="pre">mailto:</span></code> address or WEB form.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">git_url</span></code> and <code class="docutils literal notranslate"><span class="pre">git_branch</span></code>:</dt><dd><p>Changes this, to point to your searx fork (branch).</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">docs_url</span></code></dt><dd><p>If you host your own documentation, change this URL.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">wiki_url</span></code>:</dt><dd><p>Link to your wiki (or <code class="docutils literal notranslate"><span class="pre">False</span></code>)</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">twitter_url</span></code>:</dt><dd><p>Link to your tweets (or <code class="docutils literal notranslate"><span class="pre">False</span></code>)</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="server">
|
||
<h3><a class="toc-backref" href="#id5" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a><a class="headerlink" href="#server" title="Permalink to this heading">¶</a></h3>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">port </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8888</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">bind_address </span><span class="p">:</span><span class="w"> </span><span class="s">"127.0.0.1"</span><span class="w"> </span><span class="c1"># address to listen on</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">secret_key </span><span class="p">:</span><span class="w"> </span><span class="s">"ultrasecretkey"</span><span class="w"> </span><span class="c1"># change this!</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">base_url </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># set custom base_url (or False)</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">image_proxy </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># proxying image results through searx</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">default_locale </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># default interface locale</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">default_theme </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">oscar</span><span class="w"> </span><span class="c1"># ui theme</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">default_http_headers</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">X-Content-Type-Options </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nosniff</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">X-XSS-Protection </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1; mode=block</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">X-Download-Options </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">noopen</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">X-Robots-Tag </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">noindex, nofollow</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">Referrer-Policy </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">no-referrer</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">port</span></code> & <code class="docutils literal notranslate"><span class="pre">bind_address</span></code>:</dt><dd><p>Port number and <em>bind address</em> of the searx web application if you run it
|
||
directly using <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">searx/webapp.py</span></code>. Doesn’t apply to searx running on
|
||
Apache or Nginx.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">secret_key</span></code> :</dt><dd><p>Used for cryptography purpose.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code> :</dt><dd><p>The base URL where searx is deployed. Used to create correct inbound links.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">image_proxy</span></code> :</dt><dd><p>Allow your instance of searx of being able to proxy images. Uses memory space.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">default_locale</span></code> :</dt><dd><p>Searx interface language. If blank, the locale is detected by using the
|
||
browser language. If it doesn’t work, or you are deploying a language
|
||
specific instance of searx, a locale can be defined using an ISO language
|
||
code, like <code class="docutils literal notranslate"><span class="pre">fr</span></code>, <code class="docutils literal notranslate"><span class="pre">en</span></code>, <code class="docutils literal notranslate"><span class="pre">de</span></code>.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">default_theme</span></code> :</dt><dd><p>Name of the theme you want to use by default on your searx instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">default_http_headers</span></code>:</dt><dd><p>Set additional HTTP headers, see <a class="reference external" href="https://github.com/searx/searx/issues/715">#755</a></p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="outgoing">
|
||
<h3><a class="toc-backref" href="#id6" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a><a class="headerlink" href="#outgoing" title="Permalink to this heading">¶</a></h3>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">outgoing</span><span class="p">:</span><span class="w"> </span><span class="c1"># communication with search engines</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">request_timeout </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2.0</span><span class="w"> </span><span class="c1"># default timeout in seconds, can be override by engine</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># max_request_timeout: 10.0 # the maximum timeout in seconds</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">useragent_suffix </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># information like an email address to the administrator</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">pool_connections </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">100</span><span class="w"> </span><span class="c1"># Number of different hosts</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">pool_maxsize </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># Number of simultaneous requests by host</span><span class="w"></span>
|
||
<span class="c1"># uncomment below section if you want to use a proxy</span><span class="w"></span>
|
||
<span class="c1"># proxies:</span><span class="w"></span>
|
||
<span class="c1"># http:</span><span class="w"></span>
|
||
<span class="c1"># - http://proxy1:8080</span><span class="w"></span>
|
||
<span class="c1"># - http://proxy2:8080</span><span class="w"></span>
|
||
<span class="c1"># https:</span><span class="w"></span>
|
||
<span class="c1"># - http://proxy1:8080</span><span class="w"></span>
|
||
<span class="c1"># - http://proxy2:8080</span><span class="w"></span>
|
||
<span class="c1"># uncomment below section only if you have more than one network interface</span><span class="w"></span>
|
||
<span class="c1"># which can be the source of outgoing search requests</span><span class="w"></span>
|
||
<span class="c1"># source_ips:</span><span class="w"></span>
|
||
<span class="c1"># - 1.1.1.1</span><span class="w"></span>
|
||
<span class="c1"># - 1.1.1.2</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">request_timeout</span></code> :</dt><dd><p>Global timeout of the requests made to others engines in seconds. A bigger
|
||
timeout will allow to wait for answers from slow engines, but in consequence
|
||
will slow searx reactivity (the result page may take the time specified in the
|
||
timeout to load). Can be override by <a class="reference internal" href="#settings-engine"><span class="std std-ref">Engine settings</span></a></p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">useragent_suffix</span></code> :</dt><dd><p>Suffix to the user-agent searx uses to send requests to others engines. If an
|
||
engine wish to block you, a contact info here may be useful to avoid that.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">proxies</span></code> :</dt><dd><p>Define one or more proxies you wish to use, see <a class="reference external" href="https://requests.readthedocs.io/en/latest/user/advanced/#proxies">requests proxies</a>.
|
||
If there are more than one proxy for one protocol (http, https),
|
||
requests to the engines are distributed in a round-robin fashion.</p>
|
||
<ul class="simple">
|
||
<li><p>Proxy: <a class="reference external" href="https://2.python-requests.org/en/latest/user/advanced/#proxies">see</a>.</p></li>
|
||
<li><p>SOCKS proxies are also supported: <a class="reference external" href="https://2.python-requests.org/en/latest/user/advanced/#socks">see</a></p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">source_ips</span></code> :</dt><dd><p>If you use multiple network interfaces, define from which IP the requests must
|
||
be made. This parameter is ignored when <code class="docutils literal notranslate"><span class="pre">proxies</span></code> is set.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section id="locales">
|
||
<h3><a class="toc-backref" href="#id7" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">locales:</span></code></a><a class="headerlink" href="#locales" title="Permalink to this heading">¶</a></h3>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">locales</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">en </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">English</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">de </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Deutsch</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">he </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Hebrew</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">hu </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Magyar</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">fr </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Français</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">es </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Español</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">it </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Italiano</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">nl </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Nederlands</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">ja </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">日本語 (Japanese)</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">tr </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Türkçe</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">ru </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Russian</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">ro </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Romanian</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="simple">
|
||
<dt><code class="docutils literal notranslate"><span class="pre">locales</span></code> :</dt><dd><p>Locales codes and their names. Available translations of searx interface.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</section>
|
||
<section id="engine-settings">
|
||
<span id="settings-engine"></span><h2><a class="toc-backref" href="#id8" role="doc-backlink">Engine settings</a><a class="headerlink" href="#engine-settings" title="Permalink to this heading">¶</a></h2>
|
||
<aside class="sidebar">
|
||
<p class="sidebar-title">Further reading ..</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="../dev/engine_overview.html#engines-dev"><span class="std std-ref">Engine overview</span></a></p></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bing</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">engine </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bing</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">shortcut </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bi</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">base_url </span><span class="p">:</span><span class="w"> </span><span class="s">'https://{language}.wikipedia.org/'</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">categories </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">general</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">timeout </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3.0</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">api_key </span><span class="p">:</span><span class="w"> </span><span class="s">'apikey'</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">disabled </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">language </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">en_US</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1">#proxies:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># http:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - http://proxy1:8080</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - http://proxy2:8080</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># https:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - http://proxy1:8080</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - http://proxy2:8080</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - socks5://user:password@proxy3:1080</span><span class="w"></span>
|
||
<span class="w"> </span><span class="c1"># - socks5h://user:password@proxy4:1080</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
<dl>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">name</span></code> :</dt><dd><p>Name that will be used across searx to define this engine. In settings, on
|
||
the result page…</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">engine</span></code> :</dt><dd><p>Name of the python file used to handle requests and responses to and from this
|
||
search engine.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">shortcut</span></code> :</dt><dd><p>Code used to execute bang requests (in this case using <code class="docutils literal notranslate"><span class="pre">!bi</span></code> or <code class="docutils literal notranslate"><span class="pre">?bi</span></code>)</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code><span class="classifier">optional</span></dt><dd><p>Part of the URL that should be stable across every request. Can be useful to
|
||
use multiple sites using only one engine, or updating the site URL without
|
||
touching at the code.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">categories</span></code><span class="classifier">optional</span></dt><dd><p>Define in which categories this engine will be active. Most of the time, it is
|
||
defined in the code of the engine, but in a few cases it is useful, like when
|
||
describing multiple search engine using the same code.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">timeout</span></code><span class="classifier">optional</span></dt><dd><p>Timeout of the search with the current search engine. <strong>Be careful, it will
|
||
modify the global timeout of searx.</strong></p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">api_key</span></code><span class="classifier">optional</span></dt><dd><p>In a few cases, using an API needs the use of a secret key. How to obtain them
|
||
is described in the file.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">disabled</span></code><span class="classifier">optional</span></dt><dd><p>To disable by default the engine, but not deleting it. It will allow the user
|
||
to manually activate it in the settings.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">language</span></code><span class="classifier">optional</span></dt><dd><p>If you want to use another language for a specific engine, you can define it
|
||
by using the full ISO code of language and country, like <code class="docutils literal notranslate"><span class="pre">fr_FR</span></code>, <code class="docutils literal notranslate"><span class="pre">en_US</span></code>,
|
||
<code class="docutils literal notranslate"><span class="pre">de_DE</span></code>.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">weigth</span></code><span class="classifier">default <code class="docutils literal notranslate"><span class="pre">1</span></code></span></dt><dd><p>Weighting of the results of this engine.</p>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">display_error_messages</span></code><span class="classifier">default <code class="docutils literal notranslate"><span class="pre">True</span></code></span></dt><dd><p>When an engine returns an error, the message is displayed on the user interface.</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>A few more options are possible, but they are pretty specific to some
|
||
engines, and so won’t be described here.</p>
|
||
</div>
|
||
</section>
|
||
<section id="use-default-settings">
|
||
<span id="settings-use-default-settings"></span><h2><a class="toc-backref" href="#id9" role="doc-backlink">use_default_settings</a><a class="headerlink" href="#use-default-settings" title="Permalink to this heading">¶</a></h2>
|
||
<aside class="sidebar">
|
||
<p class="sidebar-title"><code class="docutils literal notranslate"><span class="pre">use_default_settings:</span> <span class="pre">True</span></code></p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#settings-location"><span class="std std-ref">settings.yml location</span></a></p></li>
|
||
<li><p><a class="reference internal" href="installation-searx.html#use-default-settings-yml"><span class="std std-ref">Configuration</span></a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/searx/searx/blob/master/utils/templates/etc/searx/use_default_settings.yml">/etc/searx/settings.yml</a></p></li>
|
||
</ul>
|
||
</aside>
|
||
<p>The user defined <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> is loaded from the <a class="reference internal" href="#settings-location"><span class="std std-ref">settings.yml location</span></a>
|
||
and can relied on the default configuration <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">Origin: searx/settings.yml</a> using:</p>
|
||
<blockquote>
|
||
<div><p><code class="docutils literal notranslate"><span class="pre">use_default_settings:</span> <span class="pre">True</span></code></p>
|
||
</div></blockquote>
|
||
<dl>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">server:</span></code></dt><dd><p>In the following example, the actual settings are the default settings defined
|
||
in <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">Origin: searx/settings.yml</a> with the exception of the <code class="docutils literal notranslate"><span class="pre">secret_key</span></code> and
|
||
the <code class="docutils literal notranslate"><span class="pre">bind_address</span></code>:</p>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||
<span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">bind_address</span><span class="p">:</span><span class="w"> </span><span class="s">"0.0.0.0"</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">engines:</span></code></dt><dd><p>With <code class="docutils literal notranslate"><span class="pre">use_default_settings:</span> <span class="pre">True</span></code>, each settings can be override in a
|
||
similar way, the <code class="docutils literal notranslate"><span class="pre">engines</span></code> section is merged according to the engine
|
||
<code class="docutils literal notranslate"><span class="pre">name</span></code>. In this example, searx will load all the engine and the arch linux
|
||
wiki engine has a <a class="reference internal" href="../blog/private-engines.html#private-engines"><span class="std std-ref">token</span></a>:</p>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||
<span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span><span class="w"></span>
|
||
<span class="nt">engines</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">tokens</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">engines:</span></code> / <code class="docutils literal notranslate"><span class="pre">remove:</span></code></dt><dd><p>It is possible to remove some engines from the default settings. The following
|
||
example is similar to the above one, but searx doesn’t load the the google
|
||
engine:</p>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">engines</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">remove</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google</span><span class="w"></span>
|
||
<span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span><span class="w"></span>
|
||
<span class="nt">engines</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">tokens</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
<dt><code class="docutils literal notranslate"><span class="pre">engines:</span></code> / <code class="docutils literal notranslate"><span class="pre">keep_only:</span></code></dt><dd><p>As an alternative, it is possible to specify the engines to keep. In the
|
||
following example, searx has only two engines:</p>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">engines</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">keep_only</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">duckduckgo</span><span class="w"></span>
|
||
<span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">secret_key</span><span class="p">:</span><span class="w"> </span><span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span><span class="w"></span>
|
||
<span class="nt">engines</span><span class="p">:</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">google</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">tokens</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">duckduckgo</span><span class="w"></span>
|
||
<span class="w"> </span><span class="nt">tokens</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span><span class="w"></span>
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<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://searx.github.io/searx/blog/index.html">Blog</a>
|
||
|
||
<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://twitter.com/Searx_engine">Twitter</a>
|
||
|
||
<li><a href="https://github.com/searx/searx/issues">Issue Tracker</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="update-searx.html" title="previous chapter">How to update</a>
|
||
<li>Next: <a href="api.html" title="next chapter">Administration API</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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2015-2022, Adam Tauber, Noémi Ványi.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.2.2.
|
||
</div>
|
||
<script src="../_static/version_warning_offset.js"></script>
|
||
|
||
</body>
|
||
</html> |