telegram-search

[!WARNING] 本项目未发行任何虚拟货币，请警惕相关诈骗风险。

本软件仅供您导出和检索个人聊天记录使用，切勿将其用于任何违法用途。

🚀 快速开始

使用 Docker Compose

1. 新建一个空目录，用于存放 Telegram Search 的配置和数据：

mkdir telegram-search
cd telegram-search

2. 下载 Docker Compose 文件并启动全部服务（包括数据库、MinIO 等）：

curl -L https://raw.githubusercontent.com/groupultra/telegram-search/refs/heads/main/docker/docker-compose.yml -o docker-compose.yml
curl -L https://raw.githubusercontent.com/groupultra/telegram-search/refs/heads/main/docker/.env.example -o .env
curl -L https://raw.githubusercontent.com/groupultra/telegram-search/refs/heads/main/docker/init.sql -o init.sql
docker compose -f docker-compose.yml up -d

3. 然后打开 http://localhost:3333 即可使用 🎉

使用 Docker Image

若未配置 MinIO 相关参数，媒体文件将默认保存至本地的 data/media 目录。

docker run -d --name telegram-search -p 3333:3333 ghcr.io/groupultra/telegram-search:latest

自定义环境变量

[!IMPORTANT] AI Embedding & LLM 设置现在在应用内按账户配置（设置 → API）。

请在修改完成 .env 文件后，再次执行 docker compose -f docker-compose.yml up -d 启动服务。

以下环境变量全部为可选，如果不填写，则会使用默认值。

| 环境变量 | 说明 | 示例值 | | ------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------- | | TELEGRAM_API_ID | 从 my.telegram.org 获取的 Telegram 应用 ID | 611335 | | TELEGRAM_API_HASH | 从 my.telegram.org 获取的 Telegram 应用 Hash | d524b414d21f4d37f08684c1df41ac9c | | DATABASE_TYPE | 数据库类型，可选 postgres 或 pglite | pglite | | DATABASE_URL | PostgreSQL 连接字符串（仅在 DATABASE_TYPE=postgres 时填写） | postgresql://postgres:123456@pgvector:5432/postgres | | TELEGRAM_BOT_TOKEN| 通过 @BotFather 创建的 Telegram Bot Token | 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11 | | PROXY_URL | 代理地址（支持如 socks5://user:pass@host:port 等格式） | socks5://user:pass@host:port | | PORT | 后端服务 HTTP/WebSocket 监听端口 | 3333 | | HOST | 后端服务监听地址 | 0.0.0.0 | | BACKEND_URL | Nginx 作为反向代理时用于 /api 和 /ws 的上游后端地址 | http://127.0.0.1:3333 | | MINIO_URL | MinIO 服务地址 | http://minio:9000 | | MINIO_ACCESS_KEY | MinIO 访问密钥 | minioadmin | | MINIO_SECRET_KEY | MinIO 访问密钥对应的密钥 | minioadmin | | MINIO_BUCKET | MinIO 存储桶名称 | telegram-media |

使用 Docker Image 环境变量

请根据自己的需要自行修改环境变量。

docker run -d --name telegram-search \
  -p 3333:3333 \
  -e DATABASE_TYPE=postgres \
  -e DATABASE_URL=postgresql://postgres:123456@localhost:5432/postgres \
  ghcr.io/groupultra/telegram-search:latest

💻 开发指南

纯浏览器模式

git clone https://github.com/groupultra/telegram-search.git
cd telegram-search
pnpm install
cp .env.example .env
pnpm run dev

服务器模式

git clone https://github.com/groupultra/telegram-search.git
cd telegram-search
pnpm install

cp .env.example .env

docker compose -f docker/docker-compose.dev.yml up -d pgvector minio

pnpm run server:dev
pnpm run web:dev

📖 更多开发细节和架构细节： CONTRIBUTING.md

🚀 Activity