unclev/prosody-docker-extended

prosody-docker-extended

基于Ubuntu 20.04的Prosody XMPP服务器Docker镜像构建系统，集成社区模块和telnet控制台。该项目受官方Prosody Docker启发，旨在解决prosody/prosody-docker#29问题。

构建

bash
docker build --rm=true -t unclev/prosody-docker-extended .

镜像可在https://hub.docker.com/r/unclev/prosody-docker-extended/%E8%8E%B7%E5%8F%96%E3%80%82Docker Hub镜像会在官方Prosody deb仓库夜间构建后一小时内自动重建。

核心功能与特性

端口

镜像向Docker主机暴露以下端口：

• 80：HTTP端口
• 443：HTTPS端口
• 5222：c2s（客户端到服务器）端口
• 5269：s2s（服务器到服务器）端口
• 5347：XMPP组件端口
• 5280：BOSH/WebSocket端口
• 5281：安全BOSH/WebSocket端口

注意：默认端口可在配置文件中修改，修改后原端口将不再暴露。

卷

可挂载以下卷以实现数据持久化和配置管理：

• /etc/prosody：

  • 存放Prosody配置文件和SSL证书
  • 若目录为空，启动脚本会自动复制构建时预配置的数据

• /var/lib/prosody：

  • Prosody内部数据存储（参见Prosody文档的数据存储）

• /var/log/prosody：

  • 日志文件存储（默认输出到控制台，可通过docker logs查看）
  • 主机日志目录需对prosody用户可写

• /usr/lib/prosody/modules-community：

  • 社区模块存放位置
  • 若目录为空，启动脚本会自动克隆[***]

• /usr/lib/prosody/modules-custom：

  • 自定义模块存放位置
  • 模块加载路径配置：

  lua
  -- 按指定顺序搜索模块，优先于默认路径
  plugin_paths = { "/usr/lib/prosody/modules-custom", "/usr/lib/prosody/modules-community" }
  

Prosody用户

镜像中内置用户：uid=1000(prosody)，gid=1000(prosody)，组为1000(prosody)。

启动时创建Jabber用户

通过环境变量创建初始用户，与官方Prosody Docker兼容：

• LOCAL：用户名
• DOMAIN：域名
• PASSWORD：密码

启动时执行：prosodyctl register $LOCAL $DOMAIN $PASSWORD（已存在用户将被覆盖）

使用场景与适用范围

适用于部署XMPP即时通讯服务器的场景，如企业内部通讯、社区聊天服务等。支持通过社区模块和自定义模块扩展功能，满足多样化业务需求。

使用方法与配置说明

部署示例

docker run命令

bash
docker run -d \
   --name prosody_xmpp_server \
   --hostname shakespeare.lit \
   -p 5222:5222 \
   -p 5269:5269 \
   -p localhost:5347:5347 \
   -e LOCAL=romeo \
   -e DOMAIN=shakespeare.lit \
   -e PASSWORD=juliet4ever \
   -v /srv/prosody/config:/etc/prosody \
   -v /srv/prosody/data:/var/lib/prosody \
   -v /srv/prosody/log:/var/log/prosody \
   -v /srv/prosody/modules/community:/usr/lib/prosody/modules-community \
   -v /srv/prosody/modules/custom:/usr/lib/prosody/modules-custom \
   unclev/prosody-docker-extended:0.10

docker-compose配置（v1，PostgreSQL后端）

yaml
sql:
  image: postgres
  restart: always
  env_file: /srv/prosody/.env
  ports:
    - '5432:5432'
  volumes:
    - '/srv/prosody/db/postgresql:/var/lib/postgresql/prosody'

xmpp_server:
  image: unclev/prosody-docker-extended:0.10
  restart: unless-stopped
  hostname: shakespeare.lit
  ports:
    - 5222:5222
    - 5269:5269
    - 5347:5347
    - 5280:5280
  env_file: /srv/prosody/.env
  links: 
    - sql:sql
  volumes:
    - '/srv/prosody/config:/etc/prosody'
    - '/srv/prosody/data:/var/lib/prosody'
    - '/srv/prosody/log:/var/log/prosody'
    - '/srv/prosody/modules/community:/usr/lib/prosody/modules-community'
    - '/srv/prosody/modules/custom:/usr/lib/prosody/modules-custom'

容器shell访问

bash
# 普通用户
docker exec -it prosody_xmpp_server bash

# root用户
docker exec -it --user root prosody_xmpp_server bash

# docker-compose
docker-compose exec xmpp_server bash

Telnet控制台

启用mod_admin_telnet插件后，通过以下命令访问：

bash
# 直接访问
docker exec -it prosody_xmpp_server telnet localhost 5582

# docker-compose
docker-compose exec xmpp_server telnet localhost 5582

prosodyctl使用

使用prosodyctl管理服务器，不支持start/stop/restart命令（容器内非守护进程模式）。

重启服务器：

bash
# 单个服务
docker-compose stop xmpp_server && docker-compose rm -f xmpp_server && docker-compose up -d

# 所有服务
docker-compose down && docker-compose up -d

社区模块管理

镜像内置Mercurial，可通过容器shell更新社区模块：

bash
docker-compose exec xmpp_server bash
cd /usr/lib/prosody/modules-community
hg pull --update

日志配置

默认日志输出到控制台，如需文件日志，在配置中添加：

lua
log = {
    { levels = { min = "error" }, to = "file", filename = "/var/log/prosody/prosody.err" };
    { levels = { min = "info" }, to = "file", filename = "/var/log/prosody/prosody.log" };
}

日志轮转需在主机上配置。

服务器配置

配置与独立Prosody服务器相同，注意使用容器内部路径。详见官方文档配置Prosody。