<li><p><aclass="reference external"href="https://docs.nginx.com/nginx/admin-guide/web-server/web-server/#setting-up-virtual-servers">nginx server configuration</a></p></li>
<li><p><aclass="reference external"href="https://www.nginx.com/resources/wiki/start/">Getting Started wiki</a></p></li>
<li><p><aclass="reference external"href="https://uwsgi-docs.readthedocs.io/en/latest/Nginx.html">uWSGI support from nginx</a></p></li>
<p>Now you have to create a configuration for the searx site. If <aclass="reference external"href="https://docs.nginx.com/nginx/admin-guide/">nginx</a> is new to
you, the <aclass="reference external"href="http://nginx.org/en/docs/beginners_guide.html">nginx beginners guide</a> is a good starting point and the <aclass="reference external"href="https://www.nginx.com/resources/wiki/start/">Getting
you, the <aclass="reference external"href="https://nginx.org/en/docs/beginners_guide.html">nginx beginners guide</a> is a good starting point and the <aclass="reference external"href="https://www.nginx.com/resources/wiki/start/">Getting
Started wiki</a> is always a good resource <em>to keep in the pocket</em>.</p>
<divclass="sphinx-tabs docutils container">
<divclass="ui top attached tabular menu sphinx-menu docutils container">
<dt><codeclass="docutils literal notranslate"><spanclass="pre">proxies</span></code> :</dt><dd><p>Define one or more proxies you wish to use, see <aclass="reference external"href="http://requests.readthedocs.io/en/latest/user/advanced/#proxies">requests proxies</a>.
<dt><codeclass="docutils literal notranslate"><spanclass="pre">proxies</span></code> :</dt><dd><p>Define one or more proxies you wish to use, see <aclass="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>
<p>has been moved from <codeclass="docutils literal notranslate"><spanclass="pre">gh-branch</span></code> into <codeclass="docutils literal notranslate"><spanclass="pre">master</span></code> (<aclass="reference external"href="https://github.com/searx/searx/blob/master/docs">git://docs</a>).</p>
</div>
<p>The documentation is built using <aclass="reference external"href="http://www.sphinx-doc.org">Sphinx</a>. So in order to be able to generate
<p>The documentation is built using <aclass="reference external"href="https://www.sphinx-doc.org">Sphinx</a>. So in order to be able to generate
the required files, you have to install it on your system. Much easier, use
<h2>How to compile styles and javascript<aclass="headerlink"href="#how-to-compile-styles-and-javascript"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="how-to-build-styles">
<h3>How to build styles<aclass="headerlink"href="#how-to-build-styles"title="Permalink to this headline">¶</a></h3>
<p><aclass="reference external"href="http://lesscss.org/">Less</a> is required to build the styles of searx. <aclass="reference external"href="http://lesscss.org/">Less</a> can be installed using
<p><aclass="reference external"href="https://lesscss.org/">Less</a> is required to build the styles of searx. <aclass="reference external"href="https://lesscss.org/">Less</a> can be installed using
either <aclass="reference external"href="https://nodejs.org">NodeJS</a> or Apt.</p>
contributors to follow principles like <aclass="reference external"href="https://en.wikipedia.org/wiki/KISS_principle">KISS</a> and <aclass="reference external"href="https://docs.python-guide.org/writing/style/">readability</a>.</p>
</div>
<p>We at searx are using reStructuredText (aka <aclass="reference external"href="https://docutils.sourceforge.io/rst.html">reST</a>) markup for all kind of
documentation, with the builders from the <aclass="reference external"href="http://www.sphinx-doc.org">Sphinx</a> project a HTML output is
documentation, with the builders from the <aclass="reference external"href="https://www.sphinx-doc.org">Sphinx</a> project a HTML output is
generated and deployed at <aclass="reference external"href="https://searx.github.io/searx/.">github.io</a>. For build prerequisites read
<p>The source files of Searx’s documentation are located at <aclass="reference external"href="https://github.com/searx/searx/blob/master/docs">git://docs</a>. Sphinx
@ -67,17 +67,17 @@ assumes source files to be encoded in UTF-8 by defaul. Run <a class="reference
<p><aclass="reference external"href="http://www.sphinx-doc.org">Sphinx</a> and <aclass="reference external"href="https://docutils.sourceforge.io/rst.html">reST</a> have their place in the python ecosystem. Over that reST is
<p><aclass="reference external"href="https://www.sphinx-doc.org">Sphinx</a> and <aclass="reference external"href="https://docutils.sourceforge.io/rst.html">reST</a> have their place in the python ecosystem. Over that reST is
used in popular projects, e.g the Linux kernel documentation <aclass="reference external"href="https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html">[kernel doc]</a>.</p>
<divclass="sidebar">
<pclass="sidebar-title">Content matters</p>
@ -358,10 +358,10 @@ Lists</a>.</p>
</div>
<divclass="section"id="smart-refs">
<spanid="rest-smart-ref"></span><h3><aclass="toc-backref"href="#id23">Smart refs</a><aclass="headerlink"href="#smart-refs"title="Permalink to this headline">¶</a></h3>
<p>With the power of <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="http://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a> referencing external
<p>With the power of <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="https://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a> referencing external
<caption><spanclass="caption-number">Table 4 </span><spanclass="caption-text">smart refs with <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="http://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a></span><aclass="headerlink"href="#id5"title="Permalink to this table">¶</a></caption>
<caption><spanclass="caption-number">Table 4 </span><spanclass="caption-text">smart refs with <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="https://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a></span><aclass="headerlink"href="#id5"title="Permalink to this table">¶</a></caption>
<h2><aclass="toc-backref"href="#id24">Literal blocks</a><aclass="headerlink"href="#literal-blocks"title="Permalink to this headline">¶</a></h2>
<p>The simplest form of <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks">literal-blocks</a> is a indented block introduced by
two colons (<codeclass="docutils literal notranslate"><spanclass="pre">::</span></code>). For highlighting use <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#highlight">highlight</a> or <aclass="reference internal"href="#rest-code"><spanclass="std std-ref">code-block</span></a> directive. To include literals from external files use
<p>The simplest form of <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks">literal-blocks</a> is a indented block introduced by
two colons (<codeclass="docutils literal notranslate"><spanclass="pre">::</span></code>). For highlighting use <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#highlight">highlight</a> or <aclass="reference internal"href="#rest-code"><spanclass="std std-ref">code-block</span></a> directive. To include literals from external files use
directive (latter one expands environment variables in the path name).</p>
<divclass="section"id="rest-literal">
@ -492,7 +492,7 @@ eirmod tempor invidunt ut labore</p>
<pclass="sidebar-title">Syntax highlighting</p>
<p>is handled by <aclass="reference external"href="https://pygments.org/languages/">pygments</a>.</p>
</div>
<p>The <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block"title="(in Sphinx v4.0.0+)"><codeclass="xref rst rst-dir docutils literal notranslate"><spanclass="pre">code-block</span></code></a> directive is a variant of the <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#code">code</a> directive
<p>The <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block"title="(in Sphinx v4.0.0+)"><codeclass="xref rst rst-dir docutils literal notranslate"><spanclass="pre">code-block</span></code></a> directive is a variant of the <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#code">code</a> directive
with additional options. To learn more about code literals visit
<divclass="highlight-reST notranslate"><divclass="highlight"><pre><span></span>The URL <spanclass="s">``/stats``</span> handle is shown in <spanclass="na">:ref:</span><spanclass="nv">`stats-handle`</span>
@ -533,7 +533,7 @@ with additional options. To learn more about code literals visit
</div>
<divclass="section"id="unicode-substitution">
<h2><aclass="toc-backref"href="#id27">Unicode substitution</a><aclass="headerlink"href="#unicode-substitution"title="Permalink to this headline">¶</a></h2>
<p>A <em>custom interpreted text role</em> (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#roles">ref</a>) is an inline piece of
<p>A <em>custom interpreted text role</em> (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#roles">ref</a>) is an inline piece of
explicit markup. It signifies that that the enclosed text should be interpreted
<caption><spanclass="caption-number">Table 5 </span><spanclass="caption-text">smart refs with <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="http://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a></span><aclass="headerlink"href="#id6"title="Permalink to this table">¶</a></caption>
<caption><spanclass="caption-number">Table 5 </span><spanclass="caption-text">smart refs with <aclass="reference external"href="https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html">sphinx.ext.extlinks</a> and <aclass="reference external"href="https://www.sphinx-doc.org/en/stable/ext/intersphinx.html">intersphinx</a></span><aclass="headerlink"href="#id6"title="Permalink to this table">¶</a></caption>
@ -648,7 +648,7 @@ about the build process when handling with images, especially since he has no
access to the build process. With <aclass="reference external"href="https://return42.github.io/linuxdoc/linuxdoc-howto/kfigure.html#kfigure"title="(in LinuxDoc v20200812)"><span>Scalable figure and image handling</span></a> the build process
continues and scales output quality in dependence of installed image processors.</p>
<p>If you want to add an image, you should use the <codeclass="docutils literal notranslate"><spanclass="pre">kernel-figure</span></code> (inheritance
of <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure">figure</a>) and <codeclass="docutils literal notranslate"><spanclass="pre">kernel-image</span></code> (inheritance of <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#image">image</a>)
of <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#figure">figure</a>) and <codeclass="docutils literal notranslate"><spanclass="pre">kernel-image</span></code> (inheritance of <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#image">image</a>)
directives. E.g. to insert a figure with a scaleable image format use SVG
@ -759,7 +759,7 @@ installed, you will see an vector image. If not, the raw markup is inserted as
<spanid="rest-lists"></span><h2><aclass="toc-backref"href="#id33">List markups</a><aclass="headerlink"href="#list-markups"title="Permalink to this headline">¶</a></h2>
<divclass="section"id="bullet-list">
<h3><aclass="toc-backref"href="#id34">Bullet list</a><aclass="headerlink"href="#bullet-list"title="Permalink to this headline">¶</a></h3>
<p>List markup (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists">ref</a>) is simple:</p>
<p>List markup (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists">ref</a>) is simple:</p>
<divclass="highlight-reST notranslate"><divclass="highlight"><pre><span></span><spanclass="m">-</span> This is a bulleted list.
<spanclass="m">1.</span> Nested lists are possible, but be aware that they must be separated from
@ -827,11 +827,11 @@ list.</p>
<ulclass="simple">
<li><p>the term cannot have more than one line of text</p></li>
<li><p>there is <strong>no blank line between term and definition block</strong> // this
distinguishes definition lists (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists">ref</a>) from block
<p>Each definition list (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists">ref</a>) item contains a term,
<p>Each definition list (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists">ref</a>) item contains a term,
optional classifiers and a definition. A term is a simple one-line word or
phrase. Optional classifiers may follow the term on the same line, each after
an inline ‘ : ‘ (<strong>space, colon, space</strong>). A definition is a block indented
@ -872,7 +872,7 @@ term 4 : classifier one : classifier two
<blockquote>
<div><p>And this is not term’s definition. <strong>There is a blank line</strong> in between
the line above and this paragraph. That’s why this paragraph is taken as
<strong>block quote</strong> (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes">ref</a>) and not as term’s definition!</p>
<strong>block quote</strong> (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes">ref</a>) and not as term’s definition!</p>
@ -886,8 +886,8 @@ the line above and this paragraph. That’s why this paragraph is taken as
</div>
<divclass="section"id="quoted-paragraphs">
<h3><aclass="toc-backref"href="#id37">Quoted paragraphs</a><aclass="headerlink"href="#quoted-paragraphs"title="Permalink to this headline">¶</a></h3>
<p>Quoted paragraphs (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes">ref</a>) are created by just indenting
them more than the surrounding paragraphs. Line blocks (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#line-blocks">ref</a>) are a way of preserving line breaks:</p>
<p>Quoted paragraphs (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes">ref</a>) are created by just indenting
them more than the surrounding paragraphs. Line blocks (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#line-blocks">ref</a>) are a way of preserving line breaks:</p>
@ -961,11 +961,11 @@ are mappings from field names to field bodies. They marked up like this:</p>
<divclass="section"id="further-list-blocks">
<h3><aclass="toc-backref"href="#id39">Further list blocks</a><aclass="headerlink"href="#further-list-blocks"title="Permalink to this headline">¶</a></h3>
<ulclass="simple">
<li><p>field lists (<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists">ref</a>, with caveats noted in
<li><p>field lists (<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists">ref</a>, with caveats noted in
@ -984,7 +984,7 @@ site effects. Here is the source of the sidebar <a class="reference internal" h
</div>
<divclass="section"id="generic-admonition">
<h3><aclass="toc-backref"href="#id42">Generic admonition</a><aclass="headerlink"href="#generic-admonition"title="Permalink to this headline">¶</a></h3>
<p>The generic <aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions">admonition</a> needs a title:</p>
<p>The generic <aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions">admonition</a> needs a title:</p>
<divclass="highlight-reST notranslate"><divclass="highlight"><pre><span></span><spanclass="p">..</span><spanclass="ow">admonition</span><spanclass="p">::</span> generic admonition title
lorem ipsum ..
@ -997,9 +997,9 @@ site effects. Here is the source of the sidebar <a class="reference internal" h
</div>
<divclass="section"id="specific-admonitions">
<h3><aclass="toc-backref"href="#id43">Specific admonitions</a><aclass="headerlink"href="#specific-admonitions"title="Permalink to this headline">¶</a></h3>
<spanid="rest-simple-table"></span><h3><aclass="toc-backref"href="#id45">Simple tables</a><aclass="headerlink"href="#simple-tables"title="Permalink to this headline">¶</a></h3>
<p><aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple-tables">Simple tables</a> allow <em>colspan</em> but not <em>rowspan</em>. If
<p><aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#simple-tables">Simple tables</a> allow <em>colspan</em> but not <em>rowspan</em>. If
your table need some metadata (e.g. a title) you need to add the <codeclass="docutils literal notranslate"><spanclass="pre">..</span><spanclass="pre">table::</span>
<spanclass="pre">directive</span></code><aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#table">(ref)</a> in front and place the table in its body:</p>
<spanclass="pre">directive</span></code><aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#table">(ref)</a> in front and place the table in its body:</p>
<divclass="highlight-reST notranslate"><divclass="highlight"><pre><span></span><spanclass="p">..</span><spanclass="ow">table</span><spanclass="p">::</span> foo gate truth table
@ -1139,7 +1139,7 @@ your table need some metadata (e.g. a title) you need to add the <code class="do
</div>
<divclass="section"id="grid-tables">
<spanid="rest-grid-table"></span><h3><aclass="toc-backref"href="#id46">Grid tables</a><aclass="headerlink"href="#grid-tables"title="Permalink to this headline">¶</a></h3>
<p><aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables">Grid tables</a> allow colspan <em>colspan</em> and <em>rowspan</em>:</p>
<p><aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables">Grid tables</a> allow colspan <em>colspan</em> and <em>rowspan</em>:</p>
<divclass="highlight-reST notranslate"><divclass="highlight"><pre><span></span><spanclass="p">..</span><spanclass="ow">table</span><spanclass="p">::</span> grid table example
<spanid="rest-flat-table"></span><h3><aclass="toc-backref"href="#id47">flat-table</a><aclass="headerlink"href="#flat-table"title="Permalink to this headline">¶</a></h3>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">flat-table</span></code> is a further developed variant of the <aclass="reference external"href="https://return42.github.io/linuxdoc/linuxdoc-howto/table-markup.html#list-table-directives"title="(in LinuxDoc v20200812)"><spanclass="xref std std-ref">list tables</span></a>. It is a double-stage list similar to the
<aclass="reference external"href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table">list-table</a> with some additional features:</p>
<aclass="reference external"href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table">list-table</a> with some additional features:</p>
<dlclass="simple">
<dt>column-span: <codeclass="docutils literal notranslate"><spanclass="pre">cspan</span></code></dt><dd><p>with the role <codeclass="docutils literal notranslate"><spanclass="pre">cspan</span></code> a cell can be extended through additional columns</p>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.