Browse Source

Merge pull request #2384 from return42/improve-doc

Improve doc of the installation skripts
Alexandre Flament 4 years ago
parent
commit
7865566338
2 changed files with 16 additions and 1 deletions
  1. 15 0
      docs/admin/installation.rst
  2. 1 1
      docs/utils/index.rst

+ 15 - 0
docs/admin/installation.rst

@@ -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
 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
 
    $ 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 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 .

+ 1 - 1
docs/utils/index.rst

@@ -41,7 +41,7 @@ Scripts to maintain services often dispose of common commands and environments.
   <lxc-searx.env>` use ::
 
     sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install
- 
+
 .. _toolboxing setup:
 
 Tooling box setup