RocketChat Hubot Adapter 使用教程

RocketChat Hubot Adapter 使用教程

1. 项目的目录结构及介绍

RocketChat Hubot Adapter 项目的目录结构如下：

hubot-rocketchat/
├── bin/
│   └── hubot
├── docs/
├── scripts/
├── src/
├── test/
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• bin/: 包含启动脚本 hubot。
• docs/: 包含项目文档。
• scripts/: 包含自定义脚本。
• src/: 包含源代码。
• test/: 包含测试文件。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 hubot。这个文件是用来启动 Hubot 实例的脚本。你可以通过以下命令来启动 Hubot：

bin/hubot

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和环境变量。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键部分：

{
  "name": "hubot-rocketchat",
  "version": "1.0.0",
  "description": "Rocket Chat Hubot adapter",
  "main": "src/adapter.js",
  "scripts": {
    "start": "bin/hubot"
  },
  "dependencies": {
    "hubot": "^3.3.2",
    "rocketchat-node": "^1.0.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 入口文件。
• scripts: 脚本命令，例如 start 命令用于启动 Hubot。
• dependencies: 项目依赖。

环境变量

Hubot 和 RocketChat 的集成需要一些环境变量来配置。以下是一些关键的环境变量：

ROCKETCHAT_URL=<your rocketchat instance>:<port>
ROCKETCHAT_ROOM='general'
ROCKETCHAT_USER=bot
ROCKETCHAT_PASSWORD=bot
HUBOT_NAME=bot
EXTERNAL_SCRIPTS=hubot-help,hubot-diagnostic

• ROCKETCHAT_URL: RocketChat 实例的 URL 和端口。
• ROCKETCHAT_ROOM: 默认的聊天室。
• ROCKETCHAT_USER: 机器人用户名。
• ROCKETCHAT_PASSWORD: 机器人密码。
• HUBOT_NAME: 机器人名称。
• EXTERNAL_SCRIPTS: 外部脚本。

通过设置这些环境变量，你可以配置 Hubot 与 RocketChat 的集成。