mirror of
https://github.com/searxng/searxng.git
synced 2025-12-25 13:10:01 +00:00
[doc] build from commit b876d0bed0
This commit is contained in:
inetol
239
admin/settings/settings_brand.html
Normal file
239
admin/settings/settings_brand.html
Normal file
@@ -0,0 +1,239 @@
|
||||
<!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>brand: — SearXNG Documentation (2025.11.21+b876d0bed)</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
|
||||
<script src="../../_static/documentation_options.js?v=65dad236"></script>
|
||||
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.11.21+b876d0bed" 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="general:" href="settings_general.html" />
|
||||
<link rel="prev" title="engines:" href="settings_engines.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_general.html" title="general:"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="settings_engines.html" title="engines:"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.11.21+b876d0bed)</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">brand:</span></code></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="brand">
|
||||
<span id="settings-brand"></span><h1><code class="docutils literal notranslate"><span class="pre">brand:</span></code><a class="headerlink" href="#brand" title="Link to this heading">¶</a></h1>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.brand.</span></span><span class="sig-name descname"><span class="pre">SettingsBrand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issue_url:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'https://github.com/searxng/searxng/issues'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">docs_url:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'https://docs.searxng.org'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_instances:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'https://searx.space'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wiki_url:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'https://github.com/searxng/searxng/wiki'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom:</span> <span class="pre">~searx.brand.BrandCustom</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_issue_url:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'https://github.com/searxng/searxng/issues/new'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/brand.html#SettingsBrand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.brand.SettingsBrand" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Options for configuring brand properties.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">brand</span><span class="p">:</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/searxng/searxng/issues</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://docs.searxng.org</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="nt">wiki_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://github.com/searxng/searxng/wiki</span>
|
||||
|
||||
<span class="w"> </span><span class="nt">custom</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">links</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">Uptime</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://uptime.searxng.org/history/example-org</span>
|
||||
<span class="w"> </span><span class="nt">About</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://example.org/user/about.html</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.issue_url">
|
||||
<span class="sig-name descname"><span class="pre">issue_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.brand.SettingsBrand.issue_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If you host your own issue tracker change this URL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.docs_url">
|
||||
<span class="sig-name descname"><span class="pre">docs_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.brand.SettingsBrand.docs_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If you host your own documentation change this URL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.public_instances">
|
||||
<span class="sig-name descname"><span class="pre">public_instances</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.brand.SettingsBrand.public_instances" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If you host your own <a class="reference external" href="https://searx.space">https://searx.space</a> change this URL.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.wiki_url">
|
||||
<span class="sig-name descname"><span class="pre">wiki_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.brand.SettingsBrand.wiki_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Link to your wiki (or <code class="docutils literal notranslate"><span class="pre">false</span></code>)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.custom">
|
||||
<span class="sig-name descname"><span class="pre">custom</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">BrandCustom</span></em><a class="headerlink" href="#searx.brand.SettingsBrand.custom" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Optional customizing.</p>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.BrandCustom">
|
||||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BrandCustom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">links:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str]</span> <span class="pre">=</span> <span class="pre"><factory></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#searx.brand.SettingsBrand.BrandCustom" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Custom settings in the brand section.</p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.BrandCustom.BrandCustom.links">
|
||||
<span class="sig-prename descclassname"><span class="pre">BrandCustom.</span></span><span class="sig-name descname"><span class="pre">links</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.brand.SettingsBrand.BrandCustom.BrandCustom.links" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>Custom entries in the footer of the WEB page: <code class="docutils literal notranslate"><span class="pre">[title]:</span> <span class="pre">[link]</span></code></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="searx.brand.SettingsBrand.new_issue_url">
|
||||
<span class="sig-name descname"><span class="pre">new_issue_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.brand.SettingsBrand.new_issue_url" title="Link to this definition">¶</a></dt>
|
||||
<dd><p>If you host your own issue tracker not on GitHub, then unset this URL.</p>
|
||||
<p>Note: This URL will create a pre-filled GitHub bug report form for an
|
||||
engine. Since this feature is implemented only for GH (and limited to
|
||||
engines), it will probably be replaced by another solution in the near
|
||||
future.</p>
|
||||
</dd></dl>
|
||||
|
||||
</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_engines.html"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a></li>
|
||||
<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">brand:</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#searx.brand.SettingsBrand"><code class="docutils literal notranslate"><span class="pre">SettingsBrand</span></code></a><ul>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.issue_url"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.issue_url</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.docs_url"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.docs_url</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.public_instances"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.public_instances</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.wiki_url"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.wiki_url</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.custom"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.custom</span></code></a></li>
|
||||
<li class="toctree-l5"><a class="reference internal" href="#searx.brand.SettingsBrand.new_issue_url"><code class="docutils literal notranslate"><span class="pre">SettingsBrand.new_issue_url</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="settings_general.html"><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_valkey.html"><code class="docutils literal notranslate"><span class="pre">valkey:</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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="settings_plugins.html"><code class="docutils literal notranslate"><span class="pre">plugins:</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">Installation 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-granian.html">Granian</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">List of plugins</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_engines.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">engines:</span></code></a>
|
||||
<li>Next: <a href="settings_general.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">general:</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_brand.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>
|
||||
Reference in New Issue
Block a user