Prosody Docker镜像文档

概述

Prosody是一个现代、轻量级且高度可扩展的XMPP（Extensible Messaging and Presence Protocol）服务器，也称为Jabber服务器。该Docker镜像提供了Prosody服务器的便捷部署方式，使开发者和系统管理员能够快速搭建安全、可靠的实时通信服务。

核心功能与特性

• 完整支持XMPP标准协议，包括RFC 6120、RFC 6121等
• 轻量级设计，资源占用低，性能高效
• 模块化架构，支持功能扩展
• 内置支持多用户聊天（MUC）、文件传输和离线消息
• 强大的安全特性，包括TLS加密、SASL认证和访问控制
• 支持多种存储后端，包括SQL数据库和内存存储
• 简单易用的配置系统，基于Lua语法

使用场景

• 企业内部即时通讯系统
• 在线游戏聊天服务
• 客户支持实时聊天系统
• 社交网络实时通知服务
• 物联网设备间通信
• 多用户协作工具的实时通信组件

快速开始

基本用法

使用以下命令快速启动一个基本的Prosody服务器实例：

docker run -d -p 5222:5222 -p 5269:5269 --name prosody saraesmise/prosody

使用Docker Compose

创建docker-compose.yml文件：

version: '3'
services:
  prosody:
    image: saraesmise/prosody
    ports:
      - "5222:5222"  # 客户端连接端口
      - "5269:5269"  # 服务器间通信端口
      - "5280:5280"  # HTTP端口 (用于BOSH等)
      - "5281:5281"  # HTTPS端口
    volumes:
      - ./data:/var/lib/prosody
      - ./config:/etc/prosody
      - ./certs:/etc/prosody/certs
    environment:
      - PROSODY_DOMAIN=example.com
      - ADMIN_USER=***
      - ADMIN_PASSWORD=securepassword
    restart: unless-stopped

启动服务：

docker-compose up -d

配置说明

环境变量

持久化数据

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

• /var/lib/prosody: 存储用户数据和消息历史
• /etc/prosody: 配置文件目录
• /etc/prosody/certs: SSL/TLS证书目录

自定义配置

1. 创建本地配置目录：mkdir -p ./config
2. 创建自定义配置文件：touch ./config/prosody.cfg.lua
3. 使用自定义配置启动容器：

docker run -d -p 5222:5222 -v $(pwd)/config:/etc/prosody saraesmise/prosody

管理命令

创建用户

docker exec -it prosody prosodyctl register username example.com password

查看用户列表

docker exec -it prosody prosodyctl user list example.com

重启服务

docker exec -it prosody prosodyctl restart

查看服务器状态

docker exec -it prosody prosodyctl status

安全注意事项

1. 始终使用TLS/SSL证书：确保为您的域名配置有效的SSL证书
2. 定期更新镜像：保持Prosody服务器最新以获取安全补丁
3. 使用强密码：为所有用户账户设置复杂密码
4. 限制网络访问：只开放必要的端口，并配置适当的防火墙规则
5. 定期备份数据：定期备份用户数据和配置文件

故障排除

常见问题解决

• 连接问题：检查端口映射是否正确，防火墙设置是否允许相关端口访问
• 认证失败：验证用户名、域名和密码是否正确，检查用户是否已注册
• 日志查看：使用docker logs prosody命令查看服务器日志以诊断问题
• 配置错误：使用docker exec -it prosody prosodyctl check验证配置文件语法

高级配置

启用额外模块

编辑配置文件prosody.cfg.lua，在modules_enabled部分添加所需模块：

modules_enabled = {
    -- 基本模块
    "roster"; "saslauth"; "tls"; "dialback"; "disco";
    
    -- 额外功能模块
    "private"; "vcard"; "version"; "uptime"; "time"; "ping";
    
    -- 多用户聊天
    "muc";
    
    -- 文件传输
    "proxy65";
    
    -- HTTP服务
    "bosh"; "websocket";
}

配置数据库后端

Prosody支持多种数据库后端，如SQLite、MySQL、PostgreSQL等。要配置MySQL后端：

storage = "sql"
sql = {
    driver = "MySQL",
    database = "prosody",
    username = "prosody",
    password = "password",
    host = "mysql-host",
    port = 3306
}

相关资源

• Prosody官方网站
• Prosody文档
• XMPP协议规范
• Docker官方文档