frp-notify 使用手册

frp-notify 使用手册

frp-notify 项目地址: https://gitcode.com/gh_mirrors/fr/frp-notify

项目目录结构及介绍

frp-notify 是一个专为 frp 设计的消息通知插件，帮助管理 frp 服务器时获取实时的通知信息。以下是其典型的项目目录结构：

frp-notify
├── system          # 包含系统相关的配置或服务文件，比如 Linux 系统服务配置
│   ├── frp-notify.service # Linux 下的服务配置文件
│   └── frp-notify        # 可执行程序
├── frp-notify.json # 主配置文件，用于设定通知插件的行为
└── ...

主要文件说明：

• frp-notify: 应用程序主体，负责处理frp事件并触发通知。
• frp-notify.json: 重要配置文件，指定通知规则和插件配置。
• system: 相关系统集成文件，例如Linux服务配置。

项目的启动文件介绍

启动 frp-notify 主要通过命令行进行，基础的启动方式如下：

/frp-notify start -c /path/to/frp-notify.json -b IP:Port

• start: 指令，表示启动服务。
• -c: 指定配置文件路径，这里应该是你的 frp-notify.json 的位置。
• -b IP:Port: 绑定监听的IP地址和端口，供frp服务器使用。

此启动命令假设你已经正确配置了 frp-notify.json 文件，并且frp服务器已正确设置了与之对接的配置。

项目的配置文件介绍

frp-notify.json 是核心配置文件，它决定了哪些事件将触发通知以及如何发送这些通知。下面简要说明其结构：

{
  "blacklist": [],    // 黑名单IP列表，阻止这些IP的连接通知
  "whitelist": [],    // 白名单IP列表，仅允许这些IP的连接通知
  "notify_plugins": [
    {
      "name": "log",     // 通知插件名称，如log、dingTalk等
      "config": []       // 对应插件的配置，如log为空或特定平台的Token等
    },
    // 可以配置更多插件
  ]
}

核心配置项解析

• blacklist & whitelist: 提供细粒度控制，可以配置IP过滤规则来决定哪些用户的连接不会触发通知。
• notify_plugins: 插件列表，每个元素代表一个通知方式。支持log(简单记录)，dingTalk(钉钉), wxwork(企业微信), lark(飞书), gotify等。每种插件都有特定的配置项，如DingTalk需要配置token和secret。

示例配置（以Gotify为例）

假设你想使用Gotify作为通知手段，配置示例可能如下：

{
  "notify_plugins": [
    {
      "name": "gotify",
      "config": [
        "server_proto": "http",
        "server_addr": "127.0.0.1:8080",
        "app_token": "your_app_token_here"
      ]
    }
  ]
}

确保替换上述配置中的your_app_token_here为你在Gotify服务器上创建应用得到的Token。

---

以上是关于frp-notify的基本使用指南，实际部署时还需依据具体场景调整配置，并结合frp的主配置文件进行相应的设置，以实现完整功能。记得，测试时检查所有网络通信是否畅通，以及插件配置是否正确无误。

frp-notify 项目地址: https://gitcode.com/gh_mirrors/fr/frp-notify