Deprecation notice

Templates moved to https://github.com/searxng/searxng/tree/master/container
Documentation moved to https://docs.searxng.org/admin/installation-docker.html

.env

@@ -1,7 +0,0 @@
-# By default listen on https://localhost
-# To change this:
-# * uncomment SEARXNG_HOSTNAME, and replace <host> by the SearXNG hostname
-# * uncomment LETSENCRYPT_EMAIL, and replace <email> by your email (require to create a Let's Encrypt certificate)
-
-# SEARXNG_HOSTNAME=<host>
-# LETSENCRYPT_EMAIL=<email>

.github/workflows/security.yml

@@ -1,27 +0,0 @@
-name: "Security checks"
-on:
-  schedule:
-    - cron: "05 06 * * *"
-  workflow_dispatch:
-
-jobs:
-  dockers:
-    name: Trivy ${{ matrix.image }}
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        image: ["searxng/searxng", "dalf/filtron", "dalf/morty"]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
-        with:
-          image-ref: '${{ matrix.image }}:latest'
-          format: 'table'
-          exit-code: '1'
-          ignore-unfixed: false
-          vuln-type: 'os,library'
-          severity: 'UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL'

.gitignore

@@ -1,6 +0,0 @@
-*~
-
-searxng-docker.service
-caddy
-srv
-searxng/uwsgi.ini

Caddyfile

