From c3e4753ce951f759844db13d98f9ad5b226f84b6 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 2 Mar 2020 19:00:19 +0100 Subject: docs: generic documentation from the installation scripts Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 85 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 docs/admin/installation-searx.rst (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst new file mode 100644 index 000000000..11018bb3b --- /dev/null +++ b/docs/admin/installation-searx.rst @@ -0,0 +1,85 @@ +.. _installation basic: + +========================= +Step by step installation +========================= + +.. contents:: Contents + :depth: 2 + :local: + :backlinks: entry + +Step by step installation with virtualenv. For Ubuntu, be sure to have enable +universe repository. + +Install packages +================ + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START distro-packages + :end-before: END distro-packages + +.. hint:: + + This installs also the packages needed by :ref:`searx uwsgi` + +Create user +=========== + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START create user + :end-before: END create user + +Start a interactive shell from new created user and clone searx: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START clone searx + :end-before: END clone searx + +In the same shell create *virtualenv*: + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START create virtualenv + :end-before: END create virtualenv + +To install searx's dependencies, exit the searx *bash* session you opened above +and restart a new. Before install, first check if your *virualenv* was sourced +from the login (*~/.profile*): + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START manage.sh update_packages + :end-before: END manage.sh update_packages + +.. tip:: + + Open a second terminal for the configuration tasks and left the ``(searx)$`` + terminal open for the tasks below. + + +Configuration +============== + +Create a copy of the :origin:`searx/settings.yml` configuration file in system's +*/etc* folder. Configure like shown below -- replace ``searx@\$(uname -n)`` with +a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary. + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START searx config + :end-before: END searx config + + +Check +===== + +To check your searx setup, optional enable debugging and start the *webapp*. +Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a +configuration file. + +.. include:: ../../build/docs/includes/searx.rst + :start-after: START check searx installation + :end-before: END check searx installation + +If everything works fine, hit ``[CTRL-C]`` to stop the *webapp* and disable the +debug option in ``settings.yml``. You can now exit searx user bash (enter exit +command twice). At this point searx is not demonized; uwsgi allows this. + -- cgit v1.2.3 From 3cb7daedb7c5c93a98dfefa191c161f31a1347c6 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 3 Mar 2020 19:57:15 +0100 Subject: docs: generic doocumentation for searx-uwsgi Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index 11018bb3b..76449beb6 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -30,6 +30,9 @@ Create user :start-after: START create user :end-before: END create user +install searx & dependencies +============================ + Start a interactive shell from new created user and clone searx: .. include:: ../../build/docs/includes/searx.rst @@ -55,7 +58,6 @@ from the login (*~/.profile*): Open a second terminal for the configuration tasks and left the ``(searx)$`` terminal open for the tasks below. - Configuration ============== @@ -67,7 +69,6 @@ a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary. :start-after: START searx config :end-before: END searx config - Check ===== -- cgit v1.2.3 From 3aff2c19d16619d949dc52216b29ef637d1a44a1 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 4 Mar 2020 12:22:20 +0100 Subject: docs: complement uwsgi documentation for all distros Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index 76449beb6..88562f3e3 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -12,6 +12,8 @@ Step by step installation Step by step installation with virtualenv. For Ubuntu, be sure to have enable universe repository. +.. _install packages: + Install packages ================ -- cgit v1.2.3 From 387c6a77691fec514704bdf178b9ab94ad4abb40 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 6 Mar 2020 14:47:00 +0100 Subject: docs: improve description of uwsgi & ngingx setup Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index 88562f3e3..91891d85c 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -32,6 +32,8 @@ Create user :start-after: START create user :end-before: END create user +.. _searx-src: + install searx & dependencies ============================ -- cgit v1.2.3 From ee39a098acb2386abd5382de5c9476cc4ffe2e03 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 7 Apr 2020 18:31:51 +0200 Subject: apache: normalize installation (docs and script)s over all distros Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index 91891d85c..d5c0063ee 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -25,6 +25,8 @@ Install packages This installs also the packages needed by :ref:`searx uwsgi` +.. _create searx user: + Create user =========== -- cgit v1.2.3 From bfef2c3b65aea8dd3485e0959e068d460577a841 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:52:45 +0200 Subject: [fix] buildprocess of docs in LXC (containers) The $DOCS_BUILD variable (like all BUILD variables) in the lxc environment:: sudo -H ./utils/lxc.sh cmd searx-archlinux make docs is different from running build process in the HOST:: make docs with kernel-include directive we can use the environment variables in the reST documents to address the correct file location of the include. Signed-off-by: Markus Heiser --- docs/admin/installation-searx.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/admin/installation-searx.rst') diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst index d5c0063ee..f1d486021 100644 --- a/docs/admin/installation-searx.rst +++ b/docs/admin/installation-searx.rst @@ -17,7 +17,7 @@ universe repository. Install packages ================ -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START distro-packages :end-before: END distro-packages @@ -30,7 +30,7 @@ Install packages Create user =========== -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START create user :end-before: END create user @@ -41,13 +41,13 @@ install searx & dependencies Start a interactive shell from new created user and clone searx: -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START clone searx :end-before: END clone searx In the same shell create *virtualenv*: -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START create virtualenv :end-before: END create virtualenv @@ -55,7 +55,7 @@ To install searx's dependencies, exit the searx *bash* session you opened above and restart a new. Before install, first check if your *virualenv* was sourced from the login (*~/.profile*): -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START manage.sh update_packages :end-before: END manage.sh update_packages @@ -71,7 +71,7 @@ Create a copy of the :origin:`searx/settings.yml` configuration file in system's */etc* folder. Configure like shown below -- replace ``searx@\$(uname -n)`` with a name of your choice -- *and/or* edit ``/etc/searx/settings.yml`` if necessary. -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searx config :end-before: END searx config @@ -82,7 +82,7 @@ To check your searx setup, optional enable debugging and start the *webapp*. Searx looks at the exported environment ``$SEARX_SETTINGS_PATH`` for a configuration file. -.. include:: ../../build/docs/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START check searx installation :end-before: END check searx installation -- cgit v1.2.3