Update README.md

This commit is contained in:
Dalf 2019-07-13 10:59:29 +02:00
parent 1b6563ffe0
commit 31639631ef

View file

@ -1,16 +1,18 @@
# searx-docker
Create a new searx instance in five minutes using Docker (
See https://github.com/asciimoo/searx/issues/1561 )
Create a new searx instance in five minutes using Docker (see https://github.com/asciimoo/searx/issues/1561 )
Do not use it for now : this is a work in progress and there is no antibot feature.
This is a work in progress, the bot protection is basic and not battle tested, and later on, may [change](https://github.com/unixfox/antibot-proxy).
## What is included ?
- [Caddy](https://github.com/abiosoft/caddy-docker) as a reverse proxy (create a LetsEncrypt certificate automaticaly)
- [filtron](https://github.com/asciimoo/filtron): See [#4](https://github.com/asciimoo/filtron/pull/4) to build the docker image.
- [searx](https://github.com/asciimoo/searx): See [#1629](https://github.com/asciimoo/searx/pull/1629) to build the docker image.
- [morty](https://github.com/asciimoo/morty): clone the project, then "make build" to create the docker image
| Name | Description | Docker image | Dockerfile |
| -- | -- | -- | -- |
| [Caddy](https://github.com/caddyserver/caddy) | Reverse proxy (create a LetsEncrypt certificate automatically) | [abiosoft/caddy:1.0.1-no-stats](https://hub.docker.com/r/abiosoft/caddy) | [Dockerfile](https://github.com/abiosoft/caddy-docker/blob/master/Dockerfile-no-stats) |
| [Filtron](https://github.com/asciimoo/filtron) | Filtering reverse HTTP proxy, bot and abuse protection | [dalf/filtron:latest](https://hub.docker.com/r/dalf/filtron) | See [#4](https://github.com/asciimoo/filtron/pull/4) |
| [Searx](https://github.com/asciimoo/searx) | searx by itself | [dalf/searx:latest](https://hub.docker.com/r/dalf/searx) | See [#1629](https://github.com/asciimoo/searx/pull/1629) |
| [Morty](https://github.com/asciimoo/morty) | Privacy aware web content sanitizer proxy as a service. | [dalf/morty:latest](https://hub.docker.com/r/dalf/morty) | [Dockerfile](https://github.com/dalf/morty/blob/master/Dockerfile) |
| [Searx-checker](https://github.com/searx/searx-checker) | Check which engines return results of the instance.<br>JSON result available at<br>```https://{SEARX_HOSTNAME}/status```<br>Automatically updated every 24h | [searx/searx-checker:latest](https://hub.docker.com/r/searx/searx-checker) | [Dockerfile](https://github.com/searx/searx-checker/blob/master/Dockerfile) |
## How to use it
- [Install docker](https://docs.docker.com/install/)
@ -31,6 +33,14 @@ 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](https://github.com/asciimoo/morty).
The default [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/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](https://github.com/searx/searx-docker/blob/master/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.
@ -41,6 +51,11 @@ It is possible to the [extend feature](https://docs.docker.com/compose/extends/)
- 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```
Check the content of [```update.sh```](https://github.com/searx/searx-docker/blob/master/update.sh)