foxsystem/chatplus Docker 镜像 - 轩辕镜像

ChatPlus Server 技术文档

1. 镜像概述

ChatPlus Server 是一个高性能、可扩展的聊天服务器，旨在为开发者提供构建实时聊天应用的基础设施。该服务器支持多种通信协议，具备消息处理、用户管理和数据持久化能力，可快速集成到各类需要实时交互功能的系统中。

2. 核心功能与特性

2.1 实时通信能力

• 支持 WebSocket、MQTT 等多种实时通信协议，确保低延迟消息传递
• 支持单聊、群聊等多种聊天模式，满足不同场景需求
• 消息投递状态跟踪（已发送、已读、未读）

2.2 用户管理与认证

• 内置用户认证机制，支持用户名密码、Token 等多种认证方式
• 用户状态管理（在线/离线状态同步）
• 角色与权限控制，可配置不同用户的操作权限

2.3 数据持久化与扩展性

• 支持消息持久化存储，可对接 MySQL、MongoDB 等数据库
• 水平扩展架构，支持多实例部署以应对高并发场景
• 提供 RESTful API，便于与外部系统集成

2.4 其他特性

• 消息加密传输，保障通信安全
• 多客户端兼容（Web、移动端、桌面端）
• 完善的日志系统，便于问题排查与系统监控

3. 使用场景与适用范围

3.1 企业内部系统

• 企业内部即时通讯工具，支持员工间实时沟通
• 团队协作平台的实时消息模块

3.2 在线服务领域

• 电商平台在线客服系统，实现客户与客服的实时对话
• 在线教育平台的师生互动、课堂实时问答功能

3.3 社交与互动应用

• 社交APP的实时聊天功能
• 游戏内实时聊天系统，支持玩家间互动

4. 使用方法与配置说明

4.1 基本运行命令

通过 Docker 快速启动 ChatPlus Server：

bash
docker run -d \
  -p 8080:8080 \
  -p 8081:8081 \
  --name chatplus-server \
  -e PORT=8080 \
  -e WS_PORT=8081 \
  -e DB_TYPE=mysql \
  -e DB_HOST=your-db-host \
  -e DB_PORT=3306 \
  -e DB_USER=chatplus \
  -e DB_PASSWORD=your-password \
  -e DB_NAME=chatplus_db \
  chatplus/server:latest

4.2 环境变量配置

4.3 Docker Compose 配置示例

创建 docker-compose.yml 文件，配置服务与依赖组件（如数据库）：

yaml
version: '3'
services:
  chatplus-server:
    image: chatplus/server:latest
    ports:
      - "8080:8080"
      - "8081:8081"
    environment:
      - PORT=8080
      - WS_PORT=8081
      - DB_TYPE=mysql
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_USER=root
      - DB_PASSWORD=rootpassword
      - DB_NAME=chatplus
      - AUTH_ENABLED=true
    depends_on:
      - mysql
    restart: always

  mysql:
    image: mysql:8.0
    ports:
      - "3306:3306"
    environment:
      - MYSQL_ROOT_PASSWORD=rootpassword
      - MYSQL_DATABASE=chatplus
    volumes:
      - mysql-data:/var/lib/mysql
    restart: always

volumes:
  mysql-data:

启动服务：

bash
docker-compose up -d

5. 配置参数说明

5.1 服务配置

• PORT: HTTP API 服务监听端口，用于接收客户端 API 请求
• WS_PORT: WebSocket 服务端口，用于建立实时通信连接

5.2 数据库配置

• DB_TYPE: 指定后端数据库类型，支持主流关系型与非关系型数据库
• DB_HOST/DB_PORT/DB_USER/DB_PASSWORD/DB_NAME: 数据库连接参数，需根据实际环境配置

5.3 安全配置

• AUTH_ENABLED: 启用时，客户端需通过认证才能连接服务器，未启用时允许***访问（仅建议测试环境使用）

5.4 日志配置

• LOG_LEVEL: 控制日志输出详细程度，调试时可设为 debug，生产环境建议设为 info 或 warn

6. 注意事项

• 生产环境中建议启用 AUTH_ENABLED 并配置安全的认证方式
• 高并发场景下，可通过增加服务器实例并配置负载均衡实现水平扩展
• 消息持久化依赖数据库，需确保数据库服务稳定运行并做好数据备份
• 首次启动时，服务器会自动初始化数据库表结构，无需手动创建