@@ -1,98 +0,0 @@
-{
-  admin off
-}
-
-{$SEARXNG_HOSTNAME} {
-  log {
-        output discard
-  }
-
-  tls {$SEARXNG_TLS}
-
-  @api {
-        path /config
-        path /healthz
-        path /stats/errors
-        path /stats/checker
-  }
-
-  @static {
-        path /static/*
-  }
-
-  @notstatic {
-        not path /static/*
-  }
-
-  @imageproxy {
-        path /image_proxy
-  }
-
-  @notimageproxy {
-        not path /image_proxy
-  }
-
-  header {
-        # Enable HTTP Strict Transport Security (HSTS) to force clients to always connect via HTTPS
-        Strict-Transport-Security "max-age=31536000; includeSubDomains; preload"
-
-        # Enable cross-site filter (XSS) and tell browser to block detected attacks
-        X-XSS-Protection "1; mode=block"
-
-        # Prevent some browsers from MIME-sniffing a response away from the declared Content-Type
-        X-Content-Type-Options "nosniff"
-
-        # Disable some features
-        Permissions-Policy "accelerometer=(),ambient-light-sensor=(),autoplay=(),camera=(),encrypted-media=(),focus-without-user-activation=(),geolocation=(),gyroscope=(),magnetometer=(),microphone=(),midi=(),payment=(),picture-in-picture=(),speaker=(),sync-xhr=(),usb=(),vr=()"
-
-        # Disable some features (legacy)
-        Feature-Policy "accelerometer 'none';ambient-light-sensor 'none'; autoplay 'none';camera 'none';encrypted-media 'none';focus-without-user-activation 'none'; geolocation 'none';gyroscope 'none';magnetometer 'none';microphone 'none';midi 'none';payment 'none';picture-in-picture 'none'; speaker 'none';sync-xhr 'none';usb 'none';vr 'none'"
-
-        # Referer
-        Referrer-Policy "no-referrer"
-
-        # X-Robots-Tag
-        X-Robots-Tag "noindex, noarchive, nofollow"
-
-        # Remove Server header
-        -Server
-  }
-
-  header @api {
-        Access-Control-Allow-Methods "GET, OPTIONS"
-        Access-Control-Allow-Origin  "*"
-  }
-
-  # Cache
-  header @static {
-        # Cache
-        Cache-Control "public, max-age=31536000"
-        defer
-  }
-
-  header @notstatic {
-        # No Cache
-        Cache-Control "no-cache, no-store"
-        Pragma "no-cache"
-  }
-
-  # CSP (see http://content-security-policy.com/ )
-  header @imageproxy {
-        Content-Security-Policy "default-src 'none'; img-src 'self' data:"
-  }
-
-  header @notimageproxy {
-        Content-Security-Policy "upgrade-insecure-requests; default-src 'none'; script-src 'self'; style-src 'self' 'unsafe-inline'; form-action 'self' https://github.com/searxng/searxng/issues/new; font-src 'self'; frame-ancestors 'self'; base-uri 'self'; connect-src 'self' https://overpass-api.de; img-src 'self' data: https://*.tile.openstreetmap.org; frame-src https://www.youtube-nocookie.com https://player.vimeo.com https://www.dailymotion.com https://www.deezer.com https://www.mixcloud.com https://w.soundcloud.com https://embed.spotify.com"
-  }
-
-  # SearXNG
-  handle {
-        encode zstd gzip
-
-        reverse_proxy localhost:8080 {
-               header_up X-Forwarded-Port {http.request.port}
-               header_up X-Forwarded-Proto {http.request.scheme}
-        }
-  }
-
-}

README.md

@@ -1,75 +1,8 @@
-# searxng-docker
+> [!WARNING]  
+> *searxng-docker* repository is superseded.
+> 
+> For [**NEW installations**](https://docs.searxng.org/admin/installation-docker.html#compose-instancing)
+>
+> For [**EXISTING installations**](https://docs.searxng.org/admin/installation-docker.html#migrate-from-searxng-docker)
 
-Create a new SearXNG  instance in five minutes using Docker
-
-## What is included ?
-
-| 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) |
-| [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) |
-| [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)
-- Get searxng-docker
-  ```sh
-  cd /usr/local
-  git clone https://github.com/searxng/searxng-docker.git
-  cd searxng-docker
-  ```
-- 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
-- Check everything is working: ```docker-compose up```
-- Run SearXNG in the background: ```docker-compose up -d```
-
-## 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`
-
-### Start SearXNG with systemd
-
-You can skip this step if you don't use systemd.
-
-- ```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
-  ```
-
-## Note on the image proxy feature
-
-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;```.
-
-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:;```.
-
-## Multi Architecture Docker images
-
-Supported architecture:
-- amd64
-- arm64
-- arm/v7
-
-## 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).
+Continue to [*searxng-docker*](https://github.com/searxng/searxng-docker/tree/0c7875a42942e916ab39b171d69cab7d170ddb60) (deprecated)

docker-compose.yaml

@@ -1,67 +0,0 @@
-version: '3.7'
-
-services:
-
-  caddy:
-    container_name: caddy
-    image: caddy:2-alpine
-    network_mode: host
-    volumes:
-      - ./Caddyfile:/etc/caddy/Caddyfile:ro
-      - caddy-data:/data:rw
-      - caddy-config:/config:rw
-    environment:
-      - SEARXNG_HOSTNAME=${SEARXNG_HOSTNAME:-http://localhost:80}
-      - SEARXNG_TLS=${LETSENCRYPT_EMAIL:-internal}
-    cap_drop:
-      - ALL
-    cap_add:
-      - NET_BIND_SERVICE
-      - DAC_OVERRIDE
-
-  redis:
-    container_name: redis
-    image: "redis:alpine"
-    command: redis-server --save "" --appendonly "no"
-    networks:
-      - searxng
-    tmpfs:
-      - /var/lib/redis
-    cap_drop:
-      - ALL
-    cap_add:
-      - SETGID
-      - SETUID
-      - DAC_OVERRIDE
-
-  searxng:
-    container_name: searxng
-    image: searxng/searxng:latest
-    networks:
-      - searxng
-    ports:
-     - "127.0.0.1:8080:8080"
-    volumes:
-      - ./searxng:/etc/searxng:rw
-    environment:
-      - SEARXNG_BASE_URL=https://${SEARXNG_HOSTNAME:-localhost}/
-    cap_drop:
-      - ALL
-    cap_add:
-      - CHOWN
-      - SETGID
-      - SETUID
-      - DAC_OVERRIDE
-    logging:
-      driver: "json-file"
-      options:
-        max-size: "1m"
-        max-file: "1"
-networks:
-  searxng:
-    ipam:
-      driver: default
-
-volumes:
-  caddy-data:
-  caddy-config:

searxng-docker.service.template

@@ -1,16 +0,0 @@
-[Unit]
-Description=SearXNG service
-Requires=docker.service
-After=docker.service
-
-[Service]
-Restart=on-failure
-
-Environment=SEARXNG_DOCKERCOMPOSEFILE=docker-compose.yaml
-
-WorkingDirectory=/usr/local/searxng-docker
-ExecStart=/usr/local/bin/docker-compose -f ${SEARXNG_DOCKERCOMPOSEFILE} up --remove-orphans
-ExecStop=/usr/local/bin/docker-compose -f ${SEARXNG_DOCKERCOMPOSEFILE} down
-
-[Install]
-WantedBy=multi-user.target

searxng/settings.yml

@@ -1,11 +0,0 @@
-# see https://docs.searxng.org/admin/engines/settings.html#use-default-settings
-use_default_settings: true
-server:
-  # base_url is defined in the SEARXNG_BASE_URL environment variable, see .env and docker-compose.yml
-  secret_key: "ultrasecretkey"  # change this!
-  limiter: true  # can be disabled for a private instance
-  image_proxy: true
-ui:
-  static_use_hash: true
-redis:
-  url: redis://redis:6379/0