klokantech/search

搜索服务镜像

镜像概述和主要用途

本镜像是一个基于SphinxSearch实现的全文搜索服务，提供JSON API接口，专门用于索引Jekyll网站和博客文章。初始部署于[***]

核心功能和特性

• 基于SphinxSearch：利用SphinxSearch的全文索引能力，提供高效搜索
• JSON API接口：支持标准JSON/JSONP响应，兼容CORS
• TSV数据导入：通过固定格式的TSV文件导入索引数据
• 多域支持：通过环境变量控制允许索引的域名或URL前缀
• 多条件过滤：支持按类型、语言、日期、标签、产品等条件过滤
• 权重排序：标题字段权重提升，优化搜索结果相关性
• 分页功能：支持OpenSearch标准分页参数（count、startIndex）
• 未来内容控制：通过日期过滤自动排除未来时间的内容

使用场景和适用范围

• Jekyll静态网站的全文搜索功能集成
• 多网站/博客的统一搜索服务部署
• 需要按类型、语言、标签等多维度过滤的搜索场景
• 需要区分当前和未来内容的发布管理
• 轻量级、易于部署的搜索服务需求

使用方法和配置说明

环境变量配置

• DOMAINS：必填，定义允许索引的域名或URL前缀列表（逗号分隔）

输入TSV格式

使用tsvpipe解析器，以制表符为分隔符，无引号规则，文本值中不可包含制表符。TSV文件无表头行，固定列顺序及说明如下：

注意：date列为必填项，默认会过滤掉日期晚于当前时间的内容，便于管理未来发布的文章。

更新索引端点

用于触发指定域名的索引更新，服务会自动下载并处理该域名的TSV文件：

POST /update/{domain}

示例：更新kartenportal.ch的索引

POST /update/kartenportal.ch

搜索端点

提供全文搜索功能，支持多条件过滤和分页：

GET /search?domain={domain}&q={q}&type={type}&lang={lang}&date={date}&tags={tags}&count={count}&startIndex={startIndex}

参数说明：

• domain：必填，要搜索的域名
• q：搜索关键词
• type：按内容类型过滤
• lang：按语言过滤
• date：按日期过滤
• tags：按标签过滤（逗号分隔）
• count：每页结果数（分页）
• startIndex：起始索引（分页）

示例：

GET /search?domain=blog.klokantech.com&q=maptiler&type=post&lang=en&tags=gis,map&count=20&startIndex=0

搜索结果格式

返回JSON或JSONP格式响应，包含分页信息和结果列表：

json
{
  "count": 20,
  "nextIndex": 20,
  "startIndex": 0,
  "totalResults": 31,
  "results": [
    {
      "lang": "en",
      "tags": "gis,map",
      "url": "https://blog.klokantech.com/maptiler-intro.html",
      "title": "Introduction to MapTiler",
      "rank": 31548,
      "content": "MapTiler is a powerful tool for...",
      "date": "2016-05-19T11:06:41+02:00",
      "date_filter": 1463648801.0,
      "type": "post",
      "custom_data": "additional info",
      "id": 21
    }
  ]
}

Docker部署示例

基本部署（docker run）

bash
docker run -d \
  -p 80:80 \
  -e DOMAINS="kartenportal.ch,blog.klokantech.com,maptiler.com" \
  --name sphinx-search \
  klokantech/search

docker-compose配置

yaml
version: '3'
services:
  search:
    image: klokantech/search
    ports:
      - "80:80"
    environment:
      - DOMAINS=kartenportal.ch,blog.klokantech.com,maptiler.com
    restart: always

相关链接

• Google Custom Search JSON API
• OpenSearch JSON格式规范