Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e5323b8a authored by Léon Tiekötter's avatar Léon Tiekötter Committed by Markus Heiser
Browse files

[docs] corrections from @tiekoetter's review

parent 6fbffe9d
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ SearXNG infrastructures.
uWSGI Setup
===========

We start with a *reference* setup for public SearXNG instances which can build
We start with a *reference* setup for public SearXNG instances which can be build
up and maintained by the scripts from our :ref:`toolboxing`.

.. _arch public:
+9 −9
Original line number Diff line number Diff line
@@ -40,8 +40,8 @@ Apache
    https://httpd.apache.org/docs/current/mod/mod_proxy.html


This section explains how to set up a SearXNG site using the HTTP server Apache_.
If you have used the :ref:`installation scripts` and do not have any preference
This section explains how to set up a SearXNG instance using the HTTP server Apache_.
If you did use the :ref:`installation scripts` and do not have any special preferences
you can install the :ref:`SearXNG site <apache searxng site>` using
:ref:`searxng.sh <searxng.sh overview>`:

@@ -99,8 +99,8 @@ Directives`_ documentation gives first orientation. There is also a list of
         sudo -H systemctl enable httpd
         sudo -H systemctl start httpd

Now at http://localhost you should see any kind of *Welcome* or *Test* page.
How this default intro site is configured, depends on the linux distribution
Now at http://localhost you should see some kind of *Welcome* or *Test* page.
How this default site is configured, depends on the linux distribution
(compare `Apache directives`_).

.. tabs::
@@ -322,11 +322,11 @@ mod_proxy_ module (:ref:`apache modules`).
   With ProxyPreserveHost_ the incoming ``Host`` header is passed to the proxied
   host.

Depending on what your SearXNG installation is listen, you need a http
Depending on what your SearXNG installation is listening on, you need a http
mod_proxy_http_) or socket (mod_proxy_uwsgi_) communication to upstream.

The :ref:`installation scripts` installs by default the :ref:`reference setup
<use_default_settings.yml>` and a :ref:`uwsgi setup` that listens on a socket.
The :ref:`installation scripts` installs the :ref:`reference setup
<use_default_settings.yml>` and a :ref:`uwsgi setup` that listens on a socket by default.
You can install and activate your own ``searxng.conf`` like shown in
:ref:`apache sites`.

@@ -383,6 +383,6 @@ one of the lines and `restart apache`_:
   SetEnvIf Request_URI "/searxng" dontlog
   # CustomLog /dev/null combined env=dontlog

The ``CustomLog`` directive disable logs of the entire (virtual) server, use it
when the URL of the service does not have a path component (``/searxng``), when
The ``CustomLog`` directive disables logs for the entire (virtual) server, use it
when the URL of the service does not have a path component (``/searxng``), so when
SearXNG is located at root (``/``).
+2 −2
Original line number Diff line number Diff line
@@ -51,8 +51,8 @@ of this container:
Get Docker
==========

If you plan to build and maintain a docker image by your own, make sure you have
`Docker installed <https://docs.docker.com/get-docker/>`_ and on Linux, don't
If you plan to build and maintain a docker image by yourself, make sure you have
`Docker installed <https://docs.docker.com/get-docker/>`_. On Linux don't
forget to add your user to the docker group (log out and log back in so that
your group membership is re-evaluated):

+6 −6
Original line number Diff line number Diff line
@@ -19,8 +19,8 @@ NGINX
.. _SCRIPT_NAME:
   https://werkzeug.palletsprojects.com/en/1.0.x/wsgi/#werkzeug.wsgi.get_script_name

This section explains how to set up a SearXNG site using the HTTP server nginx_.
If you have used the :ref:`installation scripts` and do not have any preference
This section explains how to set up a SearXNG instance using the HTTP server nginx_.
If you have used the :ref:`installation scripts` and do not have any special preferences
you can install the :ref:`SearXNG site <nginx searxng site>` using
:ref:`searxng.sh <searxng.sh overview>`:

@@ -78,7 +78,7 @@ If nginx_ is not installed, install it now.

Now at http://localhost you should see a *Welcome to nginx!* page, on Fedora you
see a *Fedora Webserver - Test Page*.  The test page comes from the default
`nginx server configuration`_.  How this default intro site is configured,
`nginx server configuration`_.  How this default site is configured,
depends on the linux distribution:

.. tabs::
@@ -134,7 +134,7 @@ 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*.

Depending on what your SearXNG installation is listen, you need a http or socket
Depending on what your SearXNG installation is listening on, you need a http or socket
communication to upstream.

.. tabs::
@@ -151,8 +151,8 @@ communication to upstream.
         :start-after: START nginx http
         :end-before: END nginx http

The :ref:`installation scripts` installs by default the :ref:`reference setup
<use_default_settings.yml>` and a :ref:`uwsgi setup` that listens on a socket.
The :ref:`installation scripts` installs the :ref:`reference setup
<use_default_settings.yml>` and a :ref:`uwsgi setup` that listens on a socket by default.

.. tabs::

+5 −5
Original line number Diff line number Diff line
@@ -4,12 +4,12 @@
Installation Script
===================

.. sidebar:: Update OS first!
.. sidebar:: Update the OS first!

   To avoid unwanted side effects, update your OS before installing SearXNG.

The following will install a setup as shown in :ref:`the reference architecture
<arch public>`.  First you need to get a clone.  The clone is only needed for
<arch public>`.  First you need to get a clone of the repository.  The clone is only needed for
the installation procedure and some maintenance tasks.

.. sidebar:: further read
@@ -41,9 +41,9 @@ including a :ref:`uWSGI setup <architecture uWSGI>` as described in the

   For the installation procedure, use a *sudoer* login to run the scripts.  If
   you install from ``root``, take into account that the scripts are creating a
   ``searxng`` user.  In the installation procedure this new created user do
   need read access to the clone of searx, which is not the case if you clone
   into a folder below ``/root``!
   ``searxng`` user.  In the installation procedure this new created user does
   need read access to the cloned SearXNG repository, which is not the case if you clone
   it into a folder below ``/root``!

.. sidebar:: further read

Loading