From 8a4db4caa0951794a27908e7595b868593d6798a Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Fri, 25 Feb 2022 23:10:07 +0100 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 6382096..07a2704 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,20 @@ Create a new SearXNG instance in five minutes using Docker | 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) | -| [Filtron](https://github.com/dalf/filtron) | Filtering reverse HTTP proxy, bot and abuse protection | [dalf/filtron:latest](https://hub.docker.com/r/dalf/filtron) | See [asciimoo/filtron#4](https://github.com/asciimoo/filtron/pull/4) | | [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) | -| [Morty](https://github.com/dalf/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) | +| [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) | ## 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) - only on MacOSX: ```brew install coreutils``` to install ```greadlink``` -- Get searxng-docker: +- Get searxng-docker ```sh cd /usr/local git clone https://github.com/searxng/searxng-docker.git cd searxng-docker ``` -- Generate MORTY_KEY ```sed -i "s|ReplaceWithARealKey\!|$(openssl rand -base64 33)|g" .env``` +- Generate the secret key ```sed -i "s|ultrasecretkey|$(openssl rand -hex 32)|g" .env``` - Edit the other settings in [.env](https://github.com/searxng/searxng-docker/blob/master/.env) file according to your need - Check everything is working: ```./start.sh``` - ```cp searxng-docker.service.template searxng-docker.service``` @@ -34,9 +33,9 @@ Create a new SearXNG instance in five minutes using Docker ## Note on the image proxy feature -The SearXNG image proxy is activated by default using [Morty](https://github.com/dalf/morty). +The SearXNG image proxy is activated by default. -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;```. +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;```. 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:;```. @@ -52,17 +51,11 @@ It is possible to use the [extend feature](https://docs.docker.com/compose/exten ## Multi Architecture Docker images -For now only the amd64 platform is supported. +Supported architecture: +- amd64 +- arm64 +- arm/v7 ## How to update ? -Check the content of [```update.sh```](https://github.com/searxng/searxng-docker/blob/master/update.sh). - -## Access to the Filtron API - -The [Filtron API](https://github.com/dalf/filtron#api) is available on ```http://localhost:4041```. - -For example, to display the loaded rules: -``` -curl http://localhost:4041/rules | jq -``` +Check the content of [```update.sh```](https://github.com/searxng/searxng-docker/blob/master/update.sh)