netz39/prosody

Prosody Docker镜像文档

镜像概述

本镜像基于官方prosody/prosody-docker构建，融合社区其他镜像的优化思路，提供轻量级、可扩展的XMPP（可扩展消息与存在协议）服务器部署方案。Prosody作为开源XMPP服务器，以模块化设计、低资源占用和高度可配置性为特点，适用于构建即时通讯、 presence 服务及实时通讯应用。

核心功能与特性

• 轻量级架构：基于Prosody核心，资源占用低，适配各类部署环境
• 模块化设计：支持丰富的XMPP扩展协议（XEP），可按需加载功能模块
• 配置灵活性：支持通过环境变量或挂载配置文件自定义服务器参数
• 持久化存储：支持数据卷挂载，确保用户数据、配置文件和日志持久化
• 安全特性：内置TLS/SSL支持，可配置证书实现加密通讯
• 社区优化：整合社区最佳实践，提升部署便捷性和运行稳定性

使用场景与适用范围

• 企业内部通讯：构建私有即时通讯系统，保障组织内通讯安全与隐私
• 团队协作工具：作为实时消息平台，集成到团队协作流程
• 物联网通讯：支持设备间基于XMPP协议的实时数据交换
• 开发测试环境：快速部署XMPP服务用于应用开发和协议兼容性测试
• 小型社区服务：为小型社区或组织提供轻量级即时通讯支持

使用方法与配置说明

基本部署（Docker Run）

通过以下命令快速启动Prosody服务器：

bash
docker run -d \
  --name prosody \
  -p 5222:5222 \  # XMPP客户端标准连接端口
  -p 5269:5269 \  # XMPP服务器间通讯端口
  -p 5280:5280 \  # HTTP-Bind端口（用于Web客户端）
  -v /path/to/local/config:/etc/prosody \  # 配置文件目录挂载
  -v /path/to/local/data:/var/lib/prosody \  # 用户数据持久化
  -v /path/to/local/certs:/etc/prosody/certs \  # TLS证书目录
  gitea.n39.eu/netz39_admin/prosody-docker

Docker Compose配置

创建docker-compose.yml实现更复杂部署：

yaml
version: '3'

services:
  prosody:
    image: gitea.n39.eu/netz39_admin/prosody-docker
    container_name: prosody
    ports:
      - "5222:5222"    # XMPP客户端端口
      - "5269:5269"    # 服务器间通讯端口
      - "5280:5280"    # HTTP-Bind端口
      - "5281:5281"    # HTTPS-Bind端口（可选）
    volumes:
      - ./config:/etc/prosody
      - ./data:/var/lib/prosody
      - ./certs:/etc/prosody/certs
    environment:
      - PROSODY_DOMAIN=example.com      # 服务器主域名
      - PROSODY_ADMIN_USER=admin        # 管理员用户名
      - PROSODY_ADMIN_PASS=securepass   # 管理员密码
      - PROSODY_LOG_LEVEL=info          # 日志级别
    restart: unless-stopped

环境变量配置

配置文件自定义

通过挂载/etc/prosody目录自定义配置，主配置文件为prosody.cfg.lua。示例虚拟主机配置：

lua
-- 主配置文件示例（prosody.cfg.lua）
VirtualHost "example.com"
  enabled = true
  ssl = {
    key = "/etc/prosody/certs/example.com.key";
    certificate = "/etc/prosody/certs/example.com.crt";
  }
  modules_enabled = {
    "roster";        -- 联系人列表
    "presence";      -- 在线状态
    "message";       -- 消息传递
    "privacy";       -- 隐私控制
    "vcard";         -- 电子名片
  }

证书配置

生产环境需配置有效的TLS证书：

1. 将证书文件（如example.com.crt公钥和example.com.key私钥）放入本地证书目录
2. 在虚拟主机配置中指定证书路径（见上述配置示例）
3. 推荐使用Let's Encrypt获取免费SSL证书

注意事项

• 首次启动前确保挂载目录权限正确（容器内运行用户可能需要读写权限）
• 生产环境必须配置TLS证书，避免明文传输
• 高负载场景下建议调整容器资源限制（如--memory和--cpus参数）
• 定期备份/var/lib/prosody目录中的用户数据和配置文件
• 如需集群部署，需额外配置共享存储和集群模块