ponysearch-docker/README.md

76 lines
3.2 KiB
Markdown
Raw Normal View History

2021-10-01 09:42:00 +02:00
# searxng-docker
2019-07-02 18:50:19 +02:00
2021-10-01 09:42:00 +02:00
Create a new SearXNG instance in five minutes using Docker
2019-07-02 18:50:19 +02:00
## What is included ?
2019-07-13 10:59:29 +02:00
| Name | Description | Docker image | Dockerfile |
| -- | -- | -- | -- |
| [Caddy](https://github.com/caddyserver/caddy) | Reverse proxy (create a LetsEncrypt certificate automatically) | [caddy/caddy:2-alpine](https://hub.docker.com/_/caddy) | [Dockerfile](https://github.com/caddyserver/caddy-docker) |
2021-10-01 09:42:00 +02:00
| [SearXNG](https://github.com/searxng/searxng) | SearXNG by itself | [searxng/searxng:latest](https://hub.docker.com/r/searxng/searxng) | [Dockerfile](https://github.com/searxng/searxng/blob/master/Dockerfile) |
2022-02-25 23:10:07 +01:00
| [Redis](https://github.com/redis/redis) | In-memory database | [redis:alpine](https://hub.docker.com/_/redis) | [Dockerfile-alpine.template](https://github.com/docker-library/redis/blob/master/Dockerfile-alpine.template) |
2019-07-02 18:50:19 +02:00
## How to use it
- [Install docker](https://docs.docker.com/install/)
- [Install docker-compose](https://docs.docker.com/compose/install/) (be sure that docker-compose version is at least 1.9.0)
2022-02-25 23:10:07 +01:00
- Get searxng-docker
```sh
cd /usr/local
git clone https://github.com/searxng/searxng-docker.git
cd searxng-docker
```
2022-03-19 20:16:38 +01:00
- Edit the [.env](https://github.com/searxng/searxng-docker/blob/master/.env) file to set the hostname and an email
- Generate the secret key ```sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" searxng/settings.yml```
- Edit the [searxng/settings.yml](https://github.com/searxng/searxng-docker/blob/master/searxng/settings.yml) file according to your need
2022-04-20 20:31:26 +02:00
- Check everything is working: ```docker-compose up```
2022-04-26 14:27:30 +02:00
- Run SearXNG in the background: ```docker-compose up -d```
2022-04-20 20:31:26 +02:00
## How to access the logs
To access the logs from all the containers use: `docker-compose logs -f`.
To access the logs of one specific container:
- Caddy: `docker-compose logs -f caddy`
- SearXNG: `docker-compose logs -f searxng`
- Redis: `docker-compose logs -f redis`
2022-04-20 20:31:26 +02:00
### Start SearXNG with systemd
You can skip this step if you don't use systemd.
2021-10-01 09:42:00 +02: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)
- Install the systemd unit:
```sh
systemctl enable $(pwd)/searxng-docker.service
systemctl start searxng-docker.service
```
2019-07-02 18:50:19 +02:00
2019-07-13 10:59:29 +02:00
## Note on the image proxy feature
2022-02-25 23:10:07 +01:00
The SearXNG image proxy is activated by default.
2019-07-13 10:59:29 +02:00
2022-02-25 23:10:07 +01: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 10:59:29 +02:00
If some users wants 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 10:59:29 +02:00
## Multi Architecture Docker images
2022-02-25 23:10:07 +01:00
Supported architecture:
- amd64
- arm64
- arm/v7
2022-04-26 14:27:30 +02:00
## How to update ?
To update the SearXNG stack:
```sh
docker-compose pull
docker-compose down
docker-compose up
```
To update this `docker-compose.yml` file:
Check out the newest version on github: [searxng/searxng-docker](https://github.com/searxng/searxng-docker).