文档
用户指南
Docker 部署

Docker 部署

预构建的 Docker 镜像托管在阿里云容器镜像服务，支持容器化一键部署。

可用镜像

区域镜像
美西modelscope-registry.us-west-1.cr.aliyuncs.com/modelscope-repo/sirchmunk:ubuntu22.04-py312-0.0.4
北京modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/sirchmunk:ubuntu22.04-py312-0.0.4

快速开始

# 拉取镜像（根据地理位置选择最近的 Registry）
docker pull modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/sirchmunk:ubuntu22.04-py312-0.0.4

# 启动服务
docker run -d \
  --name sirchmunk \
  -p 8584:8584 \
  -e LLM_API_KEY="your-api-key-here" \
  -e LLM_BASE_URL="https://api.openai.com/v1" \
  -e LLM_MODEL_NAME="gpt-5.2" \
  -e LLM_TIMEOUT=60.0 \
  -e UI_THEME=light \
  -e UI_LANGUAGE=en \
  -e SIRCHMUNK_VERBOSE=false \
  -v /path/to/your_work_path:/data/sirchmunk \
  -v /path/to/your/docs:/mnt/docs:ro \
  modelscope-registry.cn-beijing.cr.aliyuncs.com/modelscope-repo/sirchmunk:ubuntu22.04-py312-0.0.4

打开 http://localhost:8584 访问 WebUI，或直接调用 API：

import requests

response = requests.post(
    "http://localhost:8584/api/v1/search",
    json={
        "query": "你的搜索问题",
        "paths": ["/mnt/docs"],
    },
)
print(response.json())

卷挂载

挂载用途
-v /path/to/your_work_path:/data/sirchmunk持久化存储知识聚类和聊天历史
-v /path/to/your/docs:/mnt/docs:ro挂载文档目录（只读）

环境变量

变量描述默认值
LLM_API_KEYLLM API 密钥必填
LLM_BASE_URLOpenAI 兼容 API 基础 URLhttps://api.openai.com/v1
LLM_MODEL_NAME模型名称gpt-5.2
LLM_TIMEOUTLLM 请求超时（秒）60.0
UI_THEMEWeb UI 主题（light 或 dark）light
UI_LANGUAGE界面语言（en 或 zh）en
SIRCHMUNK_VERBOSE启用详细日志false
提示

完整 Docker 参数和高级用法，请参阅 Sirchmunk 仓库中的 docker/README.md。

docs