跳到主要内容

🛠 源码部署

1. 环境及组件要求​

对于服务器环境、系统、以及所依赖组件的说明可以参考此文档

2. 部署 OpenIM Server (IM)​

2.1 clone 仓库 建议切换到 release-v3.8.2 分支​

git clone https://github.com/openimsdk/open-im-server && cd open-im-server

2.2 部署组件 (mongodb/redis/kafka/MinIO)​

docker compose up -d

如需启动运维组件(prometheus/alertmanager/grafana)

docker compose --profile m up -d

监控告警使用参考： 监控告警

2.3 设置外网 IP 或域名参考 Nginx 配置​

修改 config/minio.yml 中的 externalAddress 为 http://外网IP:port 或 域名

2.4 🛠️ 初始化​

第一次编译前，linux/mac 平台下执行：

bash bootstrap.sh

windows 执行

bootstrap.bat

中国境内建议设置go代理

$ go env -w GO111MODULE=on
$ go env -w GOPROXY=https://goproxy.cn,direct

2.5 🛠️ 编译(linux/windows/mac 平台均可用)​

mage

2.6 🚀 启动/停止/检测(linux/windows/mac 平台均可用)​

# 启动
mage start
# 或 后台启动 收集日志
nohup mage start >> _output/logs/openim.log 2>&1 &
# 停止
mage stop
# 检测
mage check

3. 部署 App Server (Chat)​

3.1 clone 仓库 建议切换到 release-v1.8.3 分支​

git clone https://github.com/openimsdk/chat&& cd chat

3.2 🛠️ 初始化​

第一次编译前，linux/mac 平台下执行：

bash bootstrap.sh

windows 执行

bootstrap.bat

3.3 🛠️ 编译(linux/windows/mac 平台均可用)​

mage

3.4 🚀 启动/停止/检测(linux/windows/mac 平台均可用)​

# 启动
mage start
# 或 后台启动 收集日志
nohup mage start >> _output/logs/chat.log 2>&1 &
# 停止
mage stop
# 检测
mage check

4. 快速验证​

请参考快速验证文档

5. 管理后台和监控系统​

请参考 管理后台和监控系统 文档。

6. 关于配置项的修改​

参考此文档

7. 常见问题​

7.1 📜 日志查看​

日志位置：

  • IM：_output/logs/openim-service-log.*
  • Chat：_output/logs/openim-chat-log.*

7.2 🚀 启动顺序​

启动顺序如下：

  • IM 依赖的组件：mongo/redis/kafka/minio
  • IM
  • Chat