Hector 项目技术文档

1. 安装指南

1.1 环境准备

• 确保系统中已安装 Ruby 环境。
• 安装 RubyGems，用于管理 Ruby 包。

1.2 安装 Hector

使用 RubyGems 安装 Hector：

$ gem install -r hector

1.3 创建服务器

安装完成后，创建一个新的 Hector 服务器：

$ hector setup myserver

该命令会在当前目录下创建一个名为 myserver.hect 的目录，包含服务器配置文件和相关资源。

1.4 设置用户账户

进入服务器目录并设置第一个用户账户：

$ cd myserver.hect
$ hector identity remember sam
Enter password:

1.5 启动服务器

启动 Hector 守护进程：

$ hector daemon

默认情况下，服务器会在 0.0.0.0（所有 IP 地址）上监听端口 6767（未加密）和 6868（加密）。

2. 项目的使用说明

2.1 连接到服务器

使用支持 IRC 协议的客户端连接到 Hector 服务器。默认情况下，服务器监听端口 6767（未加密）和 6868（加密）。

2.2 支持的 IRC 命令

Hector 支持以下 IRC 命令：

• USER 和 PASS：用于向服务器进行身份验证。
• NICK：设置昵称。
• JOIN：加入频道。
• PRIVMSG 和 NOTICE：向其他用户或频道发送消息。
• TOPIC：更改或返回频道主题。
• NAMES：显示频道中的用户列表。
• WHO：类似于 NAMES，但返回更多信息。
• WHOIS：显示某个昵称的详细信息。
• PART：离开频道。
• AWAY：标记或取消标记为离开状态。
• INVITE：邀请其他用户加入频道。
• PING：用于测量客户端与服务器之间的连接速度。
• QUIT：断开与服务器的连接。

2.3 用户管理

Hector 没有内置的管理命令，用户访问权限通过命令行工具进行管理。可以使用以下命令添加或删除用户：

$ hector identity remember <username>
$ hector identity forget <username>

3. 项目API使用文档

3.1 自定义身份验证适配器

Hector 支持通过自定义身份验证适配器连接到现有的身份验证系统。可以在 init.rb 文件中配置适配器：

Hector::Identity.adapter = MyIdentityAdapter.new(...)

MyIdentityAdapter 是一个类，其实例需要响应 authenticate(username, password, &block) 和 normalize(username) 方法。可以参考 lib/hector/yaml_identity_adapter.rb 中的示例。

3.2 配置服务器地址和端口

可以在 init.rb 文件中配置服务器的监听地址和端口：

Hector.server_address = "111.222.333.444"
Hector.port = 9000
Hector.ssl_port = 9001
Hector.ssl_certificate_path = Hector.root.join("config/hector.crt")
Hector.ssl_certificate_key_path = Hector.root.join("config/hector.key")

3.3 使用 em-synchrony

如果需要使用 em-synchrony，可以在 init.rb 中引入：

require "em-synchrony"

Hector 将使用 EventMachine.synchrony 启动 EventMachine 的运行循环。

4. 项目安装方式

4.1 通过 RubyGems 安装

使用以下命令通过 RubyGems 安装 Hector：

$ gem install -r hector

4.2 手动安装

可以从 GitHub 项目页面下载源代码，然后手动安装依赖并运行：

$ git clone https://github.com/sstephenson/hector.git
$ cd hector
$ bundle install
$ rake install

4.3 创建和启动服务器

安装完成后，按照上述步骤创建服务器并启动守护进程。

---

通过以上文档，您应该能够顺利安装、配置和使用 Hector 项目。如有任何问题，请参考项目 Wiki 或联系项目维护者。