Telegram Search

English | 快速开始

一个功能强大的 Telegram 聊天记录搜索工具，支持向量搜索和语义匹配。基于 OpenAI 的语义向量技术，让你的 Telegram 消息检索更智能、更精准。

• 欢迎 PR 贡献！
• 由于项目处于快速迭代阶段，可能会出现数据库不兼容的情况，建议定期备份数据。

💖 赞助者

🚀 快速开始

这是启动 Telegram Search 的最简便的方式，它会通过 Docker 启动所有必需的服务（包括数据库和应用服务器）。

1. 克隆仓库：

   git clone https://github.com/GramSearch/telegram-search.git
   cd telegram-search

2. 设定配置： 根据需要，修改 config/config.yaml 中的设置。
   务必修改配置中的 database.host 的值为数据库容器的服务名称 "pgvector"。

   cp config/config.example.yaml config/config.yaml

3. 启动服务：

   docker compose up -d

访问 http://<host>:3333 即可打开搜索界面。

💻 本地运行

1. 克隆仓库

   git clone https://github.com/GramSearch/telegram-search.git
   cd telegram-search

2. 安装依赖：

   pnpm install

3. 配置环境:

   cp config/config.example.yaml config/config.yaml

4. 启动数据库容器： 在本地开发模式下， Docker 只用来启动数据库容器。

   docker compose up -d pgvector

5. 同步数据库表结构：

   pnpm run db:migrate

6. 启动服务：

   # 启动后端服务
   pnpm run dev:server
   
   # 启动前端界面
   pnpm run dev:frontend

访问 http://localhost:3333 即可打开搜索界面。

🚀 Activity

📝 License

MIT License © 2025