Flare IM

flare-im-core 快速开始（本地）

前置

  • Docker / Docker Compose
  • Rust 1.94+（与工作区 rust-version 一致）
  • 已克隆 monorepo（含 flare-proto、flare-server-core）

1. 启动基础设施

cd flare-im-core/deploy
docker compose up -d

确认 Consul、JetStream、PostgreSQL、Redis 健康（见 deploy 文档）。

2. 配置与迁移

按 flare-im-core/README.md 执行数据库初始化与环境变量（config/ 下示例）。

3. 启动核心服务

cd flare-im-core
./scripts/start_server.sh

典型客户端默认端点（以本地配置为准）：

用途默认（示例）
信令 WebSocketws://127.0.0.1:60051
业务 HTTP/gRPC 网关http://127.0.0.1:50050

完整矩阵见 服务端 — 客户端接入。

4. 用 SDK 验证链路

cd flare-im-core-sdk
RUST_LOG=info cargo run --example complete_client

或在 monorepo 运行 examples/flare-base-tauri（桌面演示）。

5. 纯 IM Core 模式

  • 不配置业务 Hook 即可跑通 消息 / 会话 / 同步 主干
  • 单聊门禁、好友关系等由业务系统自行实现或通过 Hook 扩展

6. 生产注意

  • 各服务 可独立扩缩；启动期 gRPC 采用 lazy 连接，避免硬编码启动顺序
  • 监控：Prometheus 指标（各 crate 暴露点见源码）
  • 详见 部署文档