cyberxbtc/slanger

OceanEx Slanger

![Gem Version]([] ![Build Status]([]

镜像概述

OceanEx Slanger继承自未维护的Slanger项目，由OceanEx开发团队支持。团队会定期进行bug修复和安全更新，可能进一步添加功能或优化性能，维护将持续至找到更优方案。该镜像为Pusher协议的独立Ruby实现服务器，不适合嵌入Rails或Sinatra应用，需作为独立服务运行。

核心功能

• 实现Pusher协议的HTTP REST API和WebSocket服务
• 支持集群部署，可通过Haproxy进行负载均衡
• 支持通过Haproxy实现SSL终止，降低服务端负担
• 依赖Redis存储状态数据
• 提供丰富的配置选项（自定义app key、secret、Redis地址等）
• 支持Webhook回调功能

使用场景

• 构建实时通信应用（如在线聊天、实时数据展示、通知推送）
• 替代第三方Pusher服务，实现自托管实时服务
• 需要低延迟实时交互的企业级应用开发

配置说明

系统要求

• Ruby 2.6.3及以上版本
• Redis服务

命令行参数

OceanEx Slanger支持以下命令行参数（可通过配置文件yaml提供部分选项，命令行参数优先级更高）：

• -k/--app_key: Pusher应用密钥（必填）
• -s/--secret: Pusher密钥（必填）
• -C/--config_file: Yaml配置文件路径（可选）
• -r/--redis_address: Redis服务器地址（默认：redis://127.0.0.1:6379/0）
• -a/--api_host: API服务绑定地址（默认：0.0.0.0:4567）
• -w/--websocket_host: WebSocket服务绑定地址（默认：0.0.0.0:8080）
• -p/--private_key_file: SSL私钥文件路径（可选，启用SSL需配合证书文件）
• -c/--cert_file: SSL证书文件路径（可选）
• -v/--verbose: 启用 verbose 模式（调试用）

Docker部署示例

构建镜像

bash
make build

启动服务（含Redis依赖）

bash
make up

提示：可修改docker-compose.yaml中的app key和secret参数

停止服务

bash
make down

应用代码修改

服务端（Ruby示例）

ruby
Pusher.host = 'slanger.example.com'
Pusher.port = 4567

客户端（JavaScript示例）

html
<script type="text/javascript">
  var pusher = new Pusher('#{Pusher.key}', {
    wsHost: "0.0.0.0",
    wsPort: "8080",
    wssPort: "8080",
    enabledTransports: ['ws', 'flash']
  });
</script>