bdf5619765
* Use docker image caddy:2-alpine * Caddyfile: remove "limits 10KB" * Caddyfile: URL /filtron/rules removes (filtron API still availabled on http://localhost:4041/rules ) * caddy storage are docker volumes (caddy-data and caddy-config). start.sh and stop.sh have been modified to keep these volumes. * .env: Remove SEARX_PROTOCOL, SEARX_TLS, FILTRON_USER and FILTRON_PASSWORD variables. * docker-compose.yml: filtron and morty listen on 127.0.0.1 (related to #38) * Fix #37: settings ```SEARX_HOSTNAME=localhost:8888``` works as expected (https connection) |
||
|---|---|---|
| .env | ||
| .gitignore | ||
| Caddyfile | ||
| docker-compose.yaml | ||
| LICENSE | ||
| README.md | ||
| rules.json | ||
| searx-docker.service.template | ||
| start.sh | ||
| stop.sh | ||
| update.sh | ||
| util.sh | ||
searx-docker
Create a new searx instance in five minutes using Docker (see https://github.com/asciimoo/searx/issues/1561 )
What is included ?
| Name | Description | Docker image | Dockerfile |
|---|---|---|---|
| Caddy | Reverse proxy (create a LetsEncrypt certificate automatically) | caddy/caddy:2-alpine | Dockerfile |
| Filtron | Filtering reverse HTTP proxy, bot and abuse protection | dalf/filtron:latest | See asciimoo/filtron#4 |
| Searx | searx by itself | searx/searx:latest | Dockerfile |
| Morty | Privacy aware web content sanitizer proxy as a service. | dalf/morty:latest | Dockerfile |
| Searx-checker | Check which engines return results of the instance. JSON result available at https://{SEARX_HOSTNAME}/statusAutomatically updated every 24h |
searx/searx-checker:latest | Dockerfile |
How to use it
- Install docker
- Install docker-compose (be sure that docker-compose version is at least 1.9.0).
- Get searx-docker
cd /usr/local
git clone https://github.com/searx/searx-docker.git
cd searx-docker
- Edit the .env file according to your need
- Check everything is working:
./start.sh, cp searx-docker.service.template searx-docker.service- edit the content of
WorkingDirectoryin thesearx-docker.servicefile (only if the installation path is different from /usr/local/searx-docker) - Install the systemd unit :
systemctl enable $(pwd)/searx-docker.service
systemctl start searx-docker.service
Note on the image proxy feature
The searx image proxy is activated by default using Morty.
The default Content-Security-Policy allow the browser to access to {SEARX_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 the extend feature of docker-compose :
- stop the service :
systemctl stop searx-docker.service - create a new docker-compose-extend.yaml, check with
start.sh - update searx-docker.service (see SEARX_DOCKERCOMPOSEFILE)
- restart the servie :
systemctl restart searx-docker.service
Multi Architecture Docker images
For now only the amd64 platform is supported.
How to update ?
Check the content of update.sh
Access to the Filtron API
The Filtron API is available on http://localhost:4041
For example, to display the loaded rules:
curl http://localhost:4041/rules | jq