快速开始

imcore 以编译好的 Linux 二进制发行包交付(不含源码)。本页从拿到发行包开始,10 分钟跑通一条消息。

0. 一分钟体验(Docker Compose)

只想先看看效果?一条命令拉起全套(服务端 + PostgreSQL + Redis,自动建表),浏览器免登录体验:

curl -fsSLO https://balala.im/releases/latest/docker-compose.yml
docker compose up -d
# 打开 http://localhost:8080/home/chat

这是本地体验配置(密钥为公开占位值,勿对公网部署)。正式部署走下面的发行包路径。

1. 准备环境

  • Linux 服务器(amd64 / arm64 / loong64,静态编译,无 glibc 依赖,兼容麒麟 / 统信等信创系统)
  • 数据库 + Redis。数据库推荐 PostgreSQL:客服版的 AI/RAG 能力要求 PostgreSQL(需 pgvector 扩展),读写分离与信创库适配也以 PG 系最顺;已有 MySQL 基础设施亦完整支持
  • (集群部署时)RabbitMQ 或 NATS JetStream —— 单机体验无需

无需 Go 环境,无需编译。

2. 获取并解包发行包

基础版可免费获取,付费版本随订单交付(联系商务)。发行包按版本与架构命名:

tar -xzf imcore-basic-<version>-linux-amd64.tar.gz
cd basic

包内结构:

bin/          websocket / persist_consumer / jetstream_consumer / migrate / demo_token 等
config/       app.yaml.example(含该版本推荐配置)
migrations/   数据库迁移 SQL
docs/         客户端接入指南、产品功能对照

3. 配置

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

最少修改两处:数据库连接、Redis 地址。数据库用一个开关选择——database.driver: postgres | mysql(模板默认 postgres),然后填写对应 postgres: / mysql: 段的 DSN,另一段留着不用即可;bin/migrate 建表与服务端运行读同一开关。

付费版本再把商务交付的授权文件放到服务器,并在 license.file 中指向它(基础版无需授权文件)。

默认端口:HTTP 8080(WebSocket 内嵌在同端口,路径 /acc)、gRPC 9001

4. 初始化数据库

./bin/migrate -status    # 查看待应用迁移
./bin/migrate            # 应用全部迁移(记录在 schema_migrations 表)

5. 启动与验证

./bin/websocket

另开一个终端,先用包内的 demo_token 生成一枚测试 JWT(secret 填 app.yamlauth.jwt_secret 的值),再连一条 WebSocket:

./bin/demo_token -user alice -secret "<auth.jwt_secret>"
npx wscat -c "ws://localhost:8080/acc?token=<上一步输出>"

生产环境中客户端 token 由你的业务后端签发,验签规则(HS256、issuer / audience)见《客户端接入指南》。

连接成功后,按《客户端接入指南》发送登录与消息命令即可开始收发消息。生产环境建议经 Nginx 反代 /acc,并用 systemd 托管进程。