文档中心

开发文档

完整的开发文档帮助开发者快速上手,从环境搭建到部署运维,全程指引。

指南

快速开始

从零开始,几分钟内完成环境搭建并运行易聊 IM 系统。

1

环境要求

Node.js 18+、MySQL 8.0+、Redis 7+,确保开发环境满足最低配置要求。

查看详情
2

下载源码

通过 Git 克隆或下载源码包,获取完整项目代码及依赖文件。

查看详情
3

配置启动

配置数据库连接、Redis 连接,运行初始化脚本,启动服务。

查看详情

环境

开发环境

详细的开发环境搭建指南,涵盖前后端及数据库配置。

💻

前端开发

基于 React/Vue 的前端项目,热重载开发,支持 Android 和 Web 双端。

查看详情
🔧

后端开发

基于 Golang/Node.js 的后端服务,API 文档自动生成,方便调试。

查看详情
🗃

数据库配置

MySQL 表结构初始化、Redis 缓存配置,保证数据存储高效稳定。

查看详情

部署

Docker 部署

使用 Docker Compose 一键部署易聊全部服务,简化运维流程。

快速部署

服务内部端口保持 8081,线上宿主机固定映射到 127.0.0.1:18081,由 Nginx 统一代理。MySQL、Redis 和后台静态站点都有明确部署路径。

部署

宝塔部署

使用宝塔面板快速部署易聊系统,适合不具备 Docker 环境的服务器。

1

环境安装

通过宝塔面板安装 Nginx、MySQL、Redis、Node.js 等运行环境。

查看详情
2

站点配置

创建站点、配置域名、SSL 证书、反向代理等操作指导。

查看详情
3

启动服务

上传源码、安装依赖、配置数据库,启动易聊全部服务模块。

查看详情

打包

Android 打包

将易聊 App 打包为 APK 或 AAB,发布到应用市场或企业内部使用。

📱

环境搭建

安装 Android Studio、配置 SDK、NDK,准备打包所需工具链。

查看详情
📦

打包签名

配置应用签名、版本号,生成正式发布用的 APK 文件。

查看详情
🌐

发布

上架应用市场或企业内部分发,支持版本更新管理。

查看详情

运维

运维与备份

系统运维指南,包括日志管理、数据备份、监控告警等内容。

💾

数据备份

MySQL 定时备份、Redis 持久化、文件存储备份策略,保障数据安全。

查看详情
⚠️

监控告警

服务健康检查、资源使用监控、异常告警通知,保障系统稳定运行。

查看详情
📝

日志管理

服务日志分级、日志轮转、日志集中收集与分析,快速定位问题。

查看详情