edgurgel/poxa-automated

Poxa 镜像文档

镜像概述

Poxa是一个与Pusher库兼容的开源Pusher协议实现，设计为单注册应用，启动时需定义应用ID、密钥和密钥。它提供了Pusher协议的核心功能，可用于开发和测试环境中替代商业Pusher服务。

核心功能与特性

• 频道支持：公共频道、私有频道、存在频道
• 客户端事件：支持客户端之间的事件传递
• 安全特性：WebSocket和REST API支持SSL加密
• 管理工具：内置简单控制台，可查看频道活动
• REST API：提供频道和用户管理接口，包括：
  • /users：存在频道用户查询
  • /channels/:channel_name：指定频道信息
  • /channels：所有频道列表

使用场景与适用范围

• 开发环境中替代Pusher服务进行本地测试
• 构建需要实时通信功能的应用原型
• 教学和学习Pusher协议的实现原理
• 小型项目或内部系统的实时通信需求

使用方法与配置说明

基本使用（Docker Run）

使用Docker Hub上的自动构建镜像：

bash
docker run --rm --name poxa -p 8080:8080 docker.xuanyuan.run/edgurgel/poxa-automated:latest

本地构建镜像

bash
git clone https://github.com/edgurgel/poxa.git
cd poxa
docker build -t local/poxa .

配置参数（环境变量）

支持以下环境变量配置：

客户端配置示例

Ruby客户端（pusher-gem）

ruby
Pusher.host = 'localhost'
Pusher.port = 8080

JavaScript客户端（pusher-js）

javascript
// 仅使用WebSocket
var pusher = new Pusher(APP_KEY, {
  wsHost: 'localhost',
  wsPort: 8080,
  enabledTransports: ["ws", "flash"],
  disabledTransports: ["flash"]
});

控制台访问

启动后，可通过http://localhost:8080访问内置控制台，使用默认密钥（app_key和secret）连接，查看频道活动和事件。

示例应用

官方提供一个基于Poxa的存在频道聊天示例：http://poxa-presence-chat.herokuapp.com/，可直接体验Poxa功能。