From 1110615300b08aa6b2230d07f86741826e51302a Mon Sep 17 00:00:00 2001 From: wizardchen Date: Sun, 10 May 2026 22:01:28 +0800 Subject: [PATCH] feat(web-search): add SearXNG provider (#1166) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 支持对接自建/公共 SearXNG 实例作为网络搜索引擎,缓解免费搜索引擎在国内 网络环境下访问受限的问题。 - types: 新增 WebSearchProviderTypeSearxng 与 BaseURL 参数字段; 类型元数据新增 RequiresBaseURL,前端可动态渲染 Instance URL 表单。 - infrastructure/web_search/searxng.go: 调用 /search?format=json,强制 utils.ValidateURLForSSRF 校验 base_url,可选 api_key 透传给反代鉴权。 - service: isValidProviderType 与参数校验接入 searxng。 - container: 注册 NewSearxngProvider 工厂。 - frontend: WebSearchSettings 表单根据 requires_base_url 渲染 Instance URL 输入框;编辑回填、free 判定同步更新。 - docker: 新增可选 searxng 服务(profile=searxng/full),附带最小化 settings.yml(启用 JSON 格式、关闭 limiter、关闭遥测), docker-compose 默认 SSRF_WHITELIST 包含 searxng 容器名。 - .env.example: 补充 SEARXNG_PORT / SEARXNG_SECRET 说明。 Closes #1166 --- .env.example | 7 + docker-compose.dev.yml | 24 +++ docker-compose.yml | 26 ++- docker/searxng/settings.yml | 49 ++++++ frontend/src/api/web-search-provider.ts | 4 +- .../src/views/settings/WebSearchSettings.vue | 13 +- .../service/web_search_provider.go | 10 +- internal/container/container.go | 1 + internal/infrastructure/web_search/searxng.go | 152 ++++++++++++++++++ internal/types/web_search_provider.go | 15 ++ 10 files changed, 295 insertions(+), 6 deletions(-) create mode 100644 docker/searxng/settings.yml create mode 100644 internal/infrastructure/web_search/searxng.go diff --git a/.env.example b/.env.example index 70b3a70c..6dfeed5b 100644 --- a/.env.example +++ b/.env.example @@ -203,6 +203,13 @@ SYSTEM_AES_KEY=weknora-system-aes-key-32bytes!! # 列入者会在 URL 校验等地方绕过常规 SSRF 规则,生产环境请谨慎配置。 # SSRF_WHITELIST=internal.service,*.corp.example,172.16.0.0/12,2001:db8::1,fd00::/8 +# ===== SearXNG(可选自建网络搜索)===== +# 启用:docker compose --profile searxng up -d +# 默认对外端口 8888,容器内主机名 searxng:8080;后端通过 docker network 直接访问。 +# WeKnora 控制台中 Provider 类型选 "SearXNG",Instance URL 填 http://searxng:8080 即可。 +# SEARXNG_PORT=8888 +# SEARXNG_SECRET=please-change-me-to-a-long-random-string # openssl rand -hex 32 + # 是否开启知识图谱构建和检索(构建阶段需调用大模型,耗时较长) ENABLE_GRAPH_RAG=false diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index 5971b7bc..8b210d14 100644 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -35,6 +35,30 @@ services: networks: - WeKnora-network-dev + searxng: + image: searxng/searxng:latest + container_name: WeKnora-searxng-dev + ports: + - "${SEARXNG_PORT:-8888}:8080" + volumes: + - ./docker/searxng/settings.yml:/etc/searxng/settings.yml:rw + environment: + - SEARXNG_BASE_URL=http://localhost:${SEARXNG_PORT:-8888}/ + - INSTANCE_NAME=weknora-searxng-dev + - SEARXNG_SECRET=${SEARXNG_SECRET:-please-change-me-to-a-long-random-string} + cap_drop: + - ALL + cap_add: + - CHOWN + - SETGID + - SETUID + restart: unless-stopped + networks: + - WeKnora-network-dev + profiles: + - searxng + - full + minio: image: minio/minio:latest container_name: WeKnora-minio-dev diff --git a/docker-compose.yml b/docker-compose.yml index 071d6dc5..6627a9af 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -134,7 +134,7 @@ services: - NEO4J_PASSWORD=${NEO4J_PASSWORD:-password} - TENANT_AES_KEY=${TENANT_AES_KEY:-} - SYSTEM_AES_KEY=${SYSTEM_AES_KEY:-} - - SSRF_WHITELIST=${SSRF_WHITELIST:-} + - SSRF_WHITELIST=${SSRF_WHITELIST:-searxng} - CONCURRENCY_POOL_SIZE=${CONCURRENCY_POOL_SIZE:-5} - JWT_SECRET=${JWT_SECRET:-} # Crypto: 主密钥和盐值,用于 AppSecret 等敏感字段的 AES-256 加密 @@ -238,6 +238,30 @@ services: networks: - WeKnora-network + searxng: + image: searxng/searxng:latest + container_name: WeKnora-searxng + ports: + - "${SEARXNG_PORT:-8888}:8080" + volumes: + - ./docker/searxng/settings.yml:/etc/searxng/settings.yml:rw + environment: + - SEARXNG_BASE_URL=http://localhost:${SEARXNG_PORT:-8888}/ + - INSTANCE_NAME=weknora-searxng + - SEARXNG_SECRET=${SEARXNG_SECRET:-please-change-me-to-a-long-random-string} + cap_drop: + - ALL + cap_add: + - CHOWN + - SETGID + - SETUID + restart: unless-stopped + networks: + - WeKnora-network + profiles: + - searxng + - full + minio: image: minio/minio:RELEASE.2025-09-07T16-13-09Z container_name: WeKnora-minio diff --git a/docker/searxng/settings.yml b/docker/searxng/settings.yml new file mode 100644 index 00000000..3fd561c9 --- /dev/null +++ b/docker/searxng/settings.yml @@ -0,0 +1,49 @@ +use_default_settings: true + +general: + instance_name: "WeKnora SearXNG" + privacypolicy_url: false + donation_url: false + contact_url: false + enable_metrics: false + +server: + # Override via env SEARXNG_SECRET; the entrypoint script substitutes ultrasecretkey. + secret_key: "ultrasecretkey" + base_url: false + image_proxy: true + http_protocol_version: "1.0" + method: "GET" + # Disabled so WeKnora's backend can call /search without IP-based throttling. + # Re-enable and add WeKnora's egress IP to a limiter allowlist if you expose + # this instance to the public internet. + limiter: false + public_instance: false + +ui: + static_use_hash: true + default_locale: "" + query_in_title: false + infinite_scroll: false + center_alignment: false + theme_args: + simple_style: auto + search_on_category_select: true + hotkeys: default + +search: + safe_search: 0 + autocomplete: "" + default_lang: "auto" + ban_time_on_fail: 5 + max_ban_time_on_fail: 120 + formats: + - html + - json + +outgoing: + request_timeout: 6.0 + max_request_timeout: 10.0 + pool_connections: 100 + pool_maxsize: 20 + enable_http2: true diff --git a/frontend/src/api/web-search-provider.ts b/frontend/src/api/web-search-provider.ts index e315ce78..1a978d9b 100644 --- a/frontend/src/api/web-search-provider.ts +++ b/frontend/src/api/web-search-provider.ts @@ -5,11 +5,12 @@ export interface WebSearchProviderEntity { id?: string tenant_id?: number name: string - provider: 'bing' | 'google' | 'duckduckgo' | 'tavily' | 'ollama' | 'baidu' + provider: 'bing' | 'google' | 'duckduckgo' | 'tavily' | 'ollama' | 'baidu' | 'searxng' description?: string parameters: { api_key?: string engine_id?: string + base_url?: string proxy_url?: string extra_config?: Record } @@ -24,6 +25,7 @@ export interface WebSearchProviderTypeInfo { name: string requires_api_key: boolean requires_engine_id?: boolean + requires_base_url?: boolean supports_proxy?: boolean description?: string docs_url?: string diff --git a/frontend/src/views/settings/WebSearchSettings.vue b/frontend/src/views/settings/WebSearchSettings.vue index 9c6017f3..efb90c6c 100644 --- a/frontend/src/views/settings/WebSearchSettings.vue +++ b/frontend/src/views/settings/WebSearchSettings.vue @@ -82,7 +82,7 @@ -