diff options
| author | Alexandre Flament <alex@al-f.net> | 2020-12-14 18:22:12 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-14 18:22:12 +0100 |
| commit | 78655663380d9d67872b419a872dd40d05ef1ed1 (patch) | |
| tree | d80ed686c0d9eac5455e5d8b07adf2b6f73cdd68 /docs | |
| parent | d110624df069a42672186e3d16aa49345a7d5987 (diff) | |
| parent | dc94a1d4c0755b2d66ef3094156cb98f8f27591c (diff) | |
| download | searxng-78655663380d9d67872b419a872dd40d05ef1ed1.tar.gz searxng-78655663380d9d67872b419a872dd40d05ef1ed1.zip | |
Merge pull request #2384 from return42/improve-doc
Improve doc of the installation skripts
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/installation.rst | 15 | ||||
| -rw-r--r-- | docs/utils/index.rst | 2 |
2 files changed, 16 insertions, 1 deletions
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 2e5e4821b..4a301ecf8 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 @@ -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 . diff --git a/docs/utils/index.rst b/docs/utils/index.rst index 3c7387875..ada78cef3 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. <lxc-searx.env>` use :: sudo -H ./utils/lxc.sh cmd -- FORCE_TIMEOUT=0 ./utils/filtron.sh apache install - + .. _toolboxing setup: Tooling box setup |