mirror of https://github.com/searx/searx
Deploying to gh-pages from @ cb3b379161
🚀
This commit is contained in:
parent
e536fe369e
commit
4d607f4284
|
@ -1,5 +1,10 @@
|
|||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
|
||||
.highlight .g { color: #000000 } /* Generic */
|
||||
|
@ -55,8 +60,10 @@
|
|||
.highlight .mh { color: #990000 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #990000 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #990000 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
|
||||
|
@ -67,7 +74,9 @@
|
|||
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #000000 } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #000000 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #000000 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
|
|
@ -82,10 +82,10 @@ searched.</p>
|
|||
<li><p>the Recoll search inteface can be reached at <a class="reference external" href="https://recoll.example.org/">https://recoll.example.org/</a> and</p></li>
|
||||
<li><p>the contents of this filesystem can be reached though <a class="reference external" href="https://download.example.org/reference">https://download.example.org/reference</a></p></li>
|
||||
</ol>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">base_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">mount_prefix</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">/export/documents</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dl_prefix</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">search_dir</span><span class="p p-Indicator">:</span> <span class="s">''</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">base_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span>
|
||||
<span class="nt">mount_prefix</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">/export/documents</span>
|
||||
<span class="nt">dl_prefix</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://download.example.org</span>
|
||||
<span class="nt">search_dir</span><span class="p">:</span> <span class="s">''</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -251,13 +251,13 @@ figure: <a class="reference internal" href="architecture.html#arch-public"><span
|
|||
</div>
|
||||
<p>For a fully result proxification add <a class="reference internal" href="morty.html#searx-morty"><span class="std std-ref">morty’s</span></a> <strong>public
|
||||
URL</strong> to your <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">git://searx/settings.yml</a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">result_proxy</span><span class="p p-Indicator">:</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">result_proxy</span><span class="p">:</span>
|
||||
<span class="c1"># replace example.org with your server's public name</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">url</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/morty</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">key</span> <span class="p p-Indicator">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
<span class="nt">url </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/morty</span>
|
||||
<span class="nt">key </span><span class="p">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image_proxy</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">image_proxy </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></div>
|
||||
|
|
|
@ -66,7 +66,7 @@
|
|||
<h2><a class="toc-backref" href="#id1">Docker image searx/searx</a><a class="headerlink" href="#docker-image-searx-searx" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The docker image is <a class="reference external" href="https://hub.docker.com/r/searx/searx">searx/searx</a> (based on <a class="reference external" href="https://github.com/searx/searx">github.com/searx/searx</a>).</p>
|
||||
<p>Make sure you have <a class="reference external" href="https://docs.docker.com/get-docker/">installed Docker</a>. For instance, you can deploy a local instance:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">PORT</span><span class="o">=</span>80
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span> <span class="nv">PORT</span><span class="o">=</span><span class="m">80</span>
|
||||
docker pull searx/searx
|
||||
docker run --rm -d -v <span class="si">${</span><span class="nv">PWD</span><span class="si">}</span>/searx:/etc/searx -p <span class="nv">$PORT</span>:8080 -e <span class="nv">BASE_URL</span><span class="o">=</span>http://localhost:<span class="nv">$PORT</span>/ searx/searx
|
||||
</pre></div>
|
||||
|
|
|
@ -196,13 +196,13 @@ figure: <a class="reference internal" href="architecture.html#arch-public"><span
|
|||
</div>
|
||||
<p>For a fully result proxification add <a class="reference internal" href="morty.html#searx-morty"><span class="std std-ref">morty’s</span></a> <strong>public
|
||||
URL</strong> to your <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">git://searx/settings.yml</a>:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">result_proxy</span><span class="p p-Indicator">:</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">result_proxy</span><span class="p">:</span>
|
||||
<span class="c1"># replace example.org with your server's public name</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">url</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/morty</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">key</span> <span class="p p-Indicator">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
<span class="nt">url </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/morty</span>
|
||||
<span class="nt">key </span><span class="p">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image_proxy</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">image_proxy </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div><div aria-labelledby="tab-3-cHJveHkgb3IgdVdTR0k=" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-3-cHJveHkgb3IgdVdTR0k=" name="cHJveHkgb3IgdVdTR0k=" role="tabpanel" tabindex="0"><p>Be warned, with this setup, your instance isn’t <a class="reference internal" href="filtron.html#searx-filtron"><span class="std std-ref">protected</span></a>. Nevertheless it is good enough for intranet usage and it is a
|
||||
|
@ -295,9 +295,9 @@ value is shipped via the <a class="reference external" href="https://werkzeug.pa
|
|||
</div>
|
||||
<p>For searx to work correctly the <code class="docutils literal notranslate"><span class="pre">base_url</span></code> must be set in the
|
||||
<a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">git://searx/settings.yml</a>.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">server</span><span class="p">:</span>
|
||||
<span class="c1"># replace example.org with your server's public name</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">base_url</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/searx/</span>
|
||||
<span class="nt">base_url </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://example.org/searx/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></div>
|
||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -197,7 +197,7 @@ disable: sudo -H rm /etc/uwsgi.d/searx.ini
|
|||
disable-logging <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># The right granted on the created socket</span>
|
||||
chmod-socket <span class="o">=</span> 666
|
||||
chmod-socket <span class="o">=</span> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
@ -245,7 +245,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
|
||||
<span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
|
||||
|
||||
<span class="nv">http</span> <span class="o">=</span> 127.0.0.1:8888
|
||||
<span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
|
||||
|
||||
<span class="c1"># using unix-sockets:</span>
|
||||
<span class="c1">#</span>
|
||||
|
@ -257,7 +257,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
|
||||
|
||||
<span class="c1"># Cache</span>
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span>2000,blocks<span class="o">=</span>2000,blocksize<span class="o">=</span>4096,bitmap<span class="o">=</span>1
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div><div aria-labelledby="tab-1-QXJjaCBMaW51eA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-1-QXJjaCBMaW51eA==" name="QXJjaCBMaW51eA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>uwsgi<span class="o">]</span>
|
||||
|
@ -287,7 +287,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
disable-logging <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># The right granted on the created socket</span>
|
||||
chmod-socket <span class="o">=</span> 666
|
||||
chmod-socket <span class="o">=</span> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
@ -335,7 +335,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
|
||||
<span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
|
||||
|
||||
<span class="nv">http</span> <span class="o">=</span> 127.0.0.1:8888
|
||||
<span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
|
||||
|
||||
<span class="c1"># using unix-sockets:</span>
|
||||
<span class="c1">#</span>
|
||||
|
@ -347,7 +347,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
|
||||
|
||||
<span class="c1"># Cache</span>
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span>2000,blocks<span class="o">=</span>2000,blocksize<span class="o">=</span>4096,bitmap<span class="o">=</span>1
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div><div aria-labelledby="tab-1-RmVkb3JhIC8gUkhFTA==" class="sphinx-tabs-panel group-tab" hidden="true" id="panel-1-RmVkb3JhIC8gUkhFTA==" name="RmVkb3JhIC8gUkhFTA==" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>uwsgi<span class="o">]</span>
|
||||
|
@ -376,7 +376,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
disable-logging <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># The right granted on the created socket</span>
|
||||
chmod-socket <span class="o">=</span> 666
|
||||
chmod-socket <span class="o">=</span> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
@ -424,7 +424,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># https://uwsgi-docs.readthedocs.io/en/latest/Options.html#plugin-http</span>
|
||||
<span class="c1"># Native HTTP support: https://uwsgi-docs.readthedocs.io/en/latest/HTTP.html</span>
|
||||
|
||||
<span class="nv">http</span> <span class="o">=</span> 127.0.0.1:8888
|
||||
<span class="nv">http</span> <span class="o">=</span> <span class="m">127</span>.0.0.1:8888
|
||||
|
||||
<span class="c1"># using unix-sockets:</span>
|
||||
<span class="c1">#</span>
|
||||
|
@ -436,7 +436,7 @@ enable-threads <span class="o">=</span> <span class="nb">true</span>
|
|||
<span class="c1"># socket = /run/uwsgi/app/searx/socket</span>
|
||||
|
||||
<span class="c1"># Cache</span>
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span>2000,blocks<span class="o">=</span>2000,blocksize<span class="o">=</span>4096,bitmap<span class="o">=</span>1
|
||||
<span class="nv">cache2</span> <span class="o">=</span> <span class="nv">name</span><span class="o">=</span>searxcache,items<span class="o">=</span><span class="m">2000</span>,blocks<span class="o">=</span><span class="m">2000</span>,blocksize<span class="o">=</span><span class="m">4096</span>,bitmap<span class="o">=</span><span class="m">1</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div></div>
|
||||
|
|
|
@ -60,9 +60,9 @@ possible to proxify all the result URLs with an external service, <a class="refe
|
|||
<p>To use this feature, morty has to be installed and activated in searx’s
|
||||
<code class="docutils literal notranslate"><span class="pre">settings.yml</span></code>. Add the following snippet to your <code class="docutils literal notranslate"><span class="pre">settings.yml</span></code> and
|
||||
restart searx:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">result_proxy</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">url</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">http://127.0.0.1:3000/</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">key</span> <span class="p p-Indicator">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">result_proxy</span><span class="p">:</span>
|
||||
<span class="nt">url </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">http://127.0.0.1:3000/</span>
|
||||
<span class="nt">key </span><span class="p">:</span> <span class="kt">!!binary</span> <span class="s">"insert_your_morty_proxy_key_here"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Note that the example above (<code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:3000</span></code>) is only for single-user
|
||||
|
|
|
@ -88,17 +88,17 @@ file.</p>
|
|||
<span id="settings-global"></span><h2><a class="toc-backref" href="#id3">Global Settings</a><a class="headerlink" href="#global-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="general">
|
||||
<h3><a class="toc-backref" href="#id4"><code class="docutils literal notranslate"><span class="pre">general:</span></code></a><a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">general</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">debug</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># Debug mode, only for development</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">instance_name</span> <span class="p p-Indicator">:</span> <span class="s">"searx"</span> <span class="c1"># displayed name</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">git_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">git_branch</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">master</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">issue_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/issues</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">docs_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://searx.github.io/searx</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">public_instances</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://searx.space</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">contact_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># mailto:contact@example.com</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">wiki_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/wiki</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">twitter_url</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://twitter.com/Searx_engine</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">general</span><span class="p">:</span>
|
||||
<span class="nt">debug </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># Debug mode, only for development</span>
|
||||
<span class="nt">instance_name </span><span class="p">:</span> <span class="s">"searx"</span> <span class="c1"># displayed name</span>
|
||||
<span class="nt">git_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx</span>
|
||||
<span class="nt">git_branch</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">master</span>
|
||||
<span class="nt">issue_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/issues</span>
|
||||
<span class="nt">docs_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://searx.github.io/searx</span>
|
||||
<span class="nt">public_instances</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://searx.space</span>
|
||||
<span class="nt">contact_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># mailto:contact@example.com</span>
|
||||
<span class="nt">wiki_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/searx/searx/wiki</span>
|
||||
<span class="nt">twitter_url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://twitter.com/Searx_engine</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
|
@ -119,20 +119,20 @@ messages in the browser too, so this must be deactivated in production.</p>
|
|||
</div>
|
||||
<div class="section" id="server">
|
||||
<h3><a class="toc-backref" href="#id5"><code class="docutils literal notranslate"><span class="pre">server:</span></code></a><a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">port</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">8888</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">bind_address</span> <span class="p p-Indicator">:</span> <span class="s">"127.0.0.1"</span> <span class="c1"># address to listen on</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">secret_key</span> <span class="p p-Indicator">:</span> <span class="s">"ultrasecretkey"</span> <span class="c1"># change this!</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">base_url</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># set custom base_url (or False)</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image_proxy</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># proxying image results through searx</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">default_locale</span> <span class="p p-Indicator">:</span> <span class="s">""</span> <span class="c1"># default interface locale</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">default_theme</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">oscar</span> <span class="c1"># ui theme</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">default_http_headers</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">X-Content-Type-Options</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">nosniff</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">X-XSS-Protection</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">1; mode=block</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">X-Download-Options</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">noopen</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">X-Robots-Tag</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">noindex, nofollow</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">Referrer-Policy</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">no-referrer</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">port </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">8888</span>
|
||||
<span class="nt">bind_address </span><span class="p">:</span> <span class="s">"127.0.0.1"</span> <span class="c1"># address to listen on</span>
|
||||
<span class="nt">secret_key </span><span class="p">:</span> <span class="s">"ultrasecretkey"</span> <span class="c1"># change this!</span>
|
||||
<span class="nt">base_url </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># set custom base_url (or False)</span>
|
||||
<span class="nt">image_proxy </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span> <span class="c1"># proxying image results through searx</span>
|
||||
<span class="nt">default_locale </span><span class="p">:</span> <span class="s">""</span> <span class="c1"># default interface locale</span>
|
||||
<span class="nt">default_theme </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">oscar</span> <span class="c1"># ui theme</span>
|
||||
<span class="nt">default_http_headers</span><span class="p">:</span>
|
||||
<span class="nt">X-Content-Type-Options </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">nosniff</span>
|
||||
<span class="nt">X-XSS-Protection </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1; mode=block</span>
|
||||
<span class="nt">X-Download-Options </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">noopen</span>
|
||||
<span class="nt">X-Robots-Tag </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">noindex, nofollow</span>
|
||||
<span class="nt">Referrer-Policy </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">no-referrer</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
|
@ -161,12 +161,12 @@ code, like <code class="docutils literal notranslate"><span class="pre">fr</span
|
|||
</div>
|
||||
<div class="section" id="outgoing">
|
||||
<h3><a class="toc-backref" href="#id6"><code class="docutils literal notranslate"><span class="pre">outgoing:</span></code></a><a class="headerlink" href="#outgoing" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">outgoing</span><span class="p p-Indicator">:</span> <span class="c1"># communication with search engines</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">request_timeout</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">2.0</span> <span class="c1"># default timeout in seconds, can be override by engine</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">outgoing</span><span class="p">:</span> <span class="c1"># communication with search engines</span>
|
||||
<span class="nt">request_timeout </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">2.0</span> <span class="c1"># default timeout in seconds, can be override by engine</span>
|
||||
<span class="c1"># max_request_timeout: 10.0 # the maximum timeout in seconds</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">useragent_suffix</span> <span class="p p-Indicator">:</span> <span class="s">""</span> <span class="c1"># informations like an email address to the administrator</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pool_connections</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">100</span> <span class="c1"># Number of different hosts</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">pool_maxsize</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">10</span> <span class="c1"># Number of simultaneous requests by host</span>
|
||||
<span class="nt">useragent_suffix </span><span class="p">:</span> <span class="s">""</span> <span class="c1"># informations like an email address to the administrator</span>
|
||||
<span class="nt">pool_connections </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">100</span> <span class="c1"># Number of different hosts</span>
|
||||
<span class="nt">pool_maxsize </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">10</span> <span class="c1"># Number of simultaneous requests by host</span>
|
||||
<span class="c1"># uncomment below section if you want to use a proxy</span>
|
||||
<span class="c1"># proxies:</span>
|
||||
<span class="c1"># http:</span>
|
||||
|
@ -208,19 +208,19 @@ be made. This parameter is ignored when <code class="docutils literal notranslat
|
|||
</div>
|
||||
<div class="section" id="locales">
|
||||
<h3><a class="toc-backref" href="#id7"><code class="docutils literal notranslate"><span class="pre">locales:</span></code></a><a class="headerlink" href="#locales" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">locales</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">en</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">English</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">de</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Deutsch</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">he</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Hebrew</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">hu</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Magyar</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">fr</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Français</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">es</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Español</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">it</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Italiano</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">nl</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Nederlands</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ja</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">日本語 (Japanese)</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tr</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Türkçe</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ru</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Russian</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ro</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Romanian</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">locales</span><span class="p">:</span>
|
||||
<span class="nt">en </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">English</span>
|
||||
<span class="nt">de </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Deutsch</span>
|
||||
<span class="nt">he </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Hebrew</span>
|
||||
<span class="nt">hu </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Magyar</span>
|
||||
<span class="nt">fr </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Français</span>
|
||||
<span class="nt">es </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Español</span>
|
||||
<span class="nt">it </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Italiano</span>
|
||||
<span class="nt">nl </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Nederlands</span>
|
||||
<span class="nt">ja </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">日本語 (Japanese)</span>
|
||||
<span class="nt">tr </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Türkçe</span>
|
||||
<span class="nt">ru </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Russian</span>
|
||||
<span class="nt">ro </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Romanian</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
|
@ -237,15 +237,15 @@ be made. This parameter is ignored when <code class="docutils literal notranslat
|
|||
<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>
|
||||
</div>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">bing</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engine</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">bing</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">shortcut</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">bi</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">base_url</span> <span class="p p-Indicator">:</span> <span class="s">'https://{language}.wikipedia.org/'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">categories</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">general</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">timeout</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">3.0</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">api_key</span> <span class="p p-Indicator">:</span> <span class="s">'apikey'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">disabled</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">language</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">en_US</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bing</span>
|
||||
<span class="nt">engine </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bing</span>
|
||||
<span class="nt">shortcut </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bi</span>
|
||||
<span class="nt">base_url </span><span class="p">:</span> <span class="s">'https://{language}.wikipedia.org/'</span>
|
||||
<span class="nt">categories </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">general</span>
|
||||
<span class="nt">timeout </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">3.0</span>
|
||||
<span class="nt">api_key </span><span class="p">:</span> <span class="s">'apikey'</span>
|
||||
<span class="nt">disabled </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="nt">language </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">en_US</span>
|
||||
<span class="c1">#proxies:</span>
|
||||
<span class="c1"># http:</span>
|
||||
<span class="c1"># - http://proxy1:8080</span>
|
||||
|
@ -317,10 +317,10 @@ and can relied on the default configuration <a class="reference external" href="
|
|||
<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">git://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="l l-Scalar l-Scalar-Plain">use_default_settings</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">secret_key</span><span class="p p-Indicator">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">bind_address</span><span class="p p-Indicator">:</span> <span class="s">"0.0.0.0"</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">secret_key</span><span class="p">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="nt">bind_address</span><span class="p">:</span> <span class="s">"0.0.0.0"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
|
@ -328,44 +328,44 @@ the <code class="docutils literal notranslate"><span class="pre">bind_address</s
|
|||
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="l l-Scalar l-Scalar-Plain">use_default_settings</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">secret_key</span><span class="p p-Indicator">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tokens</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">secret_key</span><span class="p">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="nt">tokens</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</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="l l-Scalar l-Scalar-Plain">use_default_settings</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">remove</span><span class="p p-Indicator">:</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="nt">remove</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">secret_key</span><span class="p p-Indicator">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tokens</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">secret_key</span><span class="p">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="nt">tokens</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</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="l l-Scalar l-Scalar-Plain">use_default_settings</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">keep_only</span><span class="p p-Indicator">:</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">use_default_settings</span><span class="p">:</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="nt">keep_only</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">duckduckgo</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">server</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">secret_key</span><span class="p p-Indicator">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tokens</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">duckduckgo</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tokens</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
<span class="nt">server</span><span class="p">:</span>
|
||||
<span class="nt">secret_key</span><span class="p">:</span> <span class="s">"uvys6bRhKHUdFF5CqbJonSDSRN8H0sCBziNSrDGNVdpz7IeZhveVart3yvghoKHA"</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="nt">tokens</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">duckduckgo</span>
|
||||
<span class="nt">tokens</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'$ecretValue'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
|
|
|
@ -70,14 +70,14 @@ maybe security concerns.) The following options are available:</p>
|
|||
</ul>
|
||||
<p>The example engine below can be used to find files with a specific name in the configured
|
||||
working directory.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">find</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engine</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">command</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">command</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'find'</span><span class="p p-Indicator">,</span> <span class="s">'.'</span><span class="p p-Indicator">,</span> <span class="s">'-name'</span><span class="p p-Indicator">,</span> <span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">query_type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">path</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">shortcut</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">fnd</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">delimiter</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">chars</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="nv"> </span><span class="s">'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">keys</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span><span class="s">'line'</span><span class="p p-Indicator">]</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">find</span>
|
||||
<span class="nt">engine</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">command</span>
|
||||
<span class="nt">command</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'find'</span><span class="p p-Indicator">,</span> <span class="s">'.'</span><span class="p p-Indicator">,</span> <span class="s">'-name'</span><span class="p p-Indicator">,</span> <span class="s">'{{QUERY}}'</span><span class="p p-Indicator">]</span>
|
||||
<span class="nt">query_type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">path</span>
|
||||
<span class="nt">shortcut</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">fnd</span>
|
||||
<span class="nt">delimiter</span><span class="p">:</span>
|
||||
<span class="nt">chars</span><span class="p">:</span> <span class="s">'</span><span class="nv"> </span><span class="s">'</span>
|
||||
<span class="nt">keys</span><span class="p">:</span> <span class="p p-Indicator">[</span><span class="s">'line'</span><span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -61,7 +61,7 @@ finds the engine file and imports it.</p>
|
|||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">subprocess</span> <span class="kn">import</span> <span class="n">PIPE</span><span class="p">,</span> <span class="n">Popen</span>
|
||||
|
||||
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'general'</span><span class="p">]</span>
|
||||
<span class="n">offline</span> <span class="o">=</span> <span class="bp">True</span>
|
||||
<span class="n">offline</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="n">settings</span><span class="p">):</span>
|
||||
<span class="k">pass</span>
|
||||
|
|
|
@ -61,10 +61,10 @@ of strings. If the user making a request presents one of the tokens
|
|||
of an engine, they can access information about the engine
|
||||
and make search requests.</p>
|
||||
<p>Example configuration to restrict access to the Arch Linux Wiki engine:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engine</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">archlinux</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">shortcut</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">al</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tokens</span> <span class="p p-Indicator">:</span> <span class="p p-Indicator">[</span> <span class="s">'my-secret-token'</span> <span class="p p-Indicator">]</span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">arch linux wiki</span>
|
||||
<span class="nt">engine </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">archlinux</span>
|
||||
<span class="nt">shortcut </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">al</span>
|
||||
<span class="nt">tokens </span><span class="p">:</span> <span class="p p-Indicator">[</span> <span class="s">'my-secret-token'</span> <span class="p p-Indicator">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Unless a user has configured the right token, the engine is going
|
||||
|
|
|
@ -163,7 +163,7 @@ our <a class="reference internal" href="makefile.html#makefile"><span class="std
|
|||
<p>Here is an example which makes a complete rebuild:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ make docs-clean docs
|
||||
...
|
||||
The HTML pages are in dist/docs.
|
||||
The HTML pages are <span class="k">in</span> dist/docs.
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="live-build">
|
||||
|
@ -179,7 +179,7 @@ URL in your favorite browser and rebuilds every time a reST file has been
|
|||
changed.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ make docs-live
|
||||
...
|
||||
The HTML pages are in dist/docs.
|
||||
The HTML pages are <span class="k">in</span> dist/docs.
|
||||
... Serving on http://0.0.0.0:8000
|
||||
... Start watching changes
|
||||
</pre></div>
|
||||
|
@ -204,7 +204,7 @@ needed git add, commit and push:</p>
|
|||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ make docs-clean gh-pages
|
||||
...
|
||||
SPHINX docs --> file://<...>/dist/docs
|
||||
The HTML pages are in dist/docs.
|
||||
The HTML pages are <span class="k">in</span> dist/docs.
|
||||
...
|
||||
Cloning into <span class="s1">'gh-pages'</span> ...
|
||||
...
|
||||
|
|
|
@ -225,7 +225,7 @@ engine on other URL</p></td>
|
|||
<h3><a class="toc-backref" href="#id9">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># engine dependent config</span>
|
||||
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'general'</span><span class="p">]</span>
|
||||
<span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
|
||||
<span class="n">paging</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -432,7 +432,7 @@ request:</p>
|
|||
<h3><a class="toc-backref" href="#id13">example code</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># search-url</span>
|
||||
<span class="n">base_url</span> <span class="o">=</span> <span class="s1">'https://example.com/'</span>
|
||||
<span class="n">search_string</span> <span class="o">=</span> <span class="s1">'search?{query}&page={page}'</span>
|
||||
<span class="n">search_string</span> <span class="o">=</span> <span class="s1">'search?</span><span class="si">{query}</span><span class="s1">&page=</span><span class="si">{page}</span><span class="s1">'</span>
|
||||
|
||||
<span class="c1"># do search-request</span>
|
||||
<span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
|
||||
|
|
|
@ -60,7 +60,7 @@
|
|||
<h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">name</span> <span class="o">=</span> <span class="s1">'Example plugin'</span>
|
||||
<span class="n">description</span> <span class="o">=</span> <span class="s1">'This plugin extends the suggestions with the word "example"'</span>
|
||||
<span class="n">default_on</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1"># disabled by default</span>
|
||||
<span class="n">default_on</span> <span class="o">=</span> <span class="kc">False</span> <span class="c1"># disabled by default</span>
|
||||
|
||||
<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c1"># optional, list of static js files</span>
|
||||
<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c1"># optional, list of static css files</span>
|
||||
|
@ -71,7 +71,7 @@
|
|||
<span class="c1"># ctx: the whole local context of the post search hook</span>
|
||||
<span class="k">def</span> <span class="nf">post_search</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
|
||||
<span class="n">ctx</span><span class="p">[</span><span class="s1">'search'</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'example'</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="bp">True</span>
|
||||
<span class="k">return</span> <span class="kc">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -430,11 +430,11 @@ content becomes smart.</p>
|
|||
</table>
|
||||
<p>Intersphinx is configured in <a class="reference external" href="https://github.com/searx/searx/blob/master/docs/conf.py">git://docs/conf.py</a>:</p>
|
||||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">intersphinx_mapping</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"python"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://docs.python.org/3/"</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||||
<span class="s2">"flask"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://flask.palletsprojects.com/"</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||||
<span class="s2">"jinja"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://jinja.palletsprojects.com/"</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||||
<span class="s2">"linuxdoc"</span> <span class="p">:</span> <span class="p">(</span><span class="s2">"https://return42.github.io/linuxdoc/"</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||||
<span class="s2">"sphinx"</span> <span class="p">:</span> <span class="p">(</span><span class="s2">"https://www.sphinx-doc.org/en/master/"</span><span class="p">,</span> <span class="bp">None</span><span class="p">),</span>
|
||||
<span class="s2">"python"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://docs.python.org/3/"</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
|
||||
<span class="s2">"flask"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://flask.palletsprojects.com/"</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
|
||||
<span class="s2">"jinja"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"https://jinja.palletsprojects.com/"</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
|
||||
<span class="s2">"linuxdoc"</span> <span class="p">:</span> <span class="p">(</span><span class="s2">"https://return42.github.io/linuxdoc/"</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
|
||||
<span class="s2">"sphinx"</span> <span class="p">:</span> <span class="p">(</span><span class="s2">"https://www.sphinx-doc.org/en/master/"</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
@ -497,8 +497,8 @@ with additional options. To learn more about code literals visit
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span>The URL <span class="s">``/stats``</span> handle is shown in <span class="na">:ref:</span><span class="nv">`stats-handle`</span>
|
||||
|
||||
<span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> Python
|
||||
<span class="nc">:caption:</span> <span class="nf">python code block</span>
|
||||
<span class="nc">:name:</span> <span class="nf">stats-handle</span>
|
||||
<span class="nc">:caption:</span> python code block
|
||||
<span class="nc">:name:</span> stats-handle
|
||||
|
||||
@app.route('/stats', methods=['GET'])
|
||||
def stats():
|
||||
|
@ -517,7 +517,7 @@ with additional options. To learn more about code literals visit
|
|||
<p>The URL <code class="docutils literal notranslate"><span class="pre">/stats</span></code> handle is shown in <a class="reference internal" href="#stats-handle"><span class="std std-ref">python code block</span></a></p>
|
||||
<div class="literal-block-wrapper docutils container" id="stats-handle">
|
||||
<div class="code-block-caption"><span class="caption-number">Listing 1 </span><span class="caption-text">python code block</span><a class="headerlink" href="#stats-handle" title="Permalink to this code">¶</a></div>
|
||||
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="nd">@app.route</span><span class="p">(</span><span class="s1">'/stats'</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">'GET'</span><span class="p">])</span>
|
||||
<div class="highlight-Python notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s1">'/stats'</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">'GET'</span><span class="p">])</span>
|
||||
<span class="k">def</span> <span class="nf">stats</span><span class="p">():</span>
|
||||
<span class="sd">"""Render engine statistics page."""</span>
|
||||
<span class="n">stats</span> <span class="o">=</span> <span class="n">get_engines_stats</span><span class="p">()</span>
|
||||
|
@ -653,7 +653,7 @@ directives. E.g. to insert a figure with a scaleable image format use SVG
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_svg image example:</span>
|
||||
|
||||
<span class="p">..</span> <span class="ow">kernel-figure</span><span class="p">::</span> svg_image.svg
|
||||
<span class="nc">:alt:</span> <span class="nf">SVG image example</span>
|
||||
<span class="nc">:alt:</span> SVG image example
|
||||
|
||||
Simple SVG image
|
||||
|
||||
|
@ -677,7 +677,7 @@ given.</p>
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_dot file example:</span>
|
||||
|
||||
<span class="p">..</span> <span class="ow">kernel-figure</span><span class="p">::</span> hello.dot
|
||||
<span class="nc">:alt:</span> <span class="nf">hello world</span>
|
||||
<span class="nc">:alt:</span> hello world
|
||||
|
||||
DOT's hello world example
|
||||
</pre></div>
|
||||
|
@ -697,8 +697,8 @@ shown in figure <a class="reference internal" href="#dot-render-example"><span c
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_dot render example:</span>
|
||||
|
||||
<span class="p">..</span> <span class="ow">kernel-render</span><span class="p">::</span> DOT
|
||||
<span class="nc">:alt:</span> <span class="nf">digraph</span>
|
||||
<span class="nc">:caption:</span> <span class="nf">Embedded DOT (Graphviz) code</span>
|
||||
<span class="nc">:alt:</span> digraph
|
||||
<span class="nc">:caption:</span> Embedded DOT (Graphviz) code
|
||||
|
||||
digraph foo {
|
||||
"bar" -> "baz";
|
||||
|
@ -725,8 +725,8 @@ installed, you will see an vector image. If not, the raw markup is inserted as
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_svg render example:</span>
|
||||
|
||||
<span class="p">..</span> <span class="ow">kernel-render</span><span class="p">::</span> SVG
|
||||
<span class="nc">:caption:</span> <span class="nf">Embedded **SVG** markup</span>
|
||||
<span class="nc">:alt:</span> <span class="nf">so-nw-arrow</span>
|
||||
<span class="nc">:caption:</span> Embedded <span class="gs">**SVG**</span> markup
|
||||
<span class="nc">:alt:</span> so-nw-arrow
|
||||
</pre></div>
|
||||
</div>
|
||||
<blockquote>
|
||||
|
@ -922,12 +922,12 @@ lorem ipsum.</p>
|
|||
<p>Field lists are used as part of an extension syntax, such as options for
|
||||
directives, or database-like records meant for further processing. Field lists
|
||||
are mappings from field names to field bodies. They marked up like this:</p>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="nc">:fieldname:</span> <span class="nf">Field content</span>
|
||||
<span class="nc">:foo:</span> <span class="nf">first paragraph in field foo</span>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="nc">:fieldname:</span> Field content
|
||||
<span class="nc">:foo:</span> first paragraph in field foo
|
||||
|
||||
second paragraph in field foo
|
||||
|
||||
<span class="nc">:bar:</span> <span class="nf">Field content</span>
|
||||
<span class="nc">:bar:</span> Field content
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="rst-example admonition">
|
||||
|
@ -1080,8 +1080,8 @@ here are some helpers:</p>
|
|||
your table need some metadata (e.g. a title) you need to add the <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">table::</span>
|
||||
<span class="pre">directive</span></code> <a class="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>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">table</span><span class="p">::</span> foo gate truth table
|
||||
<span class="nc">:widths:</span> <span class="nf">grid</span>
|
||||
<span class="nc">:align:</span> <span class="nf">left</span>
|
||||
<span class="nc">:widths:</span> grid
|
||||
<span class="nc">:align:</span> left
|
||||
|
||||
====== ====== ======
|
||||
Inputs Output
|
||||
|
@ -1140,7 +1140,7 @@ your table need some metadata (e.g. a title) you need to add the <code class="do
|
|||
<span id="rest-grid-table"></span><h3><a class="toc-backref" href="#id46">Grid tables</a><a class="headerlink" href="#grid-tables" title="Permalink to this headline">¶</a></h3>
|
||||
<p><a class="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>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">table</span><span class="p">::</span> grid table example
|
||||
<span class="nc">:widths:</span> <span class="nf">1 1 5</span>
|
||||
<span class="nc">:widths:</span> 1 1 5
|
||||
|
||||
+------------+------------+-----------+
|
||||
<span class="o">|</span> Header 1 | Header 2 | Header 3 |
|
||||
|
@ -1238,9 +1238,9 @@ list is the <em>table-row</em>. In the <em>table-row</em> there is only one mark
|
|||
the list of the cells in this <em>table-row</em>. Exception are <em>comments</em> ( <code class="docutils literal notranslate"><span class="pre">..</span></code> )
|
||||
and <em>targets</em> (e.g. a ref to <a class="reference internal" href="#row-body-2"><span class="std std-ref">row 2 of table’s body</span></a>).</p>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">flat-table</span><span class="p">::</span> <span class="s">``flat-table``</span> example
|
||||
<span class="nc">:header-rows:</span> <span class="nf">2</span>
|
||||
<span class="nc">:stub-columns:</span> <span class="nf">1</span>
|
||||
<span class="nc">:widths:</span> <span class="nf">1 1 1 1 2</span>
|
||||
<span class="nc">:header-rows:</span> 2
|
||||
<span class="nc">:stub-columns:</span> 1
|
||||
<span class="nc">:widths:</span> 1 1 1 1 2
|
||||
|
||||
<span class="m">*</span> - <span class="na">:rspan:</span><span class="nv">`1`</span> head / stub
|
||||
<span class="m">-</span> <span class="na">:cspan:</span><span class="nv">`3`</span> head 1.1-4
|
||||
|
@ -1351,10 +1351,10 @@ cell 2.3 with a span over</p>
|
|||
<p>CSV table might be the choice if you want to include CSV-data from a outstanding
|
||||
(build) process into your documentation.</p>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">csv-table</span><span class="p">::</span> CSV table example
|
||||
<span class="nc">:header:</span> <span class="nf">.. , Column 1, Column 2</span>
|
||||
<span class="nc">:widths:</span> <span class="nf">2 5 5</span>
|
||||
<span class="nc">:stub-columns:</span> <span class="nf">1</span>
|
||||
<span class="nc">:file:</span> <span class="nf">csv_table.txt</span>
|
||||
<span class="nc">:header:</span> .. , Column 1, Column 2
|
||||
<span class="nc">:widths:</span> 2 5 5
|
||||
<span class="nc">:stub-columns:</span> 1
|
||||
<span class="nc">:file:</span> csv_table.txt
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Content of file <code class="docutils literal notranslate"><span class="pre">csv_table.txt</span></code>:</p>
|
||||
|
@ -1416,8 +1416,8 @@ build chapter: <a class="reference internal" href="../admin/engines.html#engines
|
|||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">jinja</span><span class="p">::</span> searx
|
||||
|
||||
<span class="p"> ..</span> <span class="ow">flat-table</span><span class="p">::</span> Engines configured at built time (defaults)
|
||||
<span class="nc">:header-rows:</span> <span class="nf">1</span>
|
||||
<span class="nc">:stub-columns:</span> <span class="nf">2</span>
|
||||
<span class="nc">:header-rows:</span> 1
|
||||
<span class="nc">:stub-columns:</span> 2
|
||||
|
||||
<span class="m">*</span> - Name (cfg)
|
||||
<span class="m">-</span> S
|
||||
|
@ -1516,7 +1516,7 @@ inline and directive <a class="reference external" href="https://www.sphinx-doc.
|
|||
is shown.
|
||||
|
||||
<span class="p">..</span> <span class="ow">math</span><span class="p">::</span>
|
||||
<span class="nc">:label:</span> <span class="nf">schroedinger general</span>
|
||||
<span class="nc">:label:</span> schroedinger general
|
||||
|
||||
\mathrm{i}\hbar\dfrac{\partial}{\partial t} |\,\psi (t) \rangle =
|
||||
\hat{H} |\,\psi (t) \rangle.
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -87,14 +87,14 @@ You have to use the language prefix in your search query when searching in a dif
|
|||
<p>But there is a workaround:
|
||||
By adding a new search engine with a different language, Searx will search in your default and other language.</p>
|
||||
<dl>
|
||||
<dt>Example configuration in settings.yml for a German and English speaker:</dt><dd><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">search</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">language</span> <span class="p p-Indicator">:</span> <span class="s">"de"</span>
|
||||
<dt>Example configuration in settings.yml for a German and English speaker:</dt><dd><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">search</span><span class="p">:</span>
|
||||
<span class="nt">language </span><span class="p">:</span> <span class="s">"de"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
|
||||
<span class="l l-Scalar l-Scalar-Plain">engines</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">name</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">google english</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">engine</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">language</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">english</span>
|
||||
<span class="nt">engines</span><span class="p">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="nt">name </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">google english</span>
|
||||
<span class="nt">engine </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">google</span>
|
||||
<span class="nt">language </span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">english</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
|
@ -184,18 +184,18 @@ inspect service
|
|||
show service status and log
|
||||
option
|
||||
set one of the available options
|
||||
apache (http://fv-az224-828/searx)
|
||||
apache (http://fv-az121-771/searx)
|
||||
:install: apache site with a reverse proxy (ProxyPass)
|
||||
:remove: apache site searx.conf
|
||||
nginx (http://fv-az224-828/searx)
|
||||
nginx (http://fv-az121-771/searx)
|
||||
:install: nginx site with a reverse proxy (ProxyPass)
|
||||
:remove: nginx site searx.conf
|
||||
|
||||
filtron rules: /etc/filtron/rules.json
|
||||
|
||||
If needed, set PUBLIC_URL of your WEB service in the '.config.sh' file::
|
||||
PUBLIC_URL : http://fv-az224-828/searx
|
||||
PUBLIC_HOST : fv-az224-828
|
||||
PUBLIC_URL : http://fv-az121-771/searx
|
||||
PUBLIC_HOST : fv-az121-771
|
||||
SERVICE_USER : filtron
|
||||
FILTRON_TARGET : 127.0.0.1:8888
|
||||
FILTRON_API : 127.0.0.1:4005
|
||||
|
|
|
@ -194,7 +194,7 @@ install
|
|||
:base: prepare LXC; install basic packages
|
||||
:suite: install LXC searx suite into all (or <name>) containers
|
||||
|
||||
LXC suite: searx --> http://fv-az224-828/searx
|
||||
LXC suite: searx --> http://fv-az121-771/searx
|
||||
suite includes searx, morty & filtron
|
||||
suite images:
|
||||
ubu1804 ubu2004 ubu2010 fedora33 archlinux centos7
|
||||
|
@ -275,7 +275,7 @@ lxc_suite_install_info<span class="o">()</span> <span class="o">{</span>
|
|||
lxc_suite_install<span class="o">()</span> <span class="o">{</span>
|
||||
<span class="o">(</span>
|
||||
lxc_set_suite_env
|
||||
<span class="nv">FORCE_TIMEOUT</span><span class="o">=</span>0
|
||||
<span class="nv">FORCE_TIMEOUT</span><span class="o">=</span><span class="m">0</span>
|
||||
<span class="nb">export</span> FORCE_TIMEOUT
|
||||
<span class="s2">"</span><span class="si">${</span><span class="nv">LXC_REPO_ROOT</span><span class="si">}</span><span class="s2">/utils/searx.sh"</span> install all
|
||||
<span class="s2">"</span><span class="si">${</span><span class="nv">LXC_REPO_ROOT</span><span class="si">}</span><span class="s2">/utils/morty.sh"</span> install all
|
||||
|
@ -290,7 +290,7 @@ lxc_suite_install<span class="o">()</span> <span class="o">{</span>
|
|||
lxc_suite_info<span class="o">()</span> <span class="o">{</span>
|
||||
<span class="o">(</span>
|
||||
lxc_set_suite_env
|
||||
<span class="k">for</span> ip in <span class="k">$(</span>global_IPs<span class="k">)</span> <span class="p">;</span> <span class="k">do</span>
|
||||
<span class="k">for</span> ip <span class="k">in</span> <span class="k">$(</span>global_IPs<span class="k">)</span> <span class="p">;</span> <span class="k">do</span>
|
||||
<span class="k">if</span> <span class="o">[[</span> <span class="nv">$ip</span> <span class="o">=</span>~ .*:.* <span class="o">]]</span><span class="p">;</span> <span class="k">then</span>
|
||||
info_msg <span class="s2">"(</span><span class="si">${</span><span class="nv">ip</span><span class="p">%|*</span><span class="si">}</span><span class="s2">) IPv6: http://[</span><span class="si">${</span><span class="nv">ip</span><span class="p">#*|</span><span class="si">}</span><span class="s2">]"</span>
|
||||
<span class="k">else</span>
|
||||
|
|
|
@ -132,7 +132,7 @@ $ sudo -i -u <span class="s2">"morty"</span>
|
|||
<span class="nv">User</span><span class="o">=</span>morty
|
||||
<span class="nv">Group</span><span class="o">=</span>morty
|
||||
<span class="nv">WorkingDirectory</span><span class="o">=</span>/usr/local/morty
|
||||
<span class="nv">ExecStart</span><span class="o">=</span>/usr/local/morty/go-apps/bin/morty -key <span class="s1">''</span> -listen <span class="s1">'127.0.0.1:3000'</span> -timeout 5
|
||||
<span class="nv">ExecStart</span><span class="o">=</span>/usr/local/morty/go-apps/bin/morty -key <span class="s1">''</span> -listen <span class="s1">'127.0.0.1:3000'</span> -timeout <span class="m">5</span>
|
||||
|
||||
<span class="nv">Restart</span><span class="o">=</span>always
|
||||
<span class="nv">Environment</span><span class="o">=</span><span class="nv">USER</span><span class="o">=</span>morty <span class="nv">HOME</span><span class="o">=</span>/usr/local/morty <span class="nv">DEBUG</span><span class="o">=</span><span class="nb">false</span>
|
||||
|
@ -186,22 +186,22 @@ inspect service
|
|||
option
|
||||
set one of the available options
|
||||
:new-key: set new morty key
|
||||
apache : http://fv-az224-828/morty/
|
||||
apache : http://fv-az121-771/morty/
|
||||
:install: apache site with a reverse proxy (ProxyPass)
|
||||
:remove: apache site morty.conf
|
||||
nginx (http://fv-az224-828/morty/)
|
||||
nginx (http://fv-az121-771/morty/)
|
||||
:install: nginx site with a reverse proxy (ProxyPass)
|
||||
:remove: nginx site morty.conf
|
||||
|
||||
If needed, set the environment variables in the '.config.sh' file::
|
||||
PUBLIC_URL_MORTY: http://fv-az224-828/morty/
|
||||
PUBLIC_URL_MORTY: http://fv-az121-771/morty/
|
||||
MORTY_LISTEN: 127.0.0.1:3000
|
||||
SERVICE_USER: morty
|
||||
|
||||
To activate result and image proxy in searx, edit settings.yml (read:
|
||||
https://searx.github.io/searx/admin/morty.html)::
|
||||
result_proxy:
|
||||
url : http://fv-az224-828/morty/
|
||||
url : http://fv-az121-771/morty/
|
||||
server:
|
||||
image_proxy : True
|
||||
</pre></div>
|
||||
|
|
|
@ -113,8 +113,8 @@ apache
|
|||
searx settings: /etc/searx/settings.yml
|
||||
|
||||
If needed, set PUBLIC_URL of your WEB service in the '.config.sh' file::
|
||||
PUBLIC_URL : http://fv-az224-828/searx
|
||||
SEARX_INSTANCE_NAME : searx@fv-az224-828
|
||||
PUBLIC_URL : http://fv-az121-771/searx
|
||||
SEARX_INSTANCE_NAME : searx@fv-az121-771
|
||||
SERVICE_USER : searx
|
||||
SEARX_INTERNAL_HTTP : http://127.0.0.1:8888
|
||||
</pre></div>
|
||||
|
|
Loading…
Reference in New Issue