ponysearch-docker/README.md
Alexandre Flament 8a4db4caa0 Update README.md
2022-02-25 23:12:28 +01:00

3.1 KiB

searxng-docker

Create a new SearXNG instance in five minutes using Docker

What is included ?

Name Description Docker image Dockerfile
Caddy Reverse proxy (create a LetsEncrypt certificate automatically) caddy/caddy:2-alpine Dockerfile
SearXNG SearXNG by itself searxng/searxng:latest Dockerfile
Redis In-memory database redis:alpine Dockerfile-alpine.template

How to use it

  • Install docker
  • Install docker-compose (be sure that docker-compose version is at least 1.9.0)
  • only on MacOSX: brew install coreutils to install greadlink
  • Get searxng-docker
    cd /usr/local
    git clone https://github.com/searxng/searxng-docker.git
    cd searxng-docker
    
  • Generate the secret key sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" .env
  • Edit the other settings in .env file according to your need
  • Check everything is working: ./start.sh
  • cp searxng-docker.service.template searxng-docker.service
  • edit the content of WorkingDirectory in the searxng-docker.service file (only if the installation path is different from /usr/local/searxng-docker)
  • Install the systemd unit:
    systemctl enable $(pwd)/searxng-docker.service
    systemctl start searxng-docker.service
    

Note on the image proxy feature

The SearXNG image proxy is activated by default.

The default Content-Security-Policy allow the browser to access to ${SEARXNG_HOSTNAME} and https://*.tile.openstreetmap.org;.

If some users wants to disable the image proxy, you have to modify ./Caddyfile. Replace the img-src 'self' data: https://*.tile.openstreetmap.org; by img-src * data:;.

Custom docker-compose.yaml

Do not modify docker-compose.yaml otherwise you won't be able to update easily from the git repository.

It is possible to use the extend feature of docker-compose:

  • stop the service: systemctl stop searxng-docker.service
  • create a new docker-compose-extend.yaml, check with start.sh
  • update searxng-docker.service (see SEARXNG_DOCKERCOMPOSEFILE)
  • restart the service: systemctl restart searxng-docker.service

Multi Architecture Docker images

Supported architecture:

  • amd64
  • arm64
  • arm/v7

How to update ?

Check the content of update.sh