https://github.com/rainbend/frp-notify
一个专注于消息通知的 frp server manager plugin 实现，让你对进入 frps 的连接了如指掌。
https://github.com/rainbend/frp-notify
frp frp-server-manager golang notification
Last synced: about 2 months ago
JSON representation
一个专注于消息通知的 frp server manager plugin 实现，让你对进入 frps 的连接了如指掌。
- Host: GitHub
- URL: https://github.com/rainbend/frp-notify
- Owner: arugal
- License: apache-2.0
- Created: 2020-04-01T05:45:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T07:24:51.000Z (almost 2 years ago)
- Last Synced: 2024-11-26T05:52:00.554Z (11 months ago)
- Topics: frp, frp-server-manager, golang, notification
- Language: Go
- Homepage:
- Size: 446 KB
- Stars: 123
- Watchers: 6
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## frp-notify
[](https://github.com/arugal/frp-notify/actions?query=branch%3Amaster+event%3Apush+workflow%3ABuild)
一个专注于消息通知的 [frp server manager plugin](https://github.com/fatedier/frp/blob/master/doc/server_plugin_zh.md) 实现，让你对进入 `frps` 的连接了如指掌，不再裸奔。
## 快速启动
[下载地址](https://github.com/arugal/frp-notify/releases)
### 目录介绍
```bash
* frp-notify
└─── system
| | frp-notify.service # linux 系统服务配置文件
|
│ frp-notify # frp-notify 程序
| frp-notify.json # 通知插件配置文件
```
### 打印帮助信息
```bash
./frp-notify --help
```
### 命令行启动
```bash
./frp-notify start -c /etc/frp-notify/frp-notify.json -b 127.0.0.1:50080
```
## 配置介绍
### frps
在 `frps.ini` 增加以下配置
```
[plugin.frp-notify]
addr = 127.0.0.1:50080 // frp-notify 地址
path = /handler // frp-notify url, 固定配置
ops = Login,NewProxy,NewWorkConn,NewUserConn // 通知的操作
```
### 黑白名单配置（`IP` 过滤）
先判断白名单，后判断黑名单。仅对 `NewUserConn` 有效 (**黑白名单配置支持热加载**)。
```json
{
"blacklist": [ // 黑名单
"127.0.0.1"
],
"whitelist": [ // 白名单
"127.0.0.1"
],
"notify_plugins": [
...
]
}
```
### 通知插件配置
插件列表：
1. [log](#log)
1. [dingTalk](#dingtalk)
1. [wxwork](#wxwork)
1. [飞书](#飞书)
1. [gotify](#gotify)
在 `frp-notify.json` 文件中按需配置通知插件，支持同时配置多个插件。
#### log
将消息打印到控制台，用于调试。
```json
{
"notify_plugins": [
{
"name": "log", // 固定配置
"config": {}
}
]
}
```
#### dingTalk
将消息发送到钉钉。
```json
{
"notify_plugins": [
{
"name": "dingTalk", // 固定配置
"config": {
"token": "df54651465c1189b76fd13f910b76bed361f8fff31bf9118b1896bc148500000", // dingTalk 自定义机器人 token
"secret": "SEC97d8a209f9ddda25b89d63d82a0b2ad4065504cbe4bc043719fbb1a0000000", // dingTalk 自定义机器人 secret
"is_at_all": true // 发送消息时是否@所有人
}
}
]
}
```
#### wxwork
将消息发送到企业微信。
```json
{
"notify_plugins": [
{
"name": "wxwork",
"config": {
"corp_id": "ww123456789",
"corp_secret": "UK__xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"agent_id": 12345678,
"to_user": [],
"to_party": [],
"to_tag": [],
"filter_regexp": ".*"
}
}
]
}
```
#### 飞书
将消息发送到飞书
```json
{
"notify_plugins": [
{
"name": "lark",
"config": {
"webhook_url": "",
"secret": "",
"at_users": []
}
}
]
}
```
#### gotify
将消息发送到 [gotify-server](https://github.com/gotify/server)。
```json
{
"notify_plugins": [
{
"name": "gotify", // 固定配置
"config": {
"server_proto": "http", // gotify-server 上报协议
"server_addr": "127.0.0.1:40080", // gotify-server 服务地址
"app_token": "token" // gotify-server 配置的 app token
}
}
]
}
```
