EMQX Webhook 项目教程

EMQX Webhook 项目教程

1. 项目目录结构及介绍

EMQX Webhook 项目的目录结构如下：

emqx-web-hook/
├── bin/
│   └── emqx_web_hook
├── etc/
│   └── emqx_web_hook.conf
├── lib/
│   └── emqx_web_hook-<version>.jar
├── priv/
│   └── emqx_web_hook.schema
├── src/
│   ├── emqx_web_hook_app.erl
│   ├── emqx_web_hook_handler.erl
│   └── ...
├── test/
│   └── ...
├── LICENSE
├── README.md
└── rebar.config

目录结构介绍

• bin/: 包含项目的启动脚本文件。
• etc/: 包含项目的配置文件。
• lib/: 包含项目的依赖库文件。
• priv/: 包含项目的私有文件，如配置模式文件。
• src/: 包含项目的源代码文件。
• test/: 包含项目的测试代码文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• rebar.config: 项目的构建配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 emqx_web_hook。该文件是一个启动脚本，用于启动 EMQX Webhook 服务。

启动文件介绍

• emqx_web_hook: 这是一个 Bash 脚本文件，用于启动 EMQX Webhook 服务。它包含了启动服务的命令和参数。

启动命令

./bin/emqx_web_hook start

该命令会启动 EMQX Webhook 服务，并加载配置文件中的设置。

3. 项目的配置文件介绍

项目的配置文件位于 etc/ 目录下，文件名为 emqx_web_hook.conf。该文件包含了 EMQX Webhook 服务的配置选项。

配置文件介绍

• emqx_web_hook.conf: 这是一个配置文件，用于配置 EMQX Webhook 服务的各项参数。

配置文件示例

## 配置文件示例

## Webhook URL
web.hook.url = http://localhost:8080/webhook

## 认证信息
web.hook.auth.username = admin
web.hook.auth.password = secret

## 日志级别
log.level = info

配置项说明

• web.hook.url: 指定 Webhook 的 URL，EMQX 会将事件数据发送到该 URL。
• web.hook.auth.username: 指定 Webhook 的认证用户名。
• web.hook.auth.password: 指定 Webhook 的认证密码。
• log.level: 指定日志的输出级别，可选值为 debug, info, warn, error。

通过修改配置文件，可以定制 EMQX Webhook 服务的行为。