diff options
Diffstat (limited to 'docs/admin/installation-searxng.rst')
| -rw-r--r-- | docs/admin/installation-searxng.rst | 58 |
1 files changed, 35 insertions, 23 deletions
diff --git a/docs/admin/installation-searxng.rst b/docs/admin/installation-searxng.rst index b14139310..db760bc39 100644 --- a/docs/admin/installation-searxng.rst +++ b/docs/admin/installation-searxng.rst @@ -9,15 +9,16 @@ Step by step installation :local: :backlinks: entry -Step by step installation with virtualenv. For Ubuntu, be sure to have enable -universe repository. + +In this section we show the setup of a SearXNG instance that will be installed +by the :ref:`installation scripts`. .. _install packages: Install packages ================ -.. kernel-include:: $DOCS_BUILD/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START distro-packages :end-before: END distro-packages @@ -30,24 +31,24 @@ Install packages Create user =========== -.. kernel-include:: $DOCS_BUILD/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START create user :end-before: END create user -.. _searx-src: +.. _searxng-src: Install SearXNG & dependencies ============================== -Start a interactive shell from new created user and clone searx: +Start a interactive shell from new created user and clone SearXNG: -.. kernel-include:: $DOCS_BUILD/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START clone searxng :end-before: END clone searxng In the same shell create *virtualenv*: -.. kernel-include:: $DOCS_BUILD/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START create virtualenv :end-before: END create virtualenv @@ -55,7 +56,7 @@ To install searx's dependencies, exit the SearXNG *bash* session you opened abov and restart a new. Before install, first check if your *virtualenv* was sourced from the login (*~/.profile*): -.. kernel-include:: $DOCS_BUILD/includes/searx.rst +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START manage.sh update_packages :end-before: END manage.sh update_packages @@ -77,30 +78,41 @@ Configuration - :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 +To create a initial ``/etc/searxng/settings.yml`` we recommend to 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`. +:origin:`searx/settings.yml` and is shown in the tab *"Use default settings"* +below. This setup: -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. +- enables :ref:`limiter <limiter>` to protect against bots +- enables :ref:`image proxy <image_proxy>` for better privacy +- enables :ref:`cache busting <static_use_hash>` to save bandwith -.. kernel-include:: $DOCS_BUILD/includes/searx.rst - :start-after: START searxng config - :end-before: END searxng config +Modify the ``/etc/searxng/settings.yml`` to your needs: .. tabs:: .. group-tab:: Use default settings - .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml - :language: yaml + .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml + :language: yaml + :end-before: # hostname_replace: + + To see the entire file jump to :origin:`utils/templates/etc/searxng/settings.yml` .. group-tab:: searx/settings.yml - .. literalinclude:: ../../searx/settings.yml - :language: yaml + .. literalinclude:: ../../searx/settings.yml + :language: yaml + :end-before: # hostname_replace: + + To see the entire file jump to :origin:`searx/settings.yml` + +For a *minimal setup* you need to set ``server:secret_key``. + +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst + :start-after: START searxng config + :end-before: END searxng config Check @@ -110,7 +122,7 @@ 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 +.. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START check searxng installation :end-before: END check searxng installation |