Merge pull request #2384 from return42/improve-doc

Improve doc of the installation skripts
This commit is contained in:
Alexandre Flament 2020-12-14 18:22:12 +01:00 committed by GitHub
commit 7865566338
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions

View File

@ -33,6 +33,13 @@ The following will install a setup as shown in :ref:`architecture`. First you
need to get a clone. The clone is only needed for the installation procedure need to get a clone. The clone is only needed for the installation procedure
and some maintenance tasks (alternatively you can create your own fork). and some maintenance tasks (alternatively you can create your own fork).
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
``searx``, a ``filtron`` and a ``morty`` user. In the installation procedure
these new created users do need read access to the clone of searx, which is not
the case if you clone into a folder below ``/root``.
.. code:: bash .. code:: bash
$ cd ~/Downloads $ cd ~/Downloads
@ -64,3 +71,11 @@ If all services are running fine, you can add it to your HTTP server:
- :ref:`installation apache` - :ref:`installation apache`
- :ref:`installation nginx` - :ref:`installation nginx`
.. _git stash: https://git-scm.com/docs/git-stash
.. tip::
About script's installation options have a look at chapter :ref:`toolboxing
setup`. How to brand your instance see chapter :ref:`makefile setup`. To
*stash* your instance's setup, `git stash`_ your clone's :origin:`Makefile`
and :origin:`.config.sh` file .