mirror of https://github.com/searx/searx
Deploying to gh-pages from @ 42a194898b 🚀
This commit is contained in:
dalf
parent
687dc58cbb
commit
2056b588e5
|
|
@ -64,17 +64,38 @@ from the login (*~/.profile*):
|
|||
Open a second terminal for the configuration tasks and left the ``(searx)$``
|
||||
terminal open for the tasks below.
|
||||
|
||||
Configuration
|
||||
==============
|
||||
|
||||
Create a copy of the :origin:`searx/settings.yml` configuration file in system's
|
||||
*/etc* folder. Configure like shown below -- replace ``searx@\$(uname -n)`` with
|
||||
a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary.
|
||||
.. _use_default_settings.yml:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
To create a initial ``/etc/searx/settings.yml`` you can start with a copy of the
|
||||
file :origin:`utils/templates/etc/searx/use_default_settings.yml`. This setup
|
||||
:option:ref:`use default settings <settings use_default_settings>` from
|
||||
:origin:`searx/settings.yml` and is recommended since :pull:`2291` is merged.
|
||||
|
||||
For minimal Setup, configure like shown below – replace ``searx@\$(uname -n)``
|
||||
with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit
|
||||
``/etc/searx/settings.yml`` to your needs.
|
||||
|
||||
.. kernel-include:: $DOCS_BUILD/includes/searx.rst
|
||||
:start-after: START searx config
|
||||
:end-before: END searx config
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Use default settings
|
||||
|
||||
.. literalinclude:: ../../utils/templates/etc/searx/use_default_settings.yml
|
||||
:language: yaml
|
||||
|
||||
.. group-tab:: searx/settings.yml
|
||||
|
||||
.. literalinclude:: ../../searx/settings.yml
|
||||
:language: yaml
|
||||
|
||||
|
||||
Check
|
||||
=====
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ file.
|
|||
|
||||
.. sidebar:: Further reading ..
|
||||
|
||||
- :ref:`use_default_settings.yml`
|
||||
- :ref:`search API`
|
||||
|
||||
.. contents:: Contents
|
||||
|
|
@ -16,46 +17,129 @@ file.
|
|||
:local:
|
||||
:backlinks: entry
|
||||
|
||||
.. _settings location:
|
||||
|
||||
settings.yml location
|
||||
=====================
|
||||
|
||||
First, searx will try to load settings.yml from these locations:
|
||||
|
||||
1. the full path specified in the ``SEARX_SETTINGS_PATH`` environment variable.
|
||||
2. ``/etc/searx/settings.yml``
|
||||
|
||||
If these files don't exist (or are empty or can't be read), searx uses the :origin:`searx/settings.yml` file.
|
||||
|
||||
|
||||
.. _settings global:
|
||||
|
||||
Global Settings
|
||||
===============
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
general:
|
||||
debug : False # Debug mode, only for development
|
||||
instance_name : "searx" # displayed name
|
||||
|
||||
``debug`` :
|
||||
Allow a more detailed log if you run searx directly. Display *detailed* error
|
||||
messages in the browser too, so this must be deactivated in production.
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
server:
|
||||
port : 8888
|
||||
secret_key : "ultrasecretkey" # change this!
|
||||
debug : False # debug mode, only for development
|
||||
request_timeout : 2.0 # seconds
|
||||
base_url : False # set custom base_url (or False)
|
||||
themes_path : "" # custom ui themes path
|
||||
default_theme : oscar # ui theme
|
||||
useragent_suffix : "" # suffix of searx_useragent, could contain
|
||||
# informations like admins email address
|
||||
image_proxy : False # proxying image results through searx
|
||||
default_locale : "" # default interface locale
|
||||
bind_address : "127.0.0.1" # address to listen on
|
||||
secret_key : "ultrasecretkey" # change this!
|
||||
base_url : False # set custom base_url (or False)
|
||||
image_proxy : False # proxying image results through searx
|
||||
default_locale : "" # default interface locale
|
||||
default_theme : oscar # ui theme
|
||||
default_http_headers:
|
||||
X-Content-Type-Options : nosniff
|
||||
X-XSS-Protection : 1; mode=block
|
||||
X-Download-Options : noopen
|
||||
X-Robots-Tag : noindex, nofollow
|
||||
Referrer-Policy : no-referrer
|
||||
|
||||
``port`` & ``bind_address``:
|
||||
Port number and *bind address* of the searx web application if you run it
|
||||
directly using ``python searx/webapp.py``. Doesn't apply to searx running on
|
||||
Apache or Nginx.
|
||||
|
||||
``secret_key`` :
|
||||
Used for cryptography purpose.
|
||||
|
||||
``base_url`` :
|
||||
The base URL where searx is deployed. Used to create correct inbound links.
|
||||
|
||||
``image_proxy`` :
|
||||
Allow your instance of searx of being able to proxy images. Uses memory space.
|
||||
|
||||
``default_locale`` :
|
||||
Searx interface language. If blank, the locale is detected by using the
|
||||
browser language. If it doesn't work, or you are deploying a language
|
||||
specific instance of searx, a locale can be defined using an ISO language
|
||||
code, like ``fr``, ``en``, ``de``.
|
||||
|
||||
``default_theme`` :
|
||||
Name of the theme you want to use by default on your searx instance.
|
||||
|
||||
.. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
|
||||
|
||||
``default_http_headers``:
|
||||
Set additional HTTP headers, see `#755 <https://github.com/searx/searx/issues/715>`__
|
||||
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
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 : "" # suffix of searx_useragent, could contain informations like an email address to the administrator
|
||||
pool_connections : 100 # Number of different hosts
|
||||
pool_maxsize : 10 # Number of simultaneous requests by host
|
||||
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
|
||||
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
|
||||
# proxies:
|
||||
# http:
|
||||
# - http://proxy1:8080
|
||||
# - http://proxy2:8080
|
||||
# https:
|
||||
# - http://proxy1:8080
|
||||
# - http://proxy2:8080
|
||||
# uncomment below section only if you have more than one network interface
|
||||
# which can be the source of outgoing search requests
|
||||
# source_ips:
|
||||
# - 1.1.1.1
|
||||
# - 1.1.1.2
|
||||
|
||||
#proxies:
|
||||
# http:
|
||||
# - http://proxy1:8080
|
||||
# - http://proxy2:8080
|
||||
# https:
|
||||
# - http://proxy1:8080
|
||||
# - http://proxy2:8080
|
||||
# - socks5://user:password@proxy3:1080
|
||||
# - socks5h://user:password@proxy4:1080
|
||||
|
||||
#source_ips:
|
||||
# - 1.1.1.1
|
||||
# - 1.1.1.2
|
||||
``request_timeout`` :
|
||||
Global timeout of the requests made to others engines in seconds. A bigger
|
||||
timeout will allow to wait for answers from slow engines, but in consequence
|
||||
will slow searx reactivity (the result page may take the time specified in the
|
||||
timeout to load). Can be override by :ref:`settings engine`
|
||||
|
||||
``useragent_suffix`` :
|
||||
Suffix to the user-agent searx uses to send requests to others engines. If an
|
||||
engine wish to block you, a contact info here may be useful to avoid that.
|
||||
|
||||
.. _requests proxies: https://requests.readthedocs.io/en/latest/user/advanced/#proxies
|
||||
.. _PySocks: https://pypi.org/project/PySocks/
|
||||
|
||||
``proxies`` :
|
||||
Define one or more proxies you wish to use, see `requests proxies`_.
|
||||
If there are more than one proxy for one protocol (http, https),
|
||||
requests to the engines are distributed in a round-robin fashion.
|
||||
|
||||
- Proxy: `see <https://2.python-requests.org/en/latest/user/advanced/#proxies>`__.
|
||||
- SOCKS proxies are also supported: `see <https://2.python-requests.org/en/latest/user/advanced/#socks>`__
|
||||
|
||||
``source_ips`` :
|
||||
If you use multiple network interfaces, define from which IP the requests must
|
||||
be made. This parameter is ignored when ``proxies`` is set.
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
locales:
|
||||
en : English
|
||||
|
|
@ -71,59 +155,6 @@ Global Settings
|
|||
ru : Russian
|
||||
ro : Romanian
|
||||
|
||||
|
||||
``port`` :
|
||||
Port number of the searx web application if you run it directly using ``python
|
||||
searx/webapp.py``. Doesn't apply to searx running on Apache or Nginx.
|
||||
|
||||
``secret_key`` :
|
||||
Used for cryptography purpose.
|
||||
|
||||
``debug`` :
|
||||
Allow a more detailed log if you run searx directly. Display *detailed* error
|
||||
messages in the browser too, so this must be deactivated in production.
|
||||
|
||||
``request_timeout`` :
|
||||
Global timeout of the requests made to others engines in seconds. A bigger
|
||||
timeout will allow to wait for answers from slow engines, but in consequence
|
||||
will slow searx reactivity (the result page may take the time specified in the
|
||||
timeout to load)
|
||||
|
||||
``base_url`` :
|
||||
The base URL where searx is deployed. Used to create correct inbound links.
|
||||
|
||||
``themes_path`` :
|
||||
Path to where the themes are located. If you didn't develop anything, leave it
|
||||
blank.
|
||||
|
||||
``default_theme`` :
|
||||
Name of the theme you want to use by default on your searx instance.
|
||||
|
||||
``useragent_suffix`` :
|
||||
Suffix to the user-agent searx uses to send requests to others engines. If an
|
||||
engine wish to block you, a contact info here may be useful to avoid that.
|
||||
|
||||
``image_proxy`` :
|
||||
Allow your instance of searx of being able to proxy images. Uses memory space.
|
||||
|
||||
``default_locale`` :
|
||||
Searx interface language. If blank, the locale is detected by using the
|
||||
browser language. If it doesn't work, or you are deploying a language
|
||||
specific instance of searx, a locale can be defined using an ISO language
|
||||
code, like ``fr``, ``en``, ``de``.
|
||||
|
||||
.. _requests proxies: https://requests.readthedocs.io/en/latest/user/advanced/#proxies
|
||||
.. _PySocks: https://pypi.org/project/PySocks/
|
||||
|
||||
``proxies`` :
|
||||
Define one or more proxies you wish to use, see `requests proxies`_.
|
||||
If there are more than one proxy for one protocol (http, https),
|
||||
requests to the engines are distributed in a round-robin fashion.
|
||||
|
||||
``source_ips`` :
|
||||
If you use multiple network interfaces, define from which IP the requests must
|
||||
be made. This parameter is ignored when ``proxies`` is set.
|
||||
|
||||
``locales`` :
|
||||
Locales codes and their names. Available translations of searx interface.
|
||||
|
||||
|
|
@ -208,19 +239,7 @@ Engine settings
|
|||
engines, and so won't be described here.
|
||||
|
||||
|
||||
.. _settings location:
|
||||
|
||||
settings.yml location
|
||||
=====================
|
||||
|
||||
First, searx will try to load settings.yml from these locations:
|
||||
|
||||
1. the full path specified in the ``SEARX_SETTINGS_PATH`` environment variable.
|
||||
2. ``/etc/searx/settings.yml``
|
||||
|
||||
If these files don't exist (or are empty or can't be read), searx uses the :origin:`searx/settings.yml` file.
|
||||
|
||||
.. _ settings use_default_settings:
|
||||
.. _settings use_default_settings:
|
||||
|
||||
use_default_settings
|
||||
====================
|
||||
|
|
|
|||
|
|
@ -1719,22 +1719,7 @@
|
|||
<td><p>y</p></td>
|
||||
<td><p>y</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><th class="stub"><p>seedpeer</p></th>
|
||||
<th class="stub"><p>!speu</p></th>
|
||||
<td><p>seedpeer</p></td>
|
||||
<td><p>2.0</p></td>
|
||||
<td><p>files, music, videos</p></td>
|
||||
<td></td>
|
||||
<td><p>y</p></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td><p>1</p></td>
|
||||
<td></td>
|
||||
<td><p>y</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><th class="stub"><p>naver</p></th>
|
||||
<tr class="row-even"><th class="stub"><p>naver</p></th>
|
||||
<th class="stub"><p>!nvr</p></th>
|
||||
<td><p>xpath</p></td>
|
||||
<td><p>2.0</p></td>
|
||||
|
|
@ -1749,7 +1734,7 @@
|
|||
<td><p>y</p></td>
|
||||
<td><p>y</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><th class="stub"><p>rubygems</p></th>
|
||||
<tr class="row-odd"><th class="stub"><p>rubygems</p></th>
|
||||
<th class="stub"><p>!rbg</p></th>
|
||||
<td><p>xpath</p></td>
|
||||
<td><p>2.0</p></td>
|
||||
|
|
@ -1764,7 +1749,7 @@
|
|||
<td><p>y</p></td>
|
||||
<td><p>y</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><th class="stub"><p>peertube</p></th>
|
||||
<tr class="row-even"><th class="stub"><p>peertube</p></th>
|
||||
<th class="stub"><p>!ptb</p></th>
|
||||
<td><p>peertube</p></td>
|
||||
<td><p>2.0</p></td>
|
||||
|
|
|
|||
|
|
@ -95,9 +95,9 @@
|
|||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="update-searx.html">How to update</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="settings.html"><code class="docutils literal notranslate"><span class="pre">settings.yml</span></code></a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="settings.html#settings-yml-location">settings.yml location</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="settings.html#global-settings">Global Settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="settings.html#engine-settings">Engine settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="settings.html#settings-yml-location">settings.yml location</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="settings.html#use-default-settings">use_default_settings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -58,55 +58,124 @@ file.</p>
|
|||
<div class="sidebar">
|
||||
<p class="sidebar-title">Further reading ..</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="installation-searx.html#use-default-settings-yml"><span class="std std-ref">Configuration</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../dev/search_api.html#search-api"><span class="std std-ref">Search API</span></a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="contents local topic" id="contents">
|
||||
<p class="topic-title">Contents</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#global-settings" id="id2">Global Settings</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-settings" id="id3">Engine settings</a></p></li>
|
||||
<li><p><a class="reference internal" href="#settings-yml-location" id="id4">settings.yml location</a></p></li>
|
||||
<li><p><a class="reference internal" href="#settings-yml-location" id="id2">settings.yml location</a></p></li>
|
||||
<li><p><a class="reference internal" href="#global-settings" id="id3">Global Settings</a></p></li>
|
||||
<li><p><a class="reference internal" href="#engine-settings" id="id4">Engine settings</a></p></li>
|
||||
<li><p><a class="reference internal" href="#use-default-settings" id="id5">use_default_settings</a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="settings-yml-location">
|
||||
<span id="settings-location"></span><h2><a class="toc-backref" href="#id2">settings.yml location</a><a class="headerlink" href="#settings-yml-location" title="Permalink to this headline">¶</a></h2>
|
||||
<p>First, searx will try to load settings.yml from these locations:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>the full path specified in the <code class="docutils literal notranslate"><span class="pre">SEARX_SETTINGS_PATH</span></code> environment variable.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">/etc/searx/settings.yml</span></code></p></li>
|
||||
</ol>
|
||||
<p>If these files don’t exist (or are empty or can’t be read), searx uses the <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">git://searx/settings.yml</a> file.</p>
|
||||
</div>
|
||||
<div class="section" id="global-settings">
|
||||
<span id="settings-global"></span><h2><a class="toc-backref" href="#id2">Global Settings</a><a class="headerlink" href="#global-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<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="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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">debug</span></code> :</dt><dd><p>Allow a more detailed log if you run searx directly. Display <em>detailed</em> error
|
||||
messages in the browser too, so this must be deactivated in production.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<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">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">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">request_timeout</span> <span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">2.0</span> <span class="c1"># seconds</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">themes_path</span> <span class="p p-Indicator">:</span> <span class="s">""</span> <span class="c1"># custom ui themes path</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">useragent_suffix</span> <span class="p p-Indicator">:</span> <span class="s">""</span> <span class="c1"># suffix of searx_useragent, could contain</span>
|
||||
<span class="c1"># informations like admins email address</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">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>
|
||||
<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"># suffix of searx_useragent, could contain 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="c1">#proxies:</span>
|
||||
<span class="c1"># http:</span>
|
||||
<span class="c1"># - http://proxy1:8080</span>
|
||||
<span class="c1"># - http://proxy2:8080</span>
|
||||
<span class="c1"># https:</span>
|
||||
<span class="c1"># - http://proxy1:8080</span>
|
||||
<span class="c1"># - http://proxy2:8080</span>
|
||||
<span class="c1"># - socks5://user:password@proxy3:1080</span>
|
||||
<span class="c1"># - socks5h://user:password@proxy4:1080</span>
|
||||
|
||||
<span class="c1">#source_ips:</span>
|
||||
<span class="c1"># - 1.1.1.1</span>
|
||||
<span class="c1"># - 1.1.1.2</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">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>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">port</span></code> & <code class="docutils literal notranslate"><span class="pre">bind_address</span></code>:</dt><dd><p>Port number and <em>bind address</em> of the searx web application if you run it
|
||||
directly using <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">searx/webapp.py</span></code>. Doesn’t apply to searx running on
|
||||
Apache or Nginx.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">secret_key</span></code> :</dt><dd><p>Used for cryptography purpose.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code> :</dt><dd><p>The base URL where searx is deployed. Used to create correct inbound links.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">image_proxy</span></code> :</dt><dd><p>Allow your instance of searx of being able to proxy images. Uses memory space.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">default_locale</span></code> :</dt><dd><p>Searx interface language. If blank, the locale is detected by using the
|
||||
browser language. If it doesn’t work, or you are deploying a language
|
||||
specific instance of searx, a locale can be defined using an ISO language
|
||||
code, like <code class="docutils literal notranslate"><span class="pre">fr</span></code>, <code class="docutils literal notranslate"><span class="pre">en</span></code>, <code class="docutils literal notranslate"><span class="pre">de</span></code>.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">default_theme</span></code> :</dt><dd><p>Name of the theme you want to use by default on your searx instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">default_http_headers</span></code>:</dt><dd><p>Set additional HTTP headers, see <a class="reference external" href="https://github.com/searx/searx/issues/715">#755</a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<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>
|
||||
<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="c1"># uncomment below section if you want to use a proxy</span>
|
||||
<span class="c1"># proxies:</span>
|
||||
<span class="c1"># http:</span>
|
||||
<span class="c1"># - http://proxy1:8080</span>
|
||||
<span class="c1"># - http://proxy2:8080</span>
|
||||
<span class="c1"># https:</span>
|
||||
<span class="c1"># - http://proxy1:8080</span>
|
||||
<span class="c1"># - http://proxy2:8080</span>
|
||||
<span class="c1"># uncomment below section only if you have more than one network interface</span>
|
||||
<span class="c1"># which can be the source of outgoing search requests</span>
|
||||
<span class="c1"># source_ips:</span>
|
||||
<span class="c1"># - 1.1.1.1</span>
|
||||
<span class="c1"># - 1.1.1.2</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">request_timeout</span></code> :</dt><dd><p>Global timeout of the requests made to others engines in seconds. A bigger
|
||||
timeout will allow to wait for answers from slow engines, but in consequence
|
||||
will slow searx reactivity (the result page may take the time specified in the
|
||||
timeout to load). Can be override by <a class="reference internal" href="#settings-engine"><span class="std std-ref">Engine settings</span></a></p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">useragent_suffix</span></code> :</dt><dd><p>Suffix to the user-agent searx uses to send requests to others engines. If an
|
||||
engine wish to block you, a contact info here may be useful to avoid that.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">proxies</span></code> :</dt><dd><p>Define one or more proxies you wish to use, see <a class="reference external" href="https://requests.readthedocs.io/en/latest/user/advanced/#proxies">requests proxies</a>.
|
||||
If there are more than one proxy for one protocol (http, https),
|
||||
requests to the engines are distributed in a round-robin fashion.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Proxy: <a class="reference external" href="https://2.python-requests.org/en/latest/user/advanced/#proxies">see</a>.</p></li>
|
||||
<li><p>SOCKS proxies are also supported: <a class="reference external" href="https://2.python-requests.org/en/latest/user/advanced/#socks">see</a></p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">source_ips</span></code> :</dt><dd><p>If you use multiple network interfaces, define from which IP the requests must
|
||||
be made. This parameter is ignored when <code class="docutils literal notranslate"><span class="pre">proxies</span></code> is set.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<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>
|
||||
|
|
@ -122,51 +191,12 @@ file.</p>
|
|||
</pre></div>
|
||||
</div>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">port</span></code> :</dt><dd><p>Port number of the searx web application if you run it directly using <code class="docutils literal notranslate"><span class="pre">python</span>
|
||||
<span class="pre">searx/webapp.py</span></code>. Doesn’t apply to searx running on Apache or Nginx.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">secret_key</span></code> :</dt><dd><p>Used for cryptography purpose.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">debug</span></code> :</dt><dd><p>Allow a more detailed log if you run searx directly. Display <em>detailed</em> error
|
||||
messages in the browser too, so this must be deactivated in production.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">request_timeout</span></code> :</dt><dd><p>Global timeout of the requests made to others engines in seconds. A bigger
|
||||
timeout will allow to wait for answers from slow engines, but in consequence
|
||||
will slow searx reactivity (the result page may take the time specified in the
|
||||
timeout to load)</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">base_url</span></code> :</dt><dd><p>The base URL where searx is deployed. Used to create correct inbound links.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">themes_path</span></code> :</dt><dd><p>Path to where the themes are located. If you didn’t develop anything, leave it
|
||||
blank.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">default_theme</span></code> :</dt><dd><p>Name of the theme you want to use by default on your searx instance.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">useragent_suffix</span></code> :</dt><dd><p>Suffix to the user-agent searx uses to send requests to others engines. If an
|
||||
engine wish to block you, a contact info here may be useful to avoid that.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">image_proxy</span></code> :</dt><dd><p>Allow your instance of searx of being able to proxy images. Uses memory space.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">default_locale</span></code> :</dt><dd><p>Searx interface language. If blank, the locale is detected by using the
|
||||
browser language. If it doesn’t work, or you are deploying a language
|
||||
specific instance of searx, a locale can be defined using an ISO language
|
||||
code, like <code class="docutils literal notranslate"><span class="pre">fr</span></code>, <code class="docutils literal notranslate"><span class="pre">en</span></code>, <code class="docutils literal notranslate"><span class="pre">de</span></code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="simple">
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">proxies</span></code> :</dt><dd><p>Define one or more proxies you wish to use, see <a class="reference external" href="https://requests.readthedocs.io/en/latest/user/advanced/#proxies">requests proxies</a>.
|
||||
If there are more than one proxy for one protocol (http, https),
|
||||
requests to the engines are distributed in a round-robin fashion.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">source_ips</span></code> :</dt><dd><p>If you use multiple network interfaces, define from which IP the requests must
|
||||
be made. This parameter is ignored when <code class="docutils literal notranslate"><span class="pre">proxies</span></code> is set.</p>
|
||||
</dd>
|
||||
<dt><code class="docutils literal notranslate"><span class="pre">locales</span></code> :</dt><dd><p>Locales codes and their names. Available translations of searx interface.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="engine-settings">
|
||||
<span id="settings-engine"></span><h2><a class="toc-backref" href="#id3">Engine settings</a><a class="headerlink" href="#engine-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="settings-engine"></span><h2><a class="toc-backref" href="#id4">Engine settings</a><a class="headerlink" href="#engine-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="sidebar">
|
||||
<p class="sidebar-title">Further reading ..</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -234,17 +264,8 @@ by using the full ISO code of language and country, like <code class="docutils l
|
|||
engines, and so won’t be described here.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="settings-yml-location">
|
||||
<span id="settings-location"></span><h2><a class="toc-backref" href="#id4">settings.yml location</a><a class="headerlink" href="#settings-yml-location" title="Permalink to this headline">¶</a></h2>
|
||||
<p>First, searx will try to load settings.yml from these locations:</p>
|
||||
<ol class="arabic simple">
|
||||
<li><p>the full path specified in the <code class="docutils literal notranslate"><span class="pre">SEARX_SETTINGS_PATH</span></code> environment variable.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">/etc/searx/settings.yml</span></code></p></li>
|
||||
</ol>
|
||||
<p>If these files don’t exist (or are empty or can’t be read), searx uses the <a class="reference external" href="https://github.com/searx/searx/blob/master/searx/settings.yml">git://searx/settings.yml</a> file.</p>
|
||||
</div>
|
||||
<div class="section" id="use-default-settings">
|
||||
<h2><a class="toc-backref" href="#id5">use_default_settings</a><a class="headerlink" href="#use-default-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<span id="settings-use-default-settings"></span><h2><a class="toc-backref" href="#id5">use_default_settings</a><a class="headerlink" href="#use-default-settings" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>If searx is cloned from a git repository, most probably there is no need to have an user settings.</p>
|
||||
|
|
|
|||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
|
|
@ -138,6 +138,7 @@ reverse proxy for filtron on all containers of the <a class="reference internal"
|
|||
<span class="c1"># ---------</span>
|
||||
|
||||
<span class="c1"># SEARX_INTERNAL_URL="127.0.0.1:8888"</span>
|
||||
<span class="c1"># SEARX_SETTINGS_TEMPLATE="${REPO_ROOT}/utils/templates/etc/searx/use_default_settings.yml"</span>
|
||||
|
||||
<span class="c1"># Only change, if you maintain a searx brand in your searx fork.</span>
|
||||
<span class="c1"># GIT_BRANCH="${GIT_BRANCH:-master}"</span>
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ into this user account. The installation is described in chapter
|
|||
(<a class="reference internal" href="index.html#toolboxing-common"><span class="std std-ref">Common commands & environment</span></a>):</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage::
|
||||
searx.sh shell
|
||||
searx.sh install [all|user|searx-src|pyenv|uwsgi|packages|buildhost]
|
||||
searx.sh install [all|user|searx-src|pyenv|uwsgi|packages|settings|buildhost]
|
||||
searx.sh update [searx]
|
||||
searx.sh remove [all|user|pyenv|searx-src]
|
||||
searx.sh activate [service]
|
||||
|
|
|
|||
Loading…
Reference in New Issue