From c8d2b19c85ab473f67a8450f01eaeab13beaa392 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 13 Dec 2020 15:19:04 +0100 Subject: [PATCH 1/2] [doc] document why to use sudoer to run intsallation scripts related to: - https://gist.github.com/dalf/60450e19b042bd39b9ce470c095d89b3#gistcomment-3263827 - https://github.com/searx/searx/issues/2013#issuecomment-647132313 - https://github.com/searx/searx/issues/2017#issuecomment-647700327 Signed-off-by: Markus Heiser --- docs/admin/installation.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 2e5e4821..ccf24b4d 100644 --- a/docs/admin/installation.rst +++ b/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 From dc94a1d4c0755b2d66ef3094156cb98f8f27591c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 13 Dec 2020 15:20:33 +0100 Subject: [PATCH 2/2] [doc] add a tip about how to brand and stash a searx instance setup BTW: drop a trailing whitespace Signed-off-by: Markus Heiser --- docs/admin/installation.rst | 8 ++++++++ docs/utils/index.rst | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index ccf24b4d..4a301ecf 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -71,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 . diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 3c738787..ada78cef 100644 --- a/docs/utils/index.rst +++ b/docs/utils/index.rst @@ -41,7 +41,7 @@ Scripts to maintain services often dispose of common commands and environments. ` use :: sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install - + .. _toolboxing setup: Tooling box setup