Installation

info

Switch from searx to SearXNG

You’re spoilt for choice, choose your preferred method of installation.

• Docker installation

• Installation scripts

• Step by step installation

The Step by step installation is good enough for intranet usage and it is a excellent illustration of how a SearXNG instance is build up. If you place your instance public to the internet you should really consider to install a filtron reverse proxy and for privacy a result proxy is mandatory.

Therefore, if you do not have any special preferences, its recommend to use the Docker installation or the Installation scripts from our tooling box as described below.

Installation scripts

Update OS first!

To avoid unwanted side effects, update your OS before installing SearXNG.

The following will install a setup as shown in 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.

$ cd ~/Downloads
$ git clone https://github.com/searxng/searxng.git searxng
$ cd searxng

further read

• Admin’s tooling box

• How to update

• How to inspect & debug

Install SearXNG service

This installs SearXNG as described in Step by step installation.

$ sudo -H ./utils/searx.sh install all

Install filtron reverse proxy

$ sudo -H ./utils/filtron.sh install all

Install result proxy

$ sudo -H ./utils/morty.sh install all

If all services are running fine, you can add it to your HTTP server:

Install HTTP

• Install with apache

• Install with nginx

Install external plugins

Use SearXNG’s shell to install external plugins. In the example below we install the SearXNG plugins from The Green Web Foundation [ref]:

$ sudo -H ./utils/searx.sh shell
// exit with [CTRL-D]
(searx-pyenv) searx@ryzen:~$ pip install git+https://github.com/return42/tgwf-searx-plugins

In the settings.yml activate the plugins: section and add module only_show_green_results from tgwf-searx-plugins.

plugins:
  - only_show_green_results

Tip

About script’s installation options have a look at chapter Tooling box setup. How to brand your instance see chapter Global Settings. To stash your instance’s setup, git stash your clone’s git://.config.sh file .