mirror of https://github.com/searxng/searxng.git
188 lines
13 KiB
HTML
188 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
<html lang="en" data-content_root="../../">
|
|||
|
|
<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>general: — SearXNG Documentation (2024.11.26+78f530083)</title>
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=4f649999" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../_static/autodoc_pydantic.css" />
|
|||
|
|
<script src="../../_static/documentation_options.js?v=3ecd03f6"></script>
|
|||
|
|
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
|||
|
|
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|||
|
|
<script data-project="searxng" data-version="2024.11.26+78f530083" src="../../_static/describe_version.js?v=fa7f30d0"></script>
|
|||
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|||
|
|
<link rel="next" title="search:" href="settings_search.html" />
|
|||
|
|
<link rel="prev" title="brand:" href="settings_brand.html" />
|
|||
|
|
</head><body>
|
|||
|
|
<div class="related" role="navigation" aria-label="Related">
|
|||
|
|
<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="settings_search.html" title="search:"
|
|||
|
|
accesskey="N">next</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="settings_brand.html" title="brand:"
|
|||
|
|
accesskey="P">previous</a> |</li>
|
|||
|
|
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2024.11.26+78f530083)</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-1"><a href="../index.html" >Administrator documentation</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Settings</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="document">
|
|||
|
|
<div class="documentwrapper">
|
|||
|
|
<div class="bodywrapper">
|
|||
|
|
<div class="body" role="main">
|
|||
|
|
|
|||
|
|
<section id="general">
|
|||
|
|
<span id="settings-general"></span><h1><code class="docutils literal notranslate"><span class="pre">general:</span></code><a class="headerlink" href="#general" title="Link to this heading">¶</a></h1>
|
|||
|
|
<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="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="nt">instance_name</span><span class="p">:</span><span class="w"> </span><span class="s">"SearXNG"</span>
|
|||
|
|
<span class="w"> </span><span class="nt">privacypolicy_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="nt">donation_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="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="nt">enable_metrics</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">open_metrics</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<dl>
|
|||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">debug</span></code><span class="classifier"><code class="docutils literal notranslate"><span class="pre">$SEARXNG_DEBUG</span></code></span></dt><dd><p>Allow a more detailed log if you run SearXNG 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">donation_url</span></code> :</dt><dd><p>Set value to <code class="docutils literal notranslate"><span class="pre">true</span></code> to use your own donation page written in the
|
|||
|
|
<a class="reference internal" href="../../src/searx.infopage.html#searx-infopage"><span class="std std-ref">searx/info/en/donate.md</span></a> and use <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable
|
|||
|
|
the donation link altogether.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">privacypolicy_url</span></code>:</dt><dd><p>Link to privacy policy.</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">enable_metrics</span></code>:</dt><dd><p>Enabled by default. Record various anonymous metrics available at <code class="docutils literal notranslate"><span class="pre">/stats</span></code>,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">/stats/errors</span></code> and <code class="docutils literal notranslate"><span class="pre">/preferences</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">open_metrics</span></code>:</dt><dd><p>Disabled by default. Set to a secret password to expose an
|
|||
|
|
<a class="reference external" href="https://github.com/prometheus/OpenMetrics">OpenMetrics API</a> at <code class="docutils literal notranslate"><span class="pre">/metrics</span></code>,
|
|||
|
|
e.g. for usage with Prometheus. The <code class="docutils literal notranslate"><span class="pre">/metrics</span></code> endpoint is using HTTP Basic Auth,
|
|||
|
|
where the password is the value of <code class="docutils literal notranslate"><span class="pre">open_metrics</span></code> set above. The username used for
|
|||
|
|
Basic Auth can be randomly chosen as only the password is being validated.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<span id="sidebar-top"></span>
|
|||
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|||
|
|
<div class="sphinxsidebarwrapper">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="logo"><a href="../../index.html">
|
|||
|
|
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
|
|||
|
|
</a></p>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h3><a href="../../index.html">Table of Contents</a></h3>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator documentation</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Settings</a><ul class="current">
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_engine.html"><code class="docutils literal notranslate"><span class="pre">engine:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_brand.html"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_search.html"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_server.html"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_ui.html"><code class="docutils literal notranslate"><span class="pre">ui:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_redis.html"><code class="docutils literal notranslate"><span class="pre">redis:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_outgoing.html"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="settings_categories_as_tabs.html"><code class="docutils literal notranslate"><span class="pre">categories_as_tabs:</span></code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation.html">Installation</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-docker.html">Docker Container</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-scripts.html">Installation Script</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-searxng.html">Step by step installation</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-uwsgi.html">uWSGI</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-nginx.html">NGINX</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../installation-apache.html">Apache</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../update-searxng.html">SearXNG maintenance</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../answer-captcha.html">Answer CAPTCHA from server’s IP</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../searx.favicons.html">Favicons</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../searx.limiter.html">Limiter</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../api.html">Administration API</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../architecture.html">Architecture</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../plugins.html">Plugins builtin</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="../buildhosts.html">Buildhosts</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../dev/index.html">Developer documentation</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h3>Project Links</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://searx.space">Public instances</a>
|
|||
|
|
|
|||
|
|
<li><a href="https://github.com/searxng/searxng/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><a href="index.html">Settings</a>
|
|||
|
|
<ul>
|
|||
|
|
<li>Previous: <a href="settings_brand.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a>
|
|||
|
|
<li>Next: <a href="settings_search.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">search:</span></code></a></ul>
|
|||
|
|
</li></ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<search 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>
|
|||
|
|
</search>
|
|||
|
|
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|||
|
|
<div role="note" aria-label="source link">
|
|||
|
|
<h3>This Page</h3>
|
|||
|
|
<ul class="this-page-menu">
|
|||
|
|
<li><a href="../../_sources/admin/settings/settings_general.rst.txt"
|
|||
|
|
rel="nofollow">Show Source</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="footer" role="contentinfo">
|
|||
|
|
© Copyright SearXNG team.
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|