summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/api.rst2
-rw-r--r--docs/admin/architecture.rst6
-rw-r--r--docs/admin/engines/nosql-engines.rst2
-rw-r--r--docs/admin/engines/settings.rst32
-rw-r--r--docs/admin/engines/sql-engines.rst4
-rw-r--r--docs/admin/filtron.rst4
-rw-r--r--docs/admin/installation-apache.rst8
-rw-r--r--docs/admin/installation-docker.rst2
-rw-r--r--docs/admin/installation-nginx.rst18
-rw-r--r--docs/admin/installation-searx.rst14
-rw-r--r--docs/admin/installation-uwsgi.rst4
-rw-r--r--docs/admin/installation.rst10
-rw-r--r--docs/admin/morty.rst4
-rw-r--r--docs/admin/update-searx.rst4
14 files changed, 57 insertions, 57 deletions
diff --git a/docs/admin/api.rst b/docs/admin/api.rst
index 8c782ea9c..21d1a8626 100644
--- a/docs/admin/api.rst
+++ b/docs/admin/api.rst
@@ -83,7 +83,7 @@ Embed search bar
================
The search bar can be embedded into websites. Just paste the example into the
-HTML of the site. URL of the searx instance and values are customizable.
+HTML of the site. URL of the SearXNG instance and values are customizable.
.. code:: html
diff --git a/docs/admin/architecture.rst b/docs/admin/architecture.rst
index edc518ab1..45d952282 100644
--- a/docs/admin/architecture.rst
+++ b/docs/admin/architecture.rst
@@ -14,10 +14,10 @@ Architecture
- Searx: :ref:`installation basic`
Herein you will find some hints and suggestions about typical architectures of
-searx infrastructures.
+SearXNG infrastructures.
We start with a contribution from :pull-searx:`@dalf <1776#issuecomment-567917320>`.
-It shows a *reference* setup for public searx instances which can build up and
+It shows a *reference* setup for public SearXNG instances which can build up and
maintained by the scripts from our :ref:`toolboxing`.
.. _arch public:
@@ -25,4 +25,4 @@ maintained by the scripts from our :ref:`toolboxing`.
.. kernel-figure:: arch_public.dot
:alt: arch_public.dot
- Reference architecture of a public searx setup.
+ Reference architecture of a public SearXNG setup.
diff --git a/docs/admin/engines/nosql-engines.rst b/docs/admin/engines/nosql-engines.rst
index 19a723c4e..36a7c6713 100644
--- a/docs/admin/engines/nosql-engines.rst
+++ b/docs/admin/engines/nosql-engines.rst
@@ -42,7 +42,7 @@ Extra Dependencies
------------------
For using :ref:`engine redis_server` or :ref:`engine mongodb` you need to
-install additional packages in Python's Virtual Environment of your SearxNG
+install additional packages in Python's Virtual Environment of your SearXNG
instance. To switch into the environment (:ref:`searx-src`) you can use
:ref:`searx.sh`::
diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst
index 1078f9648..459b4b46c 100644
--- a/docs/admin/engines/settings.rst
+++ b/docs/admin/engines/settings.rst
@@ -27,7 +27,7 @@ The initial ``settings.yml`` we be load 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
+If these files don't exist (or are empty or can't be read), SearXNG uses the
:origin:`searx/settings.yml` file. Read :ref:`settings use_default_settings` to
see how you can simplify your *user defined* ``settings.yml``.
@@ -71,11 +71,11 @@ Global Settings
general:
debug: false # Debug mode, only for development
- instance_name: "searxng" # displayed name
+ instance_name: "SearXNG" # displayed name
contact_url: false # mailto:contact@example.com
``debug`` : ``$SEARX_DEBUG``
- Allow a more detailed log if you run searx directly. Display *detailed* error
+ Allow a more detailed log if you run SearXNG directly. Display *detailed* error
messages in the browser too, so this must be deactivated in production.
``contact_url``:
@@ -110,29 +110,29 @@ Global Settings
rebuild instance's environment :ref:`utils/brand.env <make buildenv>`.
``base_url`` : :ref:`buildenv SEARX_URL <make buildenv>`
- The base URL where searx is deployed. Used to create correct inbound links.
+ The base URL where SearXNG is deployed. Used to create correct inbound links.
If you change the value, don't forget to rebuild instance's environment
(:ref:`utils/brand.env <make buildenv>`)
``port`` & ``bind_address``: :ref:`buildenv SEARX_PORT & SEARX_BIND_ADDRESS <make buildenv>`
- 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
+ Port number and *bind address* of the SearXNG web application if you run it
+ directly using ``python searx/webapp.py``. Doesn't apply to SearXNG running on
Apache or Nginx.
``secret_key`` : ``$SEARX_SECRET``
Used for cryptography purpose.
``image_proxy`` :
- Allow your instance of searx of being able to proxy images. Uses memory space.
+ Allow your instance of SearXNG of being able to proxy images. Uses memory space.
``default_locale`` :
- Searx interface language. If blank, the locale is detected by using the
+ SearXNG 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.
+ Name of the theme you want to use by default on your SearXNG instance.
.. _HTTP headers: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
@@ -171,11 +171,11 @@ Communication with search engines.
``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
+ will slow SearXNG 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
+ Suffix to the user-agent SearXNG uses to send requests to others engines. If an
engine wish to block you, a contact info here may be useful to avoid that.
``keepalive_expiry``:
@@ -201,7 +201,7 @@ Communication with search engines.
* ``[ 192.168.0.1, fe80::/126 ]``
``retries`` :
- Number of retry in case of an HTTP error. On each retry, searx uses an
+ Number of retry in case of an HTTP error. On each retry, SearXNG uses an
different proxy and source ip.
``retry_on_http_error`` :
@@ -271,7 +271,7 @@ engine is shown. Most of the options have a default value or even are optional.
- socks5h://user:password@proxy4:1080
``name`` :
- Name that will be used across searx to define this engine. In settings, on
+ Name that will be used across SearXNG to define this engine. In settings, on
the result page...
``engine`` :
@@ -361,7 +361,7 @@ and can relied on the default configuration :origin:`searx/settings.yml` using:
``engines:``
With ``use_default_settings: true``, each settings can be override in a
similar way, the ``engines`` section is merged according to the engine
- ``name``. In this example, searx will load all the engine and the arch linux
+ ``name``. In this example, SearXNG will load all the engine and the arch linux
wiki engine has a :ref:`token <private engines>`:
.. code-block:: yaml
@@ -375,7 +375,7 @@ and can relied on the default configuration :origin:`searx/settings.yml` using:
``engines:`` / ``remove:``
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
+ example is similar to the above one, but SearXNG doesn't load the the google
engine:
.. code-block:: yaml
@@ -392,7 +392,7 @@ and can relied on the default configuration :origin:`searx/settings.yml` using:
``engines:`` / ``keep_only:``
As an alternative, it is possible to specify the engines to keep. In the
- following example, searx has only two engines:
+ following example, SearXNG has only two engines:
.. code-block:: yaml
diff --git a/docs/admin/engines/sql-engines.rst b/docs/admin/engines/sql-engines.rst
index ee7f31c27..713ef9a40 100644
--- a/docs/admin/engines/sql-engines.rst
+++ b/docs/admin/engines/sql-engines.rst
@@ -10,7 +10,7 @@ SQL Engines
- `PostgreSQL <https://www.postgresql.org>`_
- `MySQL <https://www.mysql.com>`_
-With the *SQL engines* you can bind SQL databases into SearxNG. The following
+With the *SQL engines* you can bind SQL databases into SearXNG. The following
Relational Database Management System (RDBMS) are supported:
- :ref:`engine sqlite`
@@ -98,7 +98,7 @@ Extra Dependencies
------------------
For using :ref:`engine postgresql` or :ref:`engine mysql_server` you need to
-install additional packages in Python's Virtual Environment of your SearxNG
+install additional packages in Python's Virtual Environment of your SearXNG
instance. To switch into the environment (:ref:`searx-src`) you can use
:ref:`searx.sh`::
diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst
index 41c4a31d6..dd3cfc675 100644
--- a/docs/admin/filtron.rst
+++ b/docs/admin/filtron.rst
@@ -18,7 +18,7 @@ How to protect an instance
.. _filtron: https://github.com/asciimoo/filtron
-Searx depends on external search services. To avoid the abuse of these services
+SearXNG depends on external search services. To avoid the abuse of these services
it is advised to limit the number of requests processed by searx.
An application firewall, filtron_ solves exactly this problem. Filtron is just
@@ -187,5 +187,5 @@ Use it along with ``nginx`` with the following example configuration.
Requests are coming from port 4004 going through filtron and then forwarded to
-port 8888 where a searx is being run. For a complete setup see: :ref:`nginx
+port 8888 where a SearXNG is being run. For a complete setup see: :ref:`nginx
searx site`.
diff --git a/docs/admin/installation-apache.rst b/docs/admin/installation-apache.rst
index 311b5c250..4ec085825 100644
--- a/docs/admin/installation-apache.rst
+++ b/docs/admin/installation-apache.rst
@@ -170,13 +170,13 @@ Apache Reverse Proxy
.. sidebar:: public to the internet?
- If your searx instance is public, stop here and first install :ref:`filtron
+ If your SearXNG instance is public, stop here and first install :ref:`filtron
reverse proxy <filtron.sh>` and :ref:`result proxy morty <morty.sh>`, see
- :ref:`installation scripts`. If already done, follow setup: *searx via
+ :ref:`installation scripts`. If already done, follow setup: *SearXNG via
filtron plus morty*.
To setup a Apache revers proxy you have to enable the *headers* and *proxy*
-modules and create a `Location`_ configuration for the searx site. In most
+modules and create a `Location`_ configuration for the SearXNG site. In most
distributions you have to un-comment the lines in the main configuration file,
except in :ref:`The Debian Layout`.
@@ -234,7 +234,7 @@ proxied host.
.. tabs::
- .. group-tab:: searx via filtron plus morty
+ .. group-tab:: SearXNG via filtron plus morty
Use this setup, if your instance is public to the internet, compare
figure: :ref:`architecture <arch public>` and :ref:`installation scripts`.
diff --git a/docs/admin/installation-docker.rst b/docs/admin/installation-docker.rst
index 750d41679..33524e2f2 100644
--- a/docs/admin/installation-docker.rst
+++ b/docs/admin/installation-docker.rst
@@ -98,7 +98,7 @@ stoped. To get rid of a container use ``container rm``:
.. sidebar:: Warning
- This might remove all docker items, not only those from searxng.
+ This might remove all docker items, not only those from SearXNG.
If you won't use docker anymore and want to get rid of all conatiners & images
use the following *prune* command:
diff --git a/docs/admin/installation-nginx.rst b/docs/admin/installation-nginx.rst
index 97966c8c4..4f58299ee 100644
--- a/docs/admin/installation-nginx.rst
+++ b/docs/admin/installation-nginx.rst
@@ -128,17 +128,17 @@ depends on the linux distribution:
.. _nginx searx site:
-A nginx searx site
-==================
+A nginx SearXNG site
+====================
.. sidebar:: public to the internet?
- If your searx instance is public, stop here and first install :ref:`filtron
+ If your SearXNG instance is public, stop here and first install :ref:`filtron
reverse proxy <filtron.sh>` and :ref:`result proxy morty <morty.sh>`, see
- :ref:`installation scripts`. If already done, follow setup: *searx via
+ :ref:`installation scripts`. If already done, follow setup: *SearXNG via
filtron plus morty*.
-Now you have to create a configuration for the searx site. If nginx_ is new to
+Now you have to create a configuration for the SearXNG site. If nginx_ is new to
you, the `nginx beginners guide`_ is a good starting point and the `Getting
Started wiki`_ is always a good resource *to keep in the pocket*.
@@ -167,7 +167,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
.. tabs::
- .. group-tab:: searx via filtron plus morty
+ .. group-tab:: SearXNG via filtron plus morty
Use this setup, if your instance is public to the internet, compare
figure: :ref:`architecture <arch public>` and :ref:`installation scripts`.
@@ -292,7 +292,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
Be warned, with these setups, your instance isn't :ref:`protected <searx
filtron>`. The examples are just here to demonstrate how to export the
- searx application from a subdirectory URL ``https://example.org/searx/``.
+ SearXNG application from a subdirectory URL ``https://example.org/searx/``.
.. code:: nginx
@@ -313,7 +313,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
alias /usr/local/searx/searx-src/searx/static/;
}
- The ``X-Script-Name /searx`` is needed by the searx implementation to
+ The ``X-Script-Name /searx`` is needed by the SearXNG implementation to
calculate relative URLs correct. The next example shows a uWSGI
configuration. Since there are no HTTP headers in a (u)WSGI protocol, the
value is shipped via the SCRIPT_NAME_ in the WSGI environment.
@@ -332,7 +332,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*.
alias /usr/local/searx/searx-src/searx/;
}
- For searx to work correctly the ``base_url`` must be set in the
+ For SearXNG to work correctly the ``base_url`` must be set in the
:origin:`searx/settings.yml`.
.. code:: yaml
diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst
index c5e1a05e7..9e9157b86 100644
--- a/docs/admin/installation-searx.rst
+++ b/docs/admin/installation-searx.rst
@@ -36,8 +36,8 @@ Create user
.. _searx-src:
-install searx & dependencies
-============================
+Install SearXNG & dependencies
+==============================
Start a interactive shell from new created user and clone searx:
@@ -51,7 +51,7 @@ In the same shell create *virtualenv*:
:start-after: START create virtualenv
:end-before: END create virtualenv
-To install searx's dependencies, exit the searx *bash* session you opened above
+To install searx's dependencies, exit the SearXNG *bash* session you opened above
and restart a new. Before install, first check if your *virtualenv* was sourced
from the login (*~/.profile*):
@@ -106,8 +106,8 @@ For a *minimal setup*, configure like shown below – replace ``searx@$(uname
Check
=====
-To check your searx setup, optional enable debugging and start the *webapp*.
-Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a
+To check your SearXNG setup, optional enable debugging and start the *webapp*.
+SearXNG looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a
configuration file.
.. kernel-include:: $DOCS_BUILD/includes/searx.rst
@@ -115,6 +115,6 @@ configuration file.
:end-before: END check searx installation
If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the
-debug option in ``settings.yml``. You can now exit searx user bash (enter exit
-command twice). At this point searx is not demonized; uwsgi allows this.
+debug option in ``settings.yml``. You can now exit SearXNG user bash (enter exit
+command twice). At this point SearXNG is not demonized; uwsgi allows this.
diff --git a/docs/admin/installation-uwsgi.rst b/docs/admin/installation-uwsgi.rst
index 7b482975d..e4b35dfc2 100644
--- a/docs/admin/installation-uwsgi.rst
+++ b/docs/admin/installation-uwsgi.rst
@@ -40,7 +40,7 @@ recommend two methods
unit template --> /usr/lib/systemd/system/uwsgi@.service
uwsgi ini files --> /etc/uwsgi/searx.ini
- The searx app can be maintained as know from common systemd units::
+ The SearXNG app can be maintained as know from common systemd units::
systemctl enable uwsgi@searx
systemctl start uwsgi@searx
@@ -57,7 +57,7 @@ The `uWSGI Emperor`_ mode which fits for maintaining a large range of uwsgi apps
instance is started, reload or stopped. Take Fedora and a searx.ini as
example::
- to start a new searx instance create --> /etc/uwsgi.d/searx.ini
+ to start a new SearXNG instance create --> /etc/uwsgi.d/searx.ini
to reload the instance edit timestamp --> touch /etc/uwsgi.d/searx.ini
to stop instance remove ini --> rm /etc/uwsgi.d/searx.ini
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst
index cd6bb62ac..59f142aff 100644
--- a/docs/admin/installation.rst
+++ b/docs/admin/installation.rst
@@ -11,7 +11,7 @@ Installation
- :ref:`installation basic`
The :ref:`installation basic` is good enough for intranet usage and it is a
-excellent illustration of *how a searx instance is build up*. If you place your
+excellent illustration of *how a SearXNG instance is build up*. If you place your
instance public to the internet you should really consider to install a
:ref:`filtron reverse proxy <filtron.sh>` and for privacy a :ref:`result proxy
<morty.sh>` is mandatory.
@@ -51,9 +51,9 @@ the case if you clone into a folder below ``/root``.
- :ref:`update searx`
- :ref:`inspect searx`
-**Install** :ref:`searx service <searx.sh>`
+**Install** :ref:`SearXNG service <searx.sh>`
-This installs searx as described in :ref:`installation basic`.
+This installs SearXNG as described in :ref:`installation basic`.
.. code:: bash
@@ -80,8 +80,8 @@ If all services are running fine, you can add it to your HTTP server:
**Install** :ref:`external plugins <dev plugin>`
-Use searx's ``shell`` to install external plugins. In the example below we
-install the searx plugins from **The Green Web Foundation** `[ref]
+Use SearXNG's ``shell`` to install external plugins. In the example below we
+install the SearXNG plugins from **The Green Web Foundation** `[ref]
<https://www.thegreenwebfoundation.org/news/searching-the-green-web-with-searx/>`__:
.. code:: bash
diff --git a/docs/admin/morty.rst b/docs/admin/morty.rst
index 5468c9c13..d19a91361 100644
--- a/docs/admin/morty.rst
+++ b/docs/admin/morty.rst
@@ -12,7 +12,7 @@ How to setup result proxy
.. _morty: https://github.com/asciimoo/morty
.. _morty's README: https://github.com/asciimoo/morty
-By default searx can only act as an image proxy for result images, but it is
+By default SearXNG can only act as an image proxy for result images, but it is
possible to proxify all the result URLs with an external service, morty_.
To use this feature, morty has to be installed and activated in searx's
@@ -29,7 +29,7 @@ Note that the example above (``http://127.0.0.1:3000``) is only for single-user
instances without a HTTP proxy. If your morty service is public, the url is the
address of the reverse proxy (e.g ``https://example.org/morty``).
-For more information about *result proxy* have a look at *"searx via filtron
+For more information about *result proxy* have a look at *"SearXNG via filtron
plus morty"* in the :ref:`nginx <nginx searx via filtron plus morty>` and
:ref:`apache <apache searx via filtron plus morty>` sections.
diff --git a/docs/admin/update-searx.rst b/docs/admin/update-searx.rst
index a87f27ede..ea58a9954 100644
--- a/docs/admin/update-searx.rst
+++ b/docs/admin/update-searx.rst
@@ -7,7 +7,7 @@ How to update
How to update depends on the :ref:`installation` method. If you have used the
:ref:`installation scripts`, use ``update`` command from the scripts.
-**Update** :ref:`searx service <searx.sh>`
+**Update** :ref:`SearXNG service <searx.sh>`
.. code:: sh
@@ -39,7 +39,7 @@ How to inspect & debug
How to debug depends on the :ref:`installation` method. If you have used the
:ref:`installation scripts`, use ``inspect`` command from the scripts.
-**Inspect** :ref:`searx service <searx.sh>`
+**Inspect** :ref:`SearXNG service <searx.sh>`
.. code:: sh
7apu2bq3rhoylwmucxizk54afw5jyda7pho4j5zdcqpwkufke7zdzwad.onion