2021-10-01 07:42:00 +00:00
# searxng-docker
2019-07-02 16:50:19 +00:00
2024-05-13 13:39:28 +00:00
Create a new SearXNG instance in five minutes using Docker
2019-07-02 16:50:19 +00:00
2019-07-09 16:05:05 +00:00
## What is included ?
2019-07-13 08:59:29 +00:00
| Name | Description | Docker image | Dockerfile |
| -- | -- | -- | -- |
2024-05-13 13:39:28 +00:00
| [Caddy ](https://github.com/caddyserver/caddy ) | Reverse proxy (create a LetsEncrypt certificate automatically) | [docker.io/library/caddy:2-alpine ](https://hub.docker.com/_/caddy ) | [Dockerfile ](https://github.com/caddyserver/caddy-docker/blob/master/Dockerfile.tmpl ) |
| [SearXNG ](https://github.com/searxng/searxng ) | SearXNG by itself | [docker.io/searxng/searxng:latest ](https://hub.docker.com/r/searxng/searxng ) | [Dockerfile ](https://github.com/searxng/searxng/blob/master/Dockerfile ) |
| [Valkey ](https://github.com/valkey-io/valkey ) | In-memory database | [cgr.dev/chainguard/valkey:latest ](https://cgr.dev/chainguard/valkey ) | [Valkey-image ](https://github.com/chainguard-images/images/tree/main/images/valkey ) |
2019-07-09 16:05:05 +00:00
2019-07-02 16:50:19 +00:00
## How to use it
2024-05-13 13:39:28 +00:00
2019-07-02 16:50:19 +00:00
- [Install docker ](https://docs.docker.com/install/ )
2022-02-25 22:10:07 +00:00
- Get searxng-docker
2022-02-17 20:00:26 +00:00
```sh
cd /usr/local
git clone https://github.com/searxng/searxng-docker.git
cd searxng-docker
```
2022-03-19 19:16:38 +00:00
- Edit the [.env ](https://github.com/searxng/searxng-docker/blob/master/.env ) file to set the hostname and an email
2024-01-08 21:45:10 +00:00
- Generate the secret key `sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" searxng/settings.yml`
2022-03-19 19:16:38 +00:00
- Edit the [searxng/settings.yml ](https://github.com/searxng/searxng-docker/blob/master/searxng/settings.yml ) file according to your need
2024-01-08 21:45:10 +00:00
- Check everything is working: `docker compose up`
- Run SearXNG in the background: `docker compose up -d`
> [!WARNING]
> If you use an older version of docker desktop (`< 3.6.0`), you may have to install Docker Compose v1.
> Accordingly, you should modify the commands in this documentation to suit Docker Compose v1. For instance, change 'docker compose up' to 'docker-compose up'.
>
> [Install the docker-compose plugin](https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin) (be sure that docker-compose version is at least 1.9.0)
2022-04-20 18:31:26 +00:00
2022-07-12 06:36:14 +00:00
## How to access the logs
2024-05-13 13:39:28 +00:00
2024-01-08 21:45:10 +00:00
To access the logs from all the containers use: `docker compose logs -f` .
2022-07-12 06:36:14 +00:00
To access the logs of one specific container:
2024-05-13 13:39:28 +00:00
2024-01-08 21:45:10 +00:00
- Caddy: `docker compose logs -f caddy`
- SearXNG: `docker compose logs -f searxng`
2024-05-13 13:39:28 +00:00
- Valkey: `docker compose logs -f redis`
2022-07-12 06:36:14 +00:00
2022-04-20 18:31:26 +00:00
### Start SearXNG with systemd
You can skip this step if you don't use systemd.
2021-10-01 07:42:00 +00:00
- ```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)
2022-02-17 20:00:26 +00:00
- Install the systemd unit:
```sh
systemctl enable $(pwd)/searxng-docker.service
systemctl start searxng-docker.service
```
2019-07-02 16:50:19 +00:00
2019-07-13 08:59:29 +00:00
## Note on the image proxy feature
2022-02-25 22:10:07 +00:00
The SearXNG image proxy is activated by default.
2019-07-13 08:59:29 +00:00
2022-02-25 22:10:07 +00:00
The default [Content-Security-Policy ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy ) allow the browser to access to ```${SEARXNG_HOSTNAME}``` and ```https://*.tile.openstreetmap.org;```.
2019-07-13 08:59:29 +00:00
2024-05-13 13:39:28 +00:00
If some users want to disable the image proxy, you have to modify [./Caddyfile ](https://github.com/searxng/searxng-docker/blob/master/Caddyfile ). Replace the ```img-src 'self' data: https://*.tile.openstreetmap.org;``` by ```img-src * data:;```.
2019-07-13 08:59:29 +00:00
## Multi Architecture Docker images
2022-02-25 22:10:07 +00:00
Supported architecture:
2024-05-13 13:39:28 +00:00
2022-02-25 22:10:07 +00:00
- amd64
- arm64
- arm/v7
2022-04-26 12:27:30 +00:00
## How to update ?
To update the SearXNG stack:
2023-09-24 09:38:50 +00:00
```sh
2023-09-24 09:39:54 +00:00
git pull
2023-09-24 09:38:50 +00:00
docker compose pull
docker compose up -d
```
Or the old way (with the old docker-compose version):
2024-05-13 13:39:28 +00:00
2022-04-26 12:27:30 +00:00
```sh
2023-09-24 09:39:54 +00:00
git pull
2022-04-26 12:27:30 +00:00
docker-compose pull
2023-09-24 09:38:50 +00:00
docker-compose up -d
2022-04-26 12:27:30 +00:00
```