deamos/osp-ejabberd

Open Streaming Platform - OSP-Ejabberd Docker 镜像文档

镜像概述

OSP-Ejabberd 是 Open Streaming Platform（开放流媒体平台）的官方 Ejabberd 组件 Docker 镜像。该镜像封装了 Ejabberd XMPP 服务器，专为 OSP 平台提供即时通讯、用户消息传递、实时通知等核心交互功能，支持 XMPP 协议标准，可无缝集成到 OSP 整体架构中。

核心功能与特性

• XMPP 协议支持：完整实现 XMPP (Extensible Messaging and Presence Protocol) 标准，支持即时消息、状态呈现、联系人管理等基础功能。
• 用户认证集成：支持与 OSP 平台用户系统对接，实现统一身份认证与权限管理。
• 消息路由与转发：高效处理用户间消息路由，支持单聊、群聊等消息场景。
• 可扩展性：支持集群部署，可通过水平扩展提升并发处理能力。
• 安全特性：内置 TLS/SSL 加密支持，保障消息传输安全；支持访问控制列表（ACL）管理。

使用场景与适用范围

• OSP 平台集成部署：作为 Open Streaming Platform 的核心组件，提供实时交互服务，适用于直播平台、在线教育平台等需要用户即时通讯的场景。
• 独立 XMPP 服务部署：可单独部署作为轻量级 XMPP 服务器，用于构建自定义即时通讯系统。

使用方法与配置说明

前提条件

• 已安装 Docker 引擎（推荐版本 20.10+）
• 如需集成 OSP 平台，需确保与 OSP 主服务网络互通

基本部署命令

bash
docker run -d \
  --name osp-ejabberd \
  -p 5222:5222 \  # XMPP 客户端连接端口
  -p 5269:5269 \  # XMPP 服务器间通信端口
  -p 5443:5443 \  # HTTPS 端口（用于 BOSH/WebSocket）
  -v /path/to/ejabberd/config:/etc/ejabberd \  # 挂载配置文件目录
  -v /path/to/ejabberd/data:/var/lib/ejabberd \  # 挂载数据存储目录
  openstreamingplatform/osp-ejabberd:latest

环境变量配置

持久化配置

为确保配置与数据持久化，建议挂载以下目录：

• /etc/ejabberd：存放 Ejabberd 配置文件（如 ejabberd.yml）
• /var/lib/ejabberd：存放用户数据、消息历史等

集成 OSP 平台

当作为 OSP 组件部署时，需配置与 OSP 主服务的通信：

1. 确保网络互通，可通过 Docker 网络连接 OSP 其他组件
2. 在 ejabberd.yml 中配置认证模块指向 OSP 用户服务：

   yaml
   auth_method: external
   extauth_program: "/path/to/osp-auth-script"
   

参考文档

更多详细配置与部署说明，请参考官方文档：https://open-streaming-platform.readthedocs.io/en/latest/install/install.html#docker-install