mirror of
https://github.com/searx/searx
synced 2024-11-22 01:45:21 +01:00
Deploying to gh-pages from @ 629ebb426f
🚀
This commit is contained in:
parent
341eb1df8d
commit
766e1c0033
@ -15,7 +15,7 @@ generated and deployed at :docs:`github.io <.>`. For build prerequisites read
|
||||
:ref:`docs build`.
|
||||
|
||||
The source files of Searx's documentation are located at :origin:`docs`. Sphinx
|
||||
assumes source files to be encoded in UTF-8 by defaul. Run :ref:`make docs.live
|
||||
assumes source files to be encoded in UTF-8 by default. Run :ref:`make docs.live
|
||||
<make docs.live>` to build HTML while editing.
|
||||
|
||||
.. sidebar:: Further reading
|
||||
@ -227,13 +227,13 @@ To refer anchors use the `ref role`_ markup:
|
||||
|
||||
.. code:: reST
|
||||
|
||||
Visit chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo
|
||||
Visit chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo
|
||||
bar <reST anchor>`.
|
||||
|
||||
.. admonition:: ``:ref:`` role
|
||||
:class: rst-example
|
||||
|
||||
Visist chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo
|
||||
Visist chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo
|
||||
bar <reST anchor>`.
|
||||
|
||||
.. _reST ordinary ref:
|
||||
@ -494,8 +494,8 @@ Figures & Images
|
||||
is flexible. To get best results in the generated output format, install
|
||||
ImageMagick_ and Graphviz_.
|
||||
|
||||
Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scaleable here means;
|
||||
scaleable in sense of the build process. Normally in absence of a converter
|
||||
Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scalable here means;
|
||||
scalable in sense of the build process. Normally in absence of a converter
|
||||
tool, the build process will break. From the authors POV it’s annoying to care
|
||||
about the build process when handling with images, especially since he has no
|
||||
access to the build process. With :ref:`linuxdoc:kfigure` the build process
|
||||
@ -503,7 +503,7 @@ continues and scales output quality in dependence of installed image processors.
|
||||
|
||||
If you want to add an image, you should use the ``kernel-figure`` (inheritance
|
||||
of :dudir:`figure`) and ``kernel-image`` (inheritance of :dudir:`image`)
|
||||
directives. E.g. to insert a figure with a scaleable image format use SVG
|
||||
directives. E.g. to insert a figure with a scalable image format use SVG
|
||||
(:ref:`svg image example`):
|
||||
|
||||
.. code:: reST
|
||||
@ -1185,7 +1185,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`).
|
||||
- cell 4.4
|
||||
|
||||
* - row 5
|
||||
- cell 5.1 with automatic span to rigth end
|
||||
- cell 5.1 with automatic span to right end
|
||||
|
||||
* - row 6
|
||||
- cell 6.1
|
||||
@ -1237,7 +1237,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`).
|
||||
- cell 4.4
|
||||
|
||||
* - row 5
|
||||
- cell 5.1 with automatic span to rigth end
|
||||
- cell 5.1 with automatic span to right end
|
||||
|
||||
* - row 6
|
||||
- cell 6.1
|
||||
|
@ -37,7 +37,7 @@ Disabled **D** Engine type **ET**
|
||||
------------- ----------- -------------------- ------------
|
||||
Safe search **SS**
|
||||
------------- ----------- ---------------------------------
|
||||
Weigth **W**
|
||||
Weight **W**
|
||||
------------- ----------- ---------------------------------
|
||||
Disabled **D**
|
||||
------------- ----------- ---------------------------------
|
||||
|
@ -39,7 +39,7 @@ Example
|
||||
Scenario:
|
||||
|
||||
#. Recoll indexes a local filesystem mounted in ``/export/documents/reference``,
|
||||
#. the Recoll search inteface can be reached at https://recoll.example.org/ and
|
||||
#. the Recoll search interface can be reached at https://recoll.example.org/ and
|
||||
#. the contents of this filesystem can be reached though https://download.example.org/reference
|
||||
|
||||
.. code:: yaml
|
||||
|
@ -129,7 +129,7 @@ Global Settings
|
||||
outgoing: # communication with search engines
|
||||
request_timeout : 2.0 # default timeout in seconds, can be override by engine
|
||||
# max_request_timeout: 10.0 # the maximum timeout in seconds
|
||||
useragent_suffix : "" # informations like an email address to the administrator
|
||||
useragent_suffix : "" # information like an email address to the administrator
|
||||
pool_connections : 100 # Number of different hosts
|
||||
pool_maxsize : 10 # Number of simultaneous requests by host
|
||||
# uncomment below section if you want to use a proxy
|
||||
|
@ -207,7 +207,7 @@ debug services from filtron and morty analogous use:
|
||||
Another point we have to notice is that each service (:ref:`searx <searx.sh>`,
|
||||
:ref:`filtron <filtron.sh>` and :ref:`morty <morty.sh>`) runs under dedicated
|
||||
system user account with the same name (compare :ref:`create searx user`). To
|
||||
get a shell from theses accounts, simply call one of the scripts:
|
||||
get a shell from these accounts, simply call one of the scripts:
|
||||
|
||||
.. tabs::
|
||||
|
||||
@ -311,7 +311,7 @@ of the container:
|
||||
|
||||
Now we can develop as usual in the working tree of our desktop system. Every
|
||||
time the software was changed, you have to restart the searx service (in the
|
||||
conatiner):
|
||||
container):
|
||||
|
||||
.. tabs::
|
||||
|
||||
@ -370,7 +370,7 @@ We build up a fully functional searx suite in a archlinux container:
|
||||
$ sudo -H ./utils/lxc.sh install suite searx-archlinux
|
||||
|
||||
To access HTTP from the desktop we installed nginx for the services inside the
|
||||
conatiner:
|
||||
container:
|
||||
|
||||
.. tabs::
|
||||
|
||||
|
@ -16,7 +16,7 @@ you can use your owm template by placing the template under
|
||||
``searx/templates/{theme_name}/result_templates/{template_name}`` and setting
|
||||
``result_template`` attribute to ``{template_name}``.
|
||||
|
||||
Futhermore, if you do not want to expose these engines on a public instance, you can
|
||||
Furthermore, if you do not want to expose these engines on a public instance, you can
|
||||
still add them and limit the access by setting ``tokens`` as described in the `blog post about
|
||||
private engines`_.
|
||||
|
||||
@ -29,7 +29,7 @@ structure.
|
||||
Redis
|
||||
-----
|
||||
|
||||
Reqired package: ``redis``
|
||||
Required package: ``redis``
|
||||
|
||||
Redis is a key value based data store usually stored in memory.
|
||||
|
||||
|
@ -15,7 +15,7 @@ All of the engines above are added to ``settings.yml`` just commented out, as yo
|
||||
Please note that if you are not using HTTPS to access these engines, you have to enable
|
||||
HTTP requests by setting ``enable_http`` to ``True``.
|
||||
|
||||
Futhermore, if you do not want to expose these engines on a public instance, you can
|
||||
Furthermore, if you do not want to expose these engines on a public instance, you can
|
||||
still add them and limit the access by setting ``tokens`` as described in the `blog post about
|
||||
private engines`_.
|
||||
|
||||
@ -57,7 +57,7 @@ small-scale (less than 10 million documents) data collections. E.g. it is great
|
||||
web pages you have visited and searching in the contents later.
|
||||
|
||||
The engine supports faceted search, so you can search in a subset of documents of the collection.
|
||||
Futhermore, you can search in Meilisearch instances that require authentication by setting ``auth_token``.
|
||||
Furthermore, you can search in Meilisearch instances that require authentication by setting ``auth_token``.
|
||||
|
||||
Here is a simple example to query a Meilisearch instance:
|
||||
|
||||
|
@ -62,7 +62,7 @@ Before enabling MySQL engine, you must install the package ``mysql-connector-pyt
|
||||
The authentication plugin is configurable by setting ``auth_plugin`` in the attributes.
|
||||
By default it is set to ``caching_sha2_password``.
|
||||
|
||||
This is an example configuration for quering a MySQL server:
|
||||
This is an example configuration for querying a MySQL server:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
|
@ -41,7 +41,7 @@ engine file
|
||||
argument type information
|
||||
======================= =========== ========================================================
|
||||
categories list pages, in which the engine is working
|
||||
paging boolean support multible pages
|
||||
paging boolean support multiple pages
|
||||
time_range_support boolean support search time range
|
||||
engine_type str ``online`` by default, other possibles values are
|
||||
``offline``, ``online_dictionary``, ``online_currency``
|
||||
@ -159,7 +159,7 @@ parsed arguments
|
||||
----------------
|
||||
|
||||
The function ``def request(query, params):`` always returns the ``params``
|
||||
variable. Inside searx, the following paramters can be used to specify a search
|
||||
variable. Inside searx, the following parameters can be used to specify a search
|
||||
request:
|
||||
|
||||
=================== =========== ==========================================================================
|
||||
|
@ -15,7 +15,7 @@ generated and deployed at :docs:`github.io <.>`. For build prerequisites read
|
||||
:ref:`docs build`.
|
||||
|
||||
The source files of Searx's documentation are located at :origin:`docs`. Sphinx
|
||||
assumes source files to be encoded in UTF-8 by defaul. Run :ref:`make docs.live
|
||||
assumes source files to be encoded in UTF-8 by default. Run :ref:`make docs.live
|
||||
<make docs.live>` to build HTML while editing.
|
||||
|
||||
.. sidebar:: Further reading
|
||||
@ -227,13 +227,13 @@ To refer anchors use the `ref role`_ markup:
|
||||
|
||||
.. code:: reST
|
||||
|
||||
Visit chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo
|
||||
Visit chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo
|
||||
bar <reST anchor>`.
|
||||
|
||||
.. admonition:: ``:ref:`` role
|
||||
:class: rst-example
|
||||
|
||||
Visist chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo
|
||||
Visist chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo
|
||||
bar <reST anchor>`.
|
||||
|
||||
.. _reST ordinary ref:
|
||||
@ -494,8 +494,8 @@ Figures & Images
|
||||
is flexible. To get best results in the generated output format, install
|
||||
ImageMagick_ and Graphviz_.
|
||||
|
||||
Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scaleable here means;
|
||||
scaleable in sense of the build process. Normally in absence of a converter
|
||||
Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scalable here means;
|
||||
scalable in sense of the build process. Normally in absence of a converter
|
||||
tool, the build process will break. From the authors POV it’s annoying to care
|
||||
about the build process when handling with images, especially since he has no
|
||||
access to the build process. With :ref:`linuxdoc:kfigure` the build process
|
||||
@ -503,7 +503,7 @@ continues and scales output quality in dependence of installed image processors.
|
||||
|
||||
If you want to add an image, you should use the ``kernel-figure`` (inheritance
|
||||
of :dudir:`figure`) and ``kernel-image`` (inheritance of :dudir:`image`)
|
||||
directives. E.g. to insert a figure with a scaleable image format use SVG
|
||||
directives. E.g. to insert a figure with a scalable image format use SVG
|
||||
(:ref:`svg image example`):
|
||||
|
||||
.. code:: reST
|
||||
@ -1185,7 +1185,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`).
|
||||
- cell 4.4
|
||||
|
||||
* - row 5
|
||||
- cell 5.1 with automatic span to rigth end
|
||||
- cell 5.1 with automatic span to right end
|
||||
|
||||
* - row 6
|
||||
- cell 6.1
|
||||
@ -1237,7 +1237,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`).
|
||||
- cell 4.4
|
||||
|
||||
* - row 5
|
||||
- cell 5.1 with automatic span to rigth end
|
||||
- cell 5.1 with automatic span to right end
|
||||
|
||||
* - row 6
|
||||
- cell 6.1
|
||||
|
@ -17,7 +17,7 @@ Prefix: ``:``
|
||||
Prefix: ``?``
|
||||
to add engines and categories to the currently selected categories
|
||||
|
||||
Abbrevations of the engines and languages are also accepted. Engine/category
|
||||
Abbreviations of the engines and languages are also accepted. Engine/category
|
||||
modifiers are chainable and inclusive (e.g. with :search:`!it !ddg !wp qwer
|
||||
<?q=%21it%20%21ddg%20%21wp%20qwer>` search in IT category **and** duckduckgo
|
||||
**and** wikipedia for ``qwer``).
|
||||
|
@ -98,7 +98,7 @@
|
||||
<td><p><strong>SS</strong></p></td>
|
||||
<td colspan="2"></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>Weigth</p></td>
|
||||
<tr class="row-even"><td><p>Weight</p></td>
|
||||
<td><p><strong>W</strong></p></td>
|
||||
<td colspan="2"></td>
|
||||
</tr>
|
||||
|
@ -78,7 +78,7 @@ searched.</p>
|
||||
<p>Scenario:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Recoll indexes a local filesystem mounted in <code class="docutils literal notranslate"><span class="pre">/export/documents/reference</span></code>,</p></li>
|
||||
<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 Recoll search interface 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="nt">base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://recoll.example.org/</span><span class="w"></span>
|
||||
|
@ -65,7 +65,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation-uwsgi.html">uwsgi</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#origin-uwsgi">Origin uWSGI</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#distributors">Distributors</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#alltogether">Alltogether</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="installation-uwsgi.html#all-together">All together</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="installation-nginx.html">Install with nginx</a><ul>
|
||||
|
@ -230,7 +230,7 @@ $ sudo -H sed -i -e <span class="s2">"s/{instance_name}/searx@</span><span
|
||||
<span class="w"> </span><span class="nt">default_lang </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># Default search language - leave blank to detect from browser information or use codes from 'languages.py'</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">ban_time_on_fail </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span><span class="w"> </span><span class="c1"># ban time in seconds after engine errors</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">max_ban_time_on_fail </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">120</span><span class="w"> </span><span class="c1"># max ban time in seconds after engine errors</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">prefer_configured_language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># increase weight of results in confiugred language in ranking</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">prefer_configured_language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"> </span><span class="c1"># increase weight of results in configured language in ranking</span><span class="w"></span>
|
||||
|
||||
<span class="nt">server</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">port </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8888</span><span class="w"></span>
|
||||
@ -284,7 +284,7 @@ $ sudo -H sed -i -e <span class="s2">"s/{instance_name}/searx@</span><span
|
||||
<span class="nt">outgoing</span><span class="p">:</span><span class="w"> </span><span class="c1"># communication with search engines</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">request_timeout </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2.0</span><span class="w"> </span><span class="c1"># default timeout in seconds, can be override by engine</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># max_request_timeout: 10.0 # the maximum timeout in seconds</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">useragent_suffix </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># suffix of searx_useragent, could contain informations like an email address to the administrator</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">useragent_suffix </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># suffix of searx_useragent, could contain information like an email address to the administrator</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">pool_connections </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">100</span><span class="w"> </span><span class="c1"># Number of different hosts</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">pool_maxsize </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># Number of simultaneous requests by host</span><span class="w"></span>
|
||||
<span class="c1"># uncomment below section if you want to use a proxy</span><span class="w"></span>
|
||||
|
@ -61,7 +61,7 @@
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#origin-uwsgi" id="id1">Origin uWSGI</a></p></li>
|
||||
<li><p><a class="reference internal" href="#distributors" id="id2">Distributors</a></p></li>
|
||||
<li><p><a class="reference internal" href="#alltogether" id="id3">Alltogether</a></p></li>
|
||||
<li><p><a class="reference internal" href="#all-together" id="id3">All together</a></p></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="origin-uwsgi">
|
||||
@ -129,8 +129,8 @@ sudo -H service uwsgi stop searx
|
||||
</div>
|
||||
<p>My experience is, that this command is a bit buggy.</p>
|
||||
</section>
|
||||
<section id="alltogether">
|
||||
<span id="uwsgi-configuration"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Alltogether</a><a class="headerlink" href="#alltogether" title="Permalink to this heading">¶</a></h2>
|
||||
<section id="all-together">
|
||||
<span id="uwsgi-configuration"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">All together</a><a class="headerlink" href="#all-together" title="Permalink to this heading">¶</a></h2>
|
||||
<p>Create the configuration ini-file according to your distribution (see below) and
|
||||
restart the uwsgi application.</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
@ -198,7 +198,7 @@ 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> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
<span class="c1"># Plugin to use and interpreter config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># enable master process</span>
|
||||
@ -288,7 +288,7 @@ 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> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
<span class="c1"># Plugin to use and interpreter config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># enable master process</span>
|
||||
@ -377,7 +377,7 @@ 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> <span class="m">666</span>
|
||||
|
||||
<span class="c1"># Plugin to use and interpretor config</span>
|
||||
<span class="c1"># Plugin to use and interpreter config</span>
|
||||
single-interpreter <span class="o">=</span> <span class="nb">true</span>
|
||||
|
||||
<span class="c1"># enable master process</span>
|
||||
|
@ -163,7 +163,7 @@ code, like <code class="docutils literal notranslate"><span class="pre">fr</span
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">outgoing</span><span class="p">:</span><span class="w"> </span><span class="c1"># communication with search engines</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">request_timeout </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2.0</span><span class="w"> </span><span class="c1"># default timeout in seconds, can be override by engine</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># max_request_timeout: 10.0 # the maximum timeout in seconds</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">useragent_suffix </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># informations like an email address to the administrator</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">useragent_suffix </span><span class="p">:</span><span class="w"> </span><span class="s">""</span><span class="w"> </span><span class="c1"># information like an email address to the administrator</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">pool_connections </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">100</span><span class="w"> </span><span class="c1"># Number of different hosts</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">pool_maxsize </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># Number of simultaneous requests by host</span><span class="w"></span>
|
||||
<span class="c1"># uncomment below section if you want to use a proxy</span><span class="w"></span>
|
||||
|
@ -205,7 +205,7 @@ $ ./utils/morty.sh inspect service
|
||||
<p>Another point we have to notice is that each service (<a class="reference internal" href="../utils/searx.sh.html#searx-sh"><span class="std std-ref">searx</span></a>,
|
||||
<a class="reference internal" href="../utils/filtron.sh.html#filtron-sh"><span class="std std-ref">filtron</span></a> and <a class="reference internal" href="../utils/morty.sh.html#morty-sh"><span class="std std-ref">morty</span></a>) runs under dedicated
|
||||
system user account with the same name (compare <a class="reference internal" href="../admin/installation-searx.html#create-searx-user"><span class="std std-ref">Create user</span></a>). To
|
||||
get a shell from theses accounts, simply call one of the scripts:</p>
|
||||
get a shell from these accounts, simply call one of the scripts:</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-9-cm9vdEBzZWFyeC1hcmNobGludXg=" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-9-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tab" tabindex="0"><a class="reference external" href="mailto:root%40searx-archlinux">root<span>@</span>searx-archlinux</a></button></div><div aria-labelledby="tab-9-cm9vdEBzZWFyeC1hcmNobGludXg=" class="sphinx-tabs-panel group-tab" id="panel-9-cm9vdEBzZWFyeC1hcmNobGludXg=" name="cm9vdEBzZWFyeC1hcmNobGludXg=" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/searx.sh shell
|
||||
$ ./utils/filtron.sh shell
|
||||
@ -285,7 +285,7 @@ $ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
|
||||
</div></div>
|
||||
<p>Now we can develop as usual in the working tree of our desktop system. Every
|
||||
time the software was changed, you have to restart the searx service (in the
|
||||
conatiner):</p>
|
||||
container):</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-14-ZGVza3RvcA==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-14-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tab" tabindex="0">desktop</button></div><div aria-labelledby="tab-14-ZGVza3RvcA==" class="sphinx-tabs-panel group-tab" id="panel-14-ZGVza3RvcA==" name="ZGVza3RvcA==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ sudo -H ./utils/lxc.sh cmd searx-archlinux <span class="se">\</span>
|
||||
systemctl restart uwsgi@searx
|
||||
@ -324,7 +324,7 @@ daily usage:</p>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To access HTTP from the desktop we installed nginx for the services inside the
|
||||
conatiner:</p>
|
||||
container:</p>
|
||||
<div class="sphinx-tabs docutils container">
|
||||
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" aria-selected="true" class="sphinx-tabs-tab group-tab" id="tab-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tab" tabindex="0">[<a class="reference external" href="mailto:root%40searx-archlinux">root<span>@</span>searx-archlinux</a>]</button></div><div aria-labelledby="tab-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" class="sphinx-tabs-panel group-tab" id="panel-16-W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" name="W3Jvb3RAc2VhcngtYXJjaGxpbnV4XQ==" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ ./utils/filtron.sh nginx install
|
||||
$ ./utils/morty.sh nginx install
|
||||
|
@ -60,7 +60,7 @@ If you are not satisfied with the original result layout,
|
||||
you can use your owm template by placing the template under
|
||||
<code class="docutils literal notranslate"><span class="pre">searx/templates/{theme_name}/result_templates/{template_name}</span></code> and setting
|
||||
<code class="docutils literal notranslate"><span class="pre">result_template</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">{template_name}</span></code>.</p>
|
||||
<p>Futhermore, if you do not want to expose these engines on a public instance, you can
|
||||
<p>Furthermore, if you do not want to expose these engines on a public instance, you can
|
||||
still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in the <a class="reference external" href="private-engines.html#private-engines">blog post about
|
||||
private engines</a>.</p>
|
||||
<section id="configuring-searx-to-use-the-stores">
|
||||
@ -69,7 +69,7 @@ private engines</a>.</p>
|
||||
structure.</p>
|
||||
<section id="redis">
|
||||
<h3>Redis<a class="headerlink" href="#redis" title="Permalink to this heading">¶</a></h3>
|
||||
<p>Reqired package: <code class="docutils literal notranslate"><span class="pre">redis</span></code></p>
|
||||
<p>Required package: <code class="docutils literal notranslate"><span class="pre">redis</span></code></p>
|
||||
<p>Redis is a key value based data store usually stored in memory.</p>
|
||||
<p>Select a database to search in and set its index in the option <code class="docutils literal notranslate"><span class="pre">db</span></code>. You can
|
||||
either look for exact matches or use partial keywords to find what you are looking for
|
||||
|
@ -59,7 +59,7 @@ ones are supported now:</p>
|
||||
<code class="docutils literal notranslate"><span class="pre">base_url</span></code> for all them.</p>
|
||||
<p>Please note that if you are not using HTTPS to access these engines, you have to enable
|
||||
HTTP requests by setting <code class="docutils literal notranslate"><span class="pre">enable_http</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
||||
<p>Futhermore, if you do not want to expose these engines on a public instance, you can
|
||||
<p>Furthermore, if you do not want to expose these engines on a public instance, you can
|
||||
still add them and limit the access by setting <code class="docutils literal notranslate"><span class="pre">tokens</span></code> as described in the <a class="reference external" href="private-engines.html#private-engines">blog post about
|
||||
private engines</a>.</p>
|
||||
<section id="configuring-searx-for-search-engines">
|
||||
@ -91,7 +91,7 @@ configured to read from <code class="docutils literal notranslate"><span class="
|
||||
small-scale (less than 10 million documents) data collections. E.g. it is great for storing
|
||||
web pages you have visited and searching in the contents later.</p>
|
||||
<p>The engine supports faceted search, so you can search in a subset of documents of the collection.
|
||||
Futhermore, you can search in Meilisearch instances that require authentication by setting <code class="docutils literal notranslate"><span class="pre">auth_token</span></code>.</p>
|
||||
Furthermore, you can search in Meilisearch instances that require authentication by setting <code class="docutils literal notranslate"><span class="pre">auth_token</span></code>.</p>
|
||||
<p>Here is a simple example to query a Meilisearch instance:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">engine </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">meilisearch</span><span class="w"></span>
|
||||
|
@ -94,7 +94,7 @@ use the option <code class="docutils literal notranslate"><span class="pre">limi
|
||||
<p>Before enabling MySQL engine, you must install the package <code class="docutils literal notranslate"><span class="pre">mysql-connector-python</span></code>.</p>
|
||||
<p>The authentication plugin is configurable by setting <code class="docutils literal notranslate"><span class="pre">auth_plugin</span></code> in the attributes.
|
||||
By default it is set to <code class="docutils literal notranslate"><span class="pre">caching_sha2_password</span></code>.</p>
|
||||
<p>This is an example configuration for quering a MySQL server:</p>
|
||||
<p>This is an example configuration for querying a MySQL server:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysql</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">engine </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mysql_server</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">database </span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_database</span><span class="w"></span>
|
||||
|
@ -110,7 +110,7 @@ settings. However, the standard way is the following:</p>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p>paging</p></td>
|
||||
<td><p>boolean</p></td>
|
||||
<td><p>support multible pages</p></td>
|
||||
<td><p>support multiple pages</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p>time_range_support</p></td>
|
||||
<td><p>boolean</p></td>
|
||||
@ -339,7 +339,7 @@ parameters with default value can be redefined for special purposes.</p>
|
||||
<section id="parsed-arguments">
|
||||
<h3><a class="toc-backref" href="#id12" role="doc-backlink">parsed arguments</a><a class="headerlink" href="#parsed-arguments" title="Permalink to this heading">¶</a></h3>
|
||||
<p>The function <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">request(query,</span> <span class="pre">params):</span></code> always returns the <code class="docutils literal notranslate"><span class="pre">params</span></code>
|
||||
variable. Inside searx, the following paramters can be used to specify a search
|
||||
variable. Inside searx, the following parameters can be used to specify a search
|
||||
request:</p>
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
|
@ -58,7 +58,7 @@ documentation, with the builders from the <a class="reference external" href="ht
|
||||
generated and deployed at <a class="reference external" href="https://searx.github.io/searx/.">github.io</a>. For build prerequisites read
|
||||
<a class="reference internal" href="../admin/buildhosts.html#docs-build"><span class="std std-ref">Build docs</span></a>.</p>
|
||||
<p>The source files of Searx’s documentation are located at <a class="reference external" href="https://github.com/searx/searx/blob/master/docs">Origin: docs</a>. Sphinx
|
||||
assumes source files to be encoded in UTF-8 by defaul. Run <a class="reference internal" href="contribution_guide.html#make-docs-live"><span class="std std-ref">make docs.live</span></a> to build HTML while editing.</p>
|
||||
assumes source files to be encoded in UTF-8 by default. Run <a class="reference internal" href="contribution_guide.html#make-docs-live"><span class="std std-ref">make docs.live</span></a> to build HTML while editing.</p>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Further reading</p>
|
||||
<ul class="simple">
|
||||
@ -318,13 +318,13 @@ To refer a point in the documentation a anchor is needed ...
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To refer anchors use the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref">ref role</a> markup:</p>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span>Visit chapter <span class="na">:ref:</span><span class="nv">`reST anchor`</span>. Or set hyperlink text manualy :ref:`foo
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span>Visit chapter <span class="na">:ref:</span><span class="nv">`reST anchor`</span>. Or set hyperlink text manually :ref:`foo
|
||||
bar <reST anchor>`.
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="rst-example admonition">
|
||||
<p class="admonition-title"><code class="docutils literal notranslate"><span class="pre">:ref:</span></code> role</p>
|
||||
<p>Visist chapter <a class="reference internal" href="#rest-anchor"><span class="std std-ref">Anchors</span></a>. Or set hyperlink text manualy <a class="reference internal" href="#rest-anchor"><span class="std std-ref">foo
|
||||
<p>Visist chapter <a class="reference internal" href="#rest-anchor"><span class="std std-ref">Anchors</span></a>. Or set hyperlink text manually <a class="reference internal" href="#rest-anchor"><span class="std std-ref">foo
|
||||
bar</span></a>.</p>
|
||||
</div>
|
||||
</section>
|
||||
@ -639,15 +639,15 @@ in a specific way.</p>
|
||||
is flexible. To get best results in the generated output format, install
|
||||
<a class="reference external" href="https://www.imagemagick.org">ImageMagick</a> and <a class="reference external" href="https://graphviz.gitlab.io">Graphviz</a>.</p>
|
||||
</aside>
|
||||
<p>Searx’s sphinx setup includes: <a class="reference external" href="https://return42.github.io/linuxdoc/linuxdoc-howto/kfigure.html#kfigure" title="(in LinuxDoc v20210324)"><span>Scalable figure and image handling</span></a>. Scaleable here means;
|
||||
scaleable in sense of the build process. Normally in absence of a converter
|
||||
<p>Searx’s sphinx setup includes: <a class="reference external" href="https://return42.github.io/linuxdoc/linuxdoc-howto/kfigure.html#kfigure" title="(in LinuxDoc v20210324)"><span>Scalable figure and image handling</span></a>. Scalable here means;
|
||||
scalable in sense of the build process. Normally in absence of a converter
|
||||
tool, the build process will break. From the authors POV it’s annoying to care
|
||||
about the build process when handling with images, especially since he has no
|
||||
access to the build process. With <a class="reference external" href="https://return42.github.io/linuxdoc/linuxdoc-howto/kfigure.html#kfigure" title="(in LinuxDoc v20210324)"><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 <code class="docutils literal notranslate"><span class="pre">kernel-figure</span></code> (inheritance
|
||||
of <a class="reference external" href="https://docutils.sourceforge.net/docs/ref/rst/directives.html#figure">figure</a>) and <code class="docutils literal notranslate"><span class="pre">kernel-image</span></code> (inheritance of <a class="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
|
||||
directives. E.g. to insert a figure with a scalable image format use SVG
|
||||
(<a class="reference internal" href="#svg-image-example"><span class="std std-ref">Simple SVG image.</span></a>):</p>
|
||||
<div class="highlight-reST notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_svg image example:</span>
|
||||
|
||||
@ -1286,7 +1286,7 @@ and <em>targets</em> (e.g. a ref to <a class="reference internal" href="#row-bod
|
||||
<span class="m">-</span> cell 4.4
|
||||
|
||||
<span class="m">*</span> - row 5
|
||||
<span class="m">-</span> cell 5.1 with automatic span to rigth end
|
||||
<span class="m">-</span> cell 5.1 with automatic span to right end
|
||||
|
||||
<span class="m">*</span> - row 6
|
||||
<span class="m">-</span> cell 6.1
|
||||
@ -1336,7 +1336,7 @@ cell 2.3 with a span over</p>
|
||||
<td><p>cell 4.4</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><th class="stub"><p>row 5</p></th>
|
||||
<td colspan="4"><p>cell 5.1 with automatic span to rigth end</p></td>
|
||||
<td colspan="4"><p>cell 5.1 with automatic span to right end</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><th class="stub"><p>row 6</p></th>
|
||||
<td><p>cell 6.1</p></td>
|
||||
|
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
@ -58,7 +58,7 @@ via the search query.</p>
|
||||
<dt>Prefix: <code class="docutils literal notranslate"><span class="pre">?</span></code></dt><dd><p>to add engines and categories to the currently selected categories</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Abbrevations of the engines and languages are also accepted. Engine/category
|
||||
<p>Abbreviations of the engines and languages are also accepted. Engine/category
|
||||
modifiers are chainable and inclusive (e.g. with <a class="reference external" href="/?q=%21it%20%21ddg%20%21wp%20qwer">!it !ddg !wp qwer</a> search in IT category <strong>and</strong> duckduckgo
|
||||
<strong>and</strong> wikipedia for <code class="docutils literal notranslate"><span class="pre">qwer</span></code>).</p>
|
||||
<p>See the <a class="reference external" href="/preferences">/preferences page</a> for the list of engines,
|
||||
|
@ -183,18 +183,18 @@ inspect service
|
||||
show service status and log
|
||||
option
|
||||
set one of the available options
|
||||
apache (http://fv-az504-71/searx)
|
||||
apache (http://fv-az573-797/searx)
|
||||
:install: apache site with a reverse proxy (ProxyPass)
|
||||
:remove: apache site searx.conf
|
||||
nginx (http://fv-az504-71/searx)
|
||||
nginx (http://fv-az573-797/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-az504-71/searx
|
||||
PUBLIC_HOST : fv-az504-71
|
||||
PUBLIC_URL : http://fv-az573-797/searx
|
||||
PUBLIC_HOST : fv-az573-797
|
||||
SERVICE_USER : filtron
|
||||
FILTRON_TARGET : 127.0.0.1:8888
|
||||
FILTRON_API : 127.0.0.1:4005
|
||||
|
@ -186,14 +186,14 @@ show
|
||||
:suite: show services of all (or <name>) containers from the LXC suite
|
||||
:images: show information of local images
|
||||
cmd
|
||||
use single qoutes to evaluate in container's bash, e.g.: 'echo $(hostname)'
|
||||
use single quotes to evaluate in container's bash, e.g.: 'echo $(hostname)'
|
||||
-- run command '...' in all containers of the LXC suite
|
||||
:<name>: run command '...' in container <name>
|
||||
install
|
||||
:base: prepare LXC; install basic packages
|
||||
:suite: install LXC searx suite into all (or <name>) containers
|
||||
|
||||
LXC suite: searx --> http://fv-az504-71/searx
|
||||
LXC suite: searx --> http://fv-az573-797/searx
|
||||
suite includes searx, morty & filtron
|
||||
suite images:
|
||||
ubu1804 ubu2004 ubu2010 fedora33 archlinux centos7
|
||||
|
@ -185,22 +185,22 @@ inspect service
|
||||
option
|
||||
set one of the available options
|
||||
:new-key: set new morty key
|
||||
apache : http://fv-az504-71/morty/
|
||||
apache : http://fv-az573-797/morty/
|
||||
:install: apache site with a reverse proxy (ProxyPass)
|
||||
:remove: apache site morty.conf
|
||||
nginx (http://fv-az504-71/morty/)
|
||||
nginx (http://fv-az573-797/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-az504-71/morty/
|
||||
PUBLIC_URL_MORTY: http://fv-az573-797/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-az504-71/morty/
|
||||
url : http://fv-az573-797/morty/
|
||||
server:
|
||||
image_proxy : True
|
||||
</pre></div>
|
||||
|
@ -112,8 +112,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-az504-71/searx
|
||||
SEARX_INSTANCE_NAME : searx@fv-az504-71
|
||||
PUBLIC_URL : http://fv-az573-797/searx
|
||||
SEARX_INSTANCE_NAME : searx@fv-az573-797
|
||||
SERVICE_USER : searx
|
||||
SEARX_INTERNAL_HTTP : http://127.0.0.1:8888
|
||||
</pre></div>
|
||||
|
Loading…
Reference in New Issue
Block a user