docs(docker): add docker.md (#227)

Author: sjzar

.goreleaser.yaml

@@ -96,6 +96,8 @@ dockers:
       - "ghcr.io/sjzar/chatlog:{{ .Tag }}-amd64"
       - "sjzar/chatlog:{{ .Tag }}-amd64"
     dockerfile: Dockerfile
+    extra_files:
+      - script/docker-entrypoint.sh
     use: buildx
     goos: linux
     goarch: amd64
@@ -114,6 +116,8 @@ dockers:
       - "ghcr.io/sjzar/chatlog:{{ .Tag }}-arm64"
       - "sjzar/chatlog:{{ .Tag }}-arm64"
     dockerfile: Dockerfile
+    extra_files:
+      - script/docker-entrypoint.sh
     use: buildx
     goos: linux
     goarch: arm64

Dockerfile

@@ -4,22 +4,31 @@ LABEL maintainer="Sarv <https://github.com/sjzar>"
 
 ARG DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends ca-certificates tzdata curl && \
-    rm -rf /var/lib/apt/lists/*
+ENV PUID=1000 PGID=1000
+ENV GOSU_VERSION=1.17
+RUN set -eux; \
+    apt-get update; \
+    apt-get install -y --no-install-recommends ca-certificates tzdata curl wget; \
+    wget -O /usr/local/bin/gosu "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$(dpkg --print-architecture)"; \
+	chmod +x /usr/local/bin/gosu; \
+	gosu --version; \
+    groupadd -r -g ${PGID} chatlog; \
+    useradd -r -u ${PUID} -g chatlog -m -d /home/chatlog chatlog; \
+    mkdir -p /app/data /app/work; \
+    apt-get purge -y --auto-remove wget; \
+	rm -rf /var/lib/apt/lists/*
 
-RUN groupadd -r -g 1001 chatlog && \
-    useradd -r -u 1001 -g chatlog -m -d /home/chatlog chatlog && \
-    mkdir -p /app/data /app/work && \
-    chown -R chatlog:chatlog /app
+WORKDIR /app
 
-USER chatlog
+COPY script/docker-entrypoint.sh /usr/local/bin/entrypoint.sh
 
-WORKDIR /app
+COPY --from=mwader/static-ffmpeg:7.1.1 /ffmpeg /usr/local/bin/
 
-COPY --from=mwader/static-ffmpeg:7.1.1 --chown=chatlog:chatlog /ffmpeg /usr/local/bin/
+COPY chatlog /usr/local/bin/chatlog
 
-COPY --chown=chatlog:chatlog chatlog /usr/local/bin/chatlog
+RUN chmod +x /usr/local/bin/entrypoint.sh \
+             /usr/local/bin/ffmpeg \
+             /usr/local/bin/chatlog
 
 EXPOSE 5030
 
@@ -31,4 +40,6 @@ ENV CHATLOG_DATA_DIR=/app/data \
 HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
     CMD curl -f http://localhost:5030/health || exit 1
 
+ENTRYPOINT ["entrypoint.sh"]
+
 CMD ["chatlog", "server"]

README.md

@@ -1,38 +1,31 @@
 <div align="center">
 
-# Chatlog
-
-![chatlog](https://socialify.git.ci/sjzar/chatlog/image?font=Rokkitt&forks=1&issues=1&name=1&pattern=Diagonal+Stripes&stargazers=1&theme=Auto)
+![chatlog](https://github.com/user-attachments/assets/e085d3a2-e009-4463-b2fd-8bd7df2b50c3)
 
 _聊天记录工具，帮助大家轻松使用自己的聊天数据_
 
+[![ImgMCP](https://cdn.imgmcp.com/imgmcp-logo-small.png)](https://imgmcp.com)
+
 [![Go Report Card](https://goreportcard.com/badge/github.com/sjzar/chatlog)](https://goreportcard.com/report/github.com/sjzar/chatlog)
 [![GoDoc](https://godoc.org/github.com/sjzar/chatlog?status.svg)](https://godoc.org/github.com/sjzar/chatlog)
 [![GitHub release](https://img.shields.io/github/release/sjzar/chatlog.svg)](https://github.com/sjzar/chatlog/releases)
 [![GitHub license](https://img.shields.io/github/license/sjzar/chatlog.svg)](https://github.com/sjzar/chatlog/blob/main/LICENSE)
 
-</div>
 
-![chatlog](https://github.com/user-attachments/assets/e085d3a2-e009-4463-b2fd-8bd7df2b50c3)
+</div>
 
 ## Feature
 
-- 从本地数据库文件获取聊天数据
-- 支持 Windows / macOS 系统
-- 支持微信 3.x / 4.0 版本
-- 提供 Terminal UI 界面 & 命令行工具
-- 提供 HTTP API 服务，支持查询聊天记录、联系人、群聊、最近会话等信息
-- 支持 MCP SSE 协议，可与支持 MCP 的 AI 助手无缝集成
-- 支持多媒体消息，支持解密图片、语音
-- 支持自动解密数据，简化使用流程
+- 从本地数据库文件中获取聊天数据
+- 支持 Windows / macOS 系统，兼容微信 3.x / 4.x 版本
+- 支持获取数据与图片密钥 (Windows < 4.0.3.36 / macOS < 4.0.3.80)
+- 支持图片、语音等多媒体数据解密，支持 wxgf 格式解析
+- 支持自动解密数据库，并提供新消息 Webhook 回调
+- 提供 Terminal UI 界面，同时支持命令行工具和 Docker 镜像部署
+- 提供 HTTP API 服务，可轻松查询聊天记录、联系人、群聊、最近会话等信息
+- 支持 MCP Streamable HTTP 协议，可与 AI 助手无缝集成
 - 支持多账号管理，可在不同账号间切换
 
-
-## TODO
-
-- 聊天数据全文索引
-- 聊天数据统计 & Dashboard
-
 ## Quick Start
 
 ### 基本步骤
@@ -43,13 +36,14 @@ _聊天记录工具，帮助大家轻松使用自己的聊天数据_
 4. **开启 HTTP 服务**：选择 `开启 HTTP 服务` 菜单项
 5. **访问数据**：通过 [HTTP API](#http-api) 或 [MCP 集成](#mcp-集成) 访问聊天记录
 
-> 💡 **提示**：如果电脑端微信聊天记录不全，可以[从手机端迁移数据](#从手机迁移聊天记录)
+> 💡 **提示**: 如果电脑端微信聊天记录不全，可以[从手机端迁移数据](#从手机迁移聊天记录)  
 
 ### 常见问题快速解决
 
 - **macOS 用户**：获取密钥前需[临时关闭 SIP](#macos-版本说明)
 - **Windows 用户**：遇到界面显示问题请[使用 Windows Terminal](#windows-版本说明)
 - **集成 AI 助手**：查看 [MCP 集成指南](#mcp-集成)
+- **无法获取密钥**：查看 [FAQ](https://github.com/sjzar/chatlog/issues/197)
 
 ## 安装指南
 
@@ -59,6 +53,8 @@ _聊天记录工具，帮助大家轻松使用自己的聊天数据_
 go install github.com/sjzar/chatlog@latest
 ```
 
+> 💡 **提示**: 部分功能有 cgo 依赖，编译前需确认本地有 C 编译环境。
+
 ### 下载预编译版本
 
 访问 [Releases](https://github.com/sjzar/chatlog/releases) 页面下载适合您系统的预编译版本。
@@ -94,6 +90,49 @@ chatlog decrypt
 chatlog server
 ```
 
+### Docker 部署
+
+由于 Docker 部署时，程序运行环境与宿主机隔离，所以不支持获取密钥等操作，需要提前获取密钥数据。
+
+一般用于 NAS 等设备部署，详细指南可参考 [Docker 部署指南](docs/docker.md)
+
+**0. 获取密钥信息**
+
+```shell
+# 从本机运行 chatlog 获取密钥信息
+$ chatlog key
+Data Key: [c0163e***ac3dc6]
+Image Key: [38636***653361]
+```
+
+**1. 拉取镜像**
+
+chatlog 提供了两个镜像源：
+
+**Docker Hub**:
+```shell
+docker pull sjzar/chatlog:latest
+```
+
+**GitHub Container Registry (ghcr)**:
+```shell
+docker pull ghcr.io/sjzar/chatlog:latest
+```
+
+> 💡 **镜像地址**: 
+> - Docker Hub: https://hub.docker.com/r/sjzar/chatlog
+> - GitHub Container Registry: https://ghcr.io/sjzar/chatlog
+
+**2. 运行容器**
+
+```shell
+$ docker run -d \
+  --name chatlog \
+  -p 5030:5030 \
+  -v /path/to/your/wechat/data:/app/data \
+  sjzar/chatlog:latest
+```
+
 ### 从手机迁移聊天记录
 
 如果电脑端微信聊天记录不全，可以从手机端迁移数据：
@@ -173,23 +212,101 @@ GET /api/v1/chatlog?time=2023-01-01&talker=wxid_xxx
 当请求语音内容时，将直接返回语音内容，并对原始 SILK 语音做了实时转码 MP3 处理。  
 多媒体内容 URL 地址为基于`数据目录`的相对地址，请求多媒体内容将直接返回对应文件，并针对加密图片做了实时解密处理。
 
+## Webhook
+
+需开启自动解密功能，当收到特定新消息时，可以通过 HTTP POST 请求将消息推送到指定的 URL。
+
+#### 0. 回调配置
+
+使用 TUI 模式的话，在 `$HOME/.chatlog/chatlog.json` 配置文件中，新增 `webhook` 配置。  
+（Windows 用户的配置文件在 `%USERPROFILE%/.chatlog/chatlog.json`)
+
+```json
+{
+  "history": [],
+  "last_account": "wxuser_x",
+  "webhook": {
+    "host": "localhost:5030",                   # 消息中的图片、文件等 URL host
+    "items": [
+      {
+        "url": "http://localhost:8080/webhook", # 必填，webhook 请求的URL，可配置为 n8n 等 webhook 入口 
+        "talker": "wxid_123",                   # 必填，需要监控的私聊、群聊名称
+        "sender": "",                           # 选填，消息发送者
+        "keyword": ""                           # 选填，关键词
+      }
+    ]
+  }
+}
+```
+
+使用 server 模式的话，可以通过 `CHATLOG_WEBHOOK` 环境变量进行设置。
+
+```shell
+# 方案 1
+CHATLOG_WEBHOOK='{"host":"localhost:5030","items":[{"url":"http://localhost:8080/proxy","talker":"wxid_123","sender":"","keyword":""}]}'
+
+# 方案 2（任选一种）
+CHATLOG_WEBHOOK_HOST="localhost:5030"
+CHATLOG_WEBHOOK_ITEMS='[{"url":"http://localhost:8080/proxy","talker":"wxid_123","sender":"","keyword":""}]'
+```
+
+#### 1. 测试效果
+
+启动 chatlog 并开启自动解密功能，测试回调效果
+
+```shell
+POST /webhook HTTP/1.1
+Host: localhost:8080
+Accept-Encoding: gzip
+Content-Length: 386
+Content-Type: application/json
+User-Agent: Go-http-client/1.1
+
+Body:
+{
+  "keyword": "",
+  "lastTime": "2025-08-27 00:00:00",
+  "length": 1,
+  "messages": [
+    {
+      "seq": 1756225000000,
+      "time": "2025-08-27T00:00:00+08:00",
+      "talker": "wxid_123",
+      "talkerName": "",
+      "isChatRoom": false,
+      "sender": "wxid_123",
+      "senderName": "Name",
+      "isSelf": false,
+      "type": 1,
+      "subType": 0,
+      "content": "测试消息",
+      "contents": {
+        "host": "localhost:5030"
+      }
+    }
+  ],
+  "sender": "",
+  "talker": "wxid_123"
+}
+```
+
 ## MCP 集成
 
-Chatlog 支持 MCP (Model Context Protocol) SSE 协议，可与支持 MCP 的 AI 助手无缝集成。  
-启动 HTTP 服务后，通过 SSE Endpoint 访问服务：
+Chatlog 支持 MCP (Model Context Protocol) 协议，可与支持 MCP 的 AI 助手无缝集成。  
+启动 HTTP 服务后，通过 Streamable HTTP Endpoint 访问服务：
 
 ```
-GET /sse
+GET /mcp
 ```
 
 ### 快速集成
 
 Chatlog 可以与多种支持 MCP 的 AI 助手集成，包括：
 
-- **ChatWise**: 直接支持 SSE，在工具设置中添加 `http://127.0.0.1:5030/sse`
-- **Cherry Studio**: 直接支持 SSE，在 MCP 服务器设置中添加 `http://127.0.0.1:5030/sse`
+- **ChatWise**: 直接支持 Streamable HTTP，在工具设置中添加 `http://127.0.0.1:5030/mcp`
+- **Cherry Studio**: 直接支持 Streamable HTTP，在 MCP 服务器设置中添加 `http://127.0.0.1:5030/mcp`
 
-对于不直接支持 SSE 的客户端，可以使用 [mcp-proxy](https://github.com/sparfenyuk/mcp-proxy) 工具转发请求：
+对于不直接支持 Streamable HTTP 的客户端，可以使用 [mcp-proxy](https://github.com/sparfenyuk/mcp-proxy) 工具转发请求：
 
 - **Claude Desktop**: 通过 mcp-proxy 支持，需要配置 `claude_desktop_config.json`
 - **Monica Code**: 通过 mcp-proxy 支持，需要配置 VSCode 插件设置