Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boris1993/qinglong-bot
通过机器人webhook更新青龙中的环境变量
https://github.com/boris1993/qinglong-bot
bot qinglong typescript webhook
Last synced: 19 days ago
JSON representation
通过机器人webhook更新青龙中的环境变量
- Host: GitHub
- URL: https://github.com/boris1993/qinglong-bot
- Owner: boris1993
- License: mit
- Created: 2024-06-15T15:46:10.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-09-08T16:20:13.000Z (2 months ago)
- Last Synced: 2024-10-11T13:45:52.939Z (about 1 month ago)
- Topics: bot, qinglong, typescript, webhook
- Language: TypeScript
- Homepage:
- Size: 129 KB
- Stars: 29
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
通过机器人更新青龙中的环境变量
---
迫于美团脚本的cookie经常过期，而想起更新的时候我通常访问不到自己服务器上的青龙面版，于是开发了这个工具来通过机器人来更新。
## 目前支持的机器人
- 钉钉群聊自定义机器人
- Telegram机器人
## 配置和部署
### 获得青龙的Client ID和Client Secret
- 前往青龙面板的`系统设置`->`应用设置`页面，创建一个新应用并赋予`环境变量`和`定时任务`权限
- 创建成功后，分别点击Client ID列和Client Secret列的复制图标，得到青龙的Client ID和Client Secret
### 创建和添加机器人
#### 钉钉
- 进入[钉钉管理后台](https://oa.dingtalk.com/)并创建一个组织，因为默认的`淘系技术部开放平台虚拟企业`我们没有管理员权限，不能创建应用
- 使用刚创建的组织登陆[钉钉开放平台](https://open.dingtalk.com/)
- 进入开发者后台的`应用开发`页面，点击`创建应用`，填写`应用名称`和`应用描述`，点击`保存`
- 在`添加应用能力`页面添加`机器人`，打开`机器人配置`的开关并填写需要的内容，`机器人消息预览图`
随便传个图片就行，`消息接收模式`选`Stream模式`，然后点击`发布`
- 进入`版本管理与发布`页面，点击`创建新版本`，`版本描述`随便写点什么就行，点击`保存`然后点击`直接发布`
- 进入`凭证与基础信息`页面，在`应用凭证`面版中分别点击`Client ID`和`Client Secret`的复制按钮即可得到机器人的Client
ID和Client Secret
- 进入钉钉客户端，选择组织默认的全员群或创建一个群，点击右上角的`群设置`，点击`机器人`，然后点击`添加机器人`
，在搜索框中搜索刚刚创建的应用的名字，然后跟随指引添加
#### Telegram
- 使用`BotFather`机器人创建一个Bot，按要求回复各个问题，最后记下bot token备用
- 关注这个刚刚创建的Bot，发送`/start`命令开始使用
### 部署
如果你访问Docker
Hub有困难，那么也可以换成托管在阿里云的镜像`registry.cn-hangzhou.aliyuncs.com/boris1993/qinglong-bot`。
#### 配置参数
- 必填（如填写不完整则本应用会拒绝启动）
- QINGLONG_URL：青龙的URL，如`http://127.0.0.1:5700`
- QINGLONG_CLIENT_ID：青龙的Client ID
- QINGLONG_CLIENT_SECRET：青龙的Client Secret
- 钉钉机器人（如填写不完整，则不会启用钉钉机器人）
- DINGTALK_CLIENT_ID：钉钉机器人的Client ID
- DINGTALK_CLIENT_SECRET：钉钉机器人的Client Secret
- Telegram机器人
- TG_BOT_TOKEN：Telegram机器人的bot token（如不填写则不会启用Telegram机器人）
- TG_PROXY：用于访问Telegram的HTTP代理地址，如果你能直接连接Telegram那么这个可以不填
- TG_API_ROOT：自定义Telegram API的域名，默认为`https://api.telegram.org`
#### Docker
```shell
docker run -d --restart always \
-e QINGLONG_URL=<青龙的URL，如http://127.0.0.1:5700> \
-e QINGLONG_CLIENT_ID=<青龙的Client ID> \
-e QINGLONG_CLIENT_SECRET=<青龙的Client Secret> \
-e DINGTALK_CLIENT_ID=<钉钉机器人的Client ID> \
-e DINGTALK_CLIENT_SECRET=<钉钉机器人的Client Secret> \
-e TG_BOT_TOKEN= \
-e TG_PROXY=<用于访问Telegram的HTTP代理地址> \
-e TG_API_ROOT=<自定义Telegram API域名> \
-p 3000:3000 \
--name qinglong-bot \
boris1993/qinglong-bot:latest
```
#### Docker Compose
```yaml
---
version: '3'
services:
qinglong-bot:
image: boris1993/qinglong-bot:latest
container_name: qinglong-bot
restart: always
environment:
TZ: Asia/Shanghai
QINGLONG_URL: <青龙的URL，如http://127.0.0.1:5700>
QINGLONG_CLIENT_ID: <青龙的Client ID>
QINGLONG_CLIENT_SECRET: <青龙的Client Secret>
DINGTALK_CLIENT_ID: <钉钉机器人的Client ID>
DINGTALK_CLIENT_SECRET: <钉钉机器人的Client Secret>
TG_BOT_TOKEN:
TG_PROXY: <用于访问Telegram的HTTP代理地址>
TG_API_ROOT: <自定义Telegram API域名>
ports:
- '3000:3000'
```
## 使用
### 支持的命令
| 命令 | 简单命令 | 格式 |
|----------|----------|------------------------------------|
| 获取所有环境变量 | env list | 获取所有环境变量 |
| 添加环境变量 | env add | 添加环境变量#环境变量名称=环境变量值（多个环境变量用英文逗号分割） |
| 更新环境变量 | env put | 更新环境变量#环境变量名称=环境变量值 |
| 删除环境变量 | env del | 删除环境变量#环境变量ID（多个环境变量ID用英文逗号分割）|
| 获取所有任务 | cron list | 获取所有任务 |
| 运行任务 | cron run | 运行任务#定时任务名称 |
| 获取任务日志 | cron log | 获取任务日志#定时任务名称 |
### 用法
| 客户端 | 说明 |
|----------|-----------------------------|
| 钉钉 | 在添加好机器人后，通过在群里at这个机器人的方式来操作 |
| Telegram | 直接向机器人发送命令即可 |
## 许可协议
该软件依照[MIT](LICENSE)协议开放源代码。