HookBox 技术文档

1. 安装指南

环境要求

• Python 2.7 或更高版本
• 支持的 Web 应用框架（如 Django, Rails, PHP 等）

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/your-repo/hookbox.git
   

2. 进入项目目录：

   cd hookbox
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 启动服务器：

   python manage.py runserver
   

2. 项目的使用说明

概述

HookBox 是一个 Comet 服务器和消息队列，紧密集成于 Web 应用框架中。它允许 Web 应用程序处理所有与身份验证、授权、日志记录、消息转换等相关的逻辑，同时隐藏 Comet 的复杂性。

典型会话流程

1. 用户访问 http://www.example.com/index.html，填写登录表单。
2. 浏览器 POST 到 http://www.example.com/login，包含用户名和密码。
3. Web 应用程序返回 Cookie：session_id=abc;。
4. Web 应用程序重定向用户到 http://www.example.com/home。
5. 浏览器调用 hookbox.connect('http://hookbox.example.com')。
6. 浏览器发送 CONNECT 帧到 HookBox，包含 { cookie: "session_id=abc"; }。
7. HookBox 向 http://www.example.com/hookbox/connect 发起 HTTP POST 请求，包含 Cookie: session_id=abc;。
8. Web 应用程序响应 JSON 数据：[ true, {}]，授权客户端连接。
9. 浏览器调用 hookbox.publish('test.location', ["Hello", "World"])。
10. HookBox 向 http://www.example.com/hookbox/publish 发起 HTTP POST 请求，包含 Cookie: session_id=abc; 和查询字符串 payload=["Hello", "World"] 和 channel_name=test.location。
11. Web 应用程序响应 JSON 数据：[true, { } ]，授权客户端发布消息。
12. HookBox 向所有订阅了 test.location 频道的客户端发送 PUBLISH 帧。

3. 项目API使用文档

/publish

• URL: [HOOKBOX]/publish
• 请求表单:
  • channel_name: 消息的目标频道
  • payload: 消息的有效载荷（默认为 null）
• 响应:
  • true: 操作成功
  • false: 发生错误

/channel_info

• URL: [HOOKBOX]/channel_info
• 请求表单:
  • channel_name: 消息的目标频道
  • payload: 消息的有效载荷（默认为 null）
• 响应:
  • true: 操作成功
  • false: 发生错误
• 响应数据:
  • channel_name: 频道名称
  • subscribers: 频道订阅者列表
  • reflective: 频道是否反射发布到发布者
  • history: 频道历史记录的长度

/set_channel_options

• URL: [HOOKBOX]/set_channel_options
• 请求表单:
  • channel_name: 要修改的频道名称
  • reflective: 是否反射发布（默认为 true）
  • history_size: 历史记录大小（默认为 0）
  • moderated: 是否需要授权（默认为 true）
  • moderated_publish: 发布是否需要授权（默认为 true）
  • moderated_subscribe: 订阅是否需要授权（默认为 true）
  • moderated_unsubscribe: 取消订阅是否需要授权（默认为 true）
  • presenceful: 是否包含在线列表（默认为 false）
  • anonymous: 是否匿名（默认为 false）
• 响应:
  • true: 操作成功
  • false: 发生错误

4. 项目安装方式

源码安装

1. 克隆项目仓库：

   git clone https://github.com/your-repo/hookbox.git
   

2. 进入项目目录：

   cd hookbox
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 启动服务器：

   python manage.py runserver
   

Docker 安装

1. 拉取 Docker 镜像：

   docker pull your-repo/hookbox
   

2. 运行容器：

   docker run -d -p 8000:8000 your-repo/hookbox
   

通过以上步骤，您可以成功安装并使用 HookBox 项目。