diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2021-11-18 18:27:26 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2021-11-18 18:27:26 +0100 |
| commit | 1dae0c0be09d5c9e287bdea6aa5bf7ec4f4782ec (patch) | |
| tree | 979a544e2853918f8a887480abe940e6880ae84c /docs/admin/installation-searx.rst | |
| parent | 27bb55ab0729fe0531440362f6aa5eb1142e42fb (diff) | |
[brand] SearXNG - docs rename links and fix documentation
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin/installation-searx.rst')
| -rw-r--r-- | docs/admin/installation-searx.rst | 120 |
1 files changed, 0 insertions, 120 deletions
diff --git a/docs/admin/installation-searx.rst b/docs/admin/installation-searx.rst deleted file mode 100644 index 3aa655e85..000000000 --- a/docs/admin/installation-searx.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _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: - -Install packages -================ - -.. kernel-include:: $DOCS_BUILD/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 searx user: - -Create user -=========== - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START create user - :end-before: END create user - -.. _searx-src: - -Install SearXNG & dependencies -============================== - -Start a interactive shell from new created user and clone searx: - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START clone searx - :end-before: END clone searx - -In the same shell create *virtualenv*: - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START create virtualenv - :end-before: END create virtualenv - -To install searx's dependencies, exit the SearXNG *bash* session you opened above -and restart a new. Before install, first check if your *virtualenv* was sourced -from the login (*~/.profile*): - -.. kernel-include:: $DOCS_BUILD/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 leave the ``(searx)$`` - terminal open for the tasks below. - - -.. _use_default_settings.yml: - -Configuration -============= - -.. sidebar:: ``use_default_settings: True`` - - - :ref:`settings global` - - :ref:`settings location` - - :ref:`settings use_default_settings` - - :origin:`/etc/searxng/settings.yml <utils/templates/etc/searxng/settings.yml>` - -To create a initial ``/etc/searxng/settings.yml`` you can start with a copy of -the file :origin:`utils/templates/etc/searxng/settings.yml`. This setup -:ref:`use default settings <settings use_default_settings>` from -:origin:`searx/settings.yml`. - -For a *minimal setup*, configure like shown below – replace ``searx@$(uname --n)`` with a name of your choice, set ``ultrasecretkey`` -- *and/or* edit -``/etc/searxng/settings.yml`` to your needs. - -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searx config - :end-before: END searx config - -.. tabs:: - - .. group-tab:: Use default settings - - .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml - :language: yaml - - .. group-tab:: searx/settings.yml - - .. literalinclude:: ../../searx/settings.yml - :language: yaml - - -Check -===== - -To check your SearXNG setup, optional enable debugging and start the *webapp*. -SearXNG looks at the exported environment ``$SEARXNG_SETTINGS_PATH`` for a -configuration file. - -.. kernel-include:: $DOCS_BUILD/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 SearXNG user bash (enter exit -command twice). At this point SearXNG is not demonized; uwsgi allows this. - |