rogerdigital/dsh-searxng

基于 SearXNG 的 web_search provider:通过自建实例的 JSON API 实现免费、免密钥的元搜索,附仅绑定回环地址的 docker-compose 示例。

Bundle 已验证 MIT TypeScript v0.1.1
Bundle 已验证

已收录

0

Browser

Bundle 已验证

版本v0.1.1
语言TypeScript
许可证MIT
在 GitHub 查看

预览

功能介绍

基于 SearXNG 的 web_search provider:通过自建实例的 JSON API 实现免费、免密钥的元搜索,附仅绑定回环地址的 docker-compose 示例。

适合

  • 已运行 SearXNG 实例,并希望将其接入 DSH `web_search` 的用户。
  • 重视隐私或成本、偏好无需供应商 API 密钥的自建元搜索团队。
  • 需要通过自有搜索实例配置语言、搜索引擎或分类过滤的部署。

不适合

  • 没有可访问且已启用 JSON 搜索格式的 SearXNG 实例的用户;未设置 `baseURL` 时 provider 不可用。
  • 希望使用托管式免运维搜索服务,而不愿维护自建实例的团队。
  • 同时启用多个搜索 provider 却未明确选择其中一个的配置;此时会产生歧义错误。

README

dsh-searxng

A DeepSeek Harness (dsh) plugin that registers a SearXNG-backed search provider into the web capability seam (ctx.web), giving your agent web_search through a free, self-hosted, key-less metasearch instance — instead of the paid Exa/Perplexity APIs.

Install

dsh plugin add dsh-searxng

(With a named profile: dsh plugin --profile <name> add dsh-searxng.)

Quick start

  1. Run a SearXNG instance with the JSON format enabled. If you installed only the plugin, clone the repository example first:

    git clone --depth 1 https://github.com/rogerdigital/dsh-searxng.git dsh-searxng-example
    docker compose -f dsh-searxng-example/examples/docker/docker-compose.yml up -d
    curl 'http://127.0.0.1:8080/search?q=test&format=json'
    

    From an existing source checkout, you can instead run docker compose up -d in examples/docker. This repository example is loopback-only and pre-configures search.formats with json — the one setting most public instances deliberately disable.

  2. Point the plugin at it. Either set an environment variable before launching dsh:

    export SEARXNG_BASE_URL=http://127.0.0.1:8080
    dsh
    

    …or override the plugin row in your profile’s cordis.patch.yml ($DSH_HOME/profiles/<name>/cordis.patch.yml):

    - id: web-search-searxng
      config:
        baseURL: http://127.0.0.1:8080
        language: zh-CN
    
  3. Ask your agent something that needs the web. If this is the only search provider you have installed, the seam auto-selects it. If you also have Exa/Perplexity installed, select it explicitly with export DSH_WEB_SEARCH_PROVIDER=searxng (or set searchProvider: searxng in the web row’s config).

Until baseURL is set, the provider registers as unavailable — no public instance is assumed, because most disable the JSON format and rate-limit heavily.

Configuration

All keys are optional; all live on the web-search-searxng row’s config.

Key Default Meaning
baseURL $SEARXNG_BASE_URL Base URL of the instance, e.g. http://127.0.0.1:8080. Must be http(s), contain no query or fragment, and have json in search.formats.
language none Locale passed as SearXNG’s language parameter, e.g. zh-CN, en-US.
engines none Comma-separated engine allowlist, e.g. bing,duckduckgo.
categories none Comma-separated category filter, e.g. general,it.
authHeader none Authorization header value, for instances fronted by an API-key gate. Sent verbatim.

The result count is not configurable here: dsh-tool-web owns the bound (searchMaxResults, default 8) and the seam truncates to it.

Troubleshooting

  • HTTP 403 — the instance does not enable the JSON format. Add json to search.formats in its settings.yml (see the repository example), then restart the instance.
  • HTTP 429 — the instance’s rate limiter. For a local instance set limiter: false, or raise its limits.
  • Provider unavailable / never selected — baseURL is not set, is not an absolute http(s) URL, or contains a query or fragment.
  • WEB_PROVIDER_AMBIGUOUS — more than one search provider is installed and available; select one via DSH_WEB_SEARCH_PROVIDER=searxng.

Compatibility

dsh is in developer preview with breaking changes expected. This table tracks tested pairings:

Plugin version @deepseek-ai/dsh-web @deepseek-ai/dsh-launch-environment Notes
0.1.1 >=0.1.0-rc.6 <0.2.0 (tested against 0.1.0-rc.6) >=0.0.1-rc.3 <0.2.0 (tested against 0.0.1-rc.3) First-round hardening
0.1.0 >=0.1.0-rc.1 <0.2.0 >=0.0.1-rc.1 <0.2.0 Initial release

Develop

pnpm install
pnpm test    # vitest
pnpm build   # tsdown → lib/

Integration check against a live instance:

cd examples/docker && docker compose up -d
node -e "import('./lib/index.mjs').then(m => new m.SearxngSearchProvider({ baseURL: 'http://127.0.0.1:8080' }).search({ query: 'deepseek harness' }).then(r => console.log(r.sources.slice(0, 3))))"

License

MIT

常见问题常见问题

在启用了 DSH 的终端中执行已验证命令 dsh plugin --profile default add github:rogerdigital/dsh-searxng。命令会解析公开 package 元数据,并保持插件与本页展示的目录身份一致。