Orion
c3437ae163
更新项目根目录 README.md 以更清晰地展示脚本集合架构，并为 Homebrew、Sub-Store 和 Telegram 模块新增详细的使用说明文档。 同时移除了 brew-upgrade-manager.sh 中的硬编码 sudo 密码，改为空字符串占位符以提升代码安全性。 - 增强根目录文档的可读性与结构 - 为每个子模块添加独立的 README.md - 修复脚本中的敏感信息泄露问题 (SUDO_PWD)
70 lines
2.4 KiB
Markdown
70 lines
2.4 KiB
Markdown
# Script Collection
|
||
|
||
一个面向日常自动化的小型脚本集合，当前包含 Homebrew 升级管理、Sub-Store 节点重命名处理、Telegram Bot Worker 三类脚本。
|
||
|
||
## 目录
|
||
|
||
```text
|
||
script/
|
||
├── homebrew/
|
||
│ ├── README.md
|
||
│ └── brew-upgrade-manager.sh
|
||
├── substore/
|
||
│ ├── README.md
|
||
│ └── sntp-rename.js
|
||
├── telegram/
|
||
│ ├── README.md
|
||
│ └── tg-bot.js
|
||
├── LICENSE
|
||
└── README.md
|
||
```
|
||
|
||
## 脚本概览
|
||
|
||
| 目录 | 脚本 | 用途 | 运行环境 |
|
||
| --- | --- | --- | --- |
|
||
| `homebrew/` | `brew-upgrade-manager.sh` | 自动更新 Homebrew、升级 Formula/Cask、清理缓存 | macOS、Bash、Homebrew |
|
||
| `substore/` | `sntp-rename.js` | 在 Sub-Store 代理节点名称中注入线路标签 | Sub-Store 脚本处理器 |
|
||
| `telegram/` | `tg-bot.js` | 基于 Cloudflare Workers 的 Telegram 私聊转发与管理后台 | Cloudflare Workers、D1、Telegram Bot |
|
||
|
||
## 快速开始
|
||
|
||
### Homebrew 升级
|
||
|
||
```bash
|
||
cd homebrew
|
||
chmod +x brew-upgrade-manager.sh
|
||
./brew-upgrade-manager.sh
|
||
```
|
||
|
||
如在非交互式终端运行，可指定输出宽度：
|
||
|
||
```bash
|
||
./brew-upgrade-manager.sh --width 130
|
||
HB_TERMINAL_WIDTH=130 ./brew-upgrade-manager.sh
|
||
```
|
||
|
||
详细配置见 [homebrew/README.md](homebrew/README.md)。
|
||
|
||
### Sub-Store 节点标签注入
|
||
|
||
把 [substore/sntp-rename.js](substore/sntp-rename.js) 作为 Sub-Store 节点处理脚本使用。默认会识别 `GTM`、`S1`、`S2`、`S3`、`S4`、`BGP`、`Anytls` 等关键词，并把标签插入到节点名末尾或 `- SNTP` 后缀之前。
|
||
|
||
详细规则见 [substore/README.md](substore/README.md)。
|
||
|
||
### Telegram Bot Worker
|
||
|
||
把 [telegram/tg-bot.js](telegram/tg-bot.js) 部署为 Cloudflare Worker，并绑定 Telegram Bot Token、管理员 ID、管理群 ID 和 D1 数据库。Worker 根路径用于健康检查，Telegram Webhook POST 到 Worker 地址。
|
||
|
||
详细部署说明见 [telegram/README.md](telegram/README.md)。
|
||
|
||
## 安全提示
|
||
|
||
- 不要把 Bot Token、Cloudflare 密钥、Telegram 群组 ID、管理员 ID 或 sudo 密码提交到公开仓库。
|
||
- `homebrew/brew-upgrade-manager.sh` 当前包含 `SUDO_PWD` 占位变量，若确需使用自动输入 sudo 密码，请只在本机私有副本中填写。
|
||
- Telegram Worker 会保存用户状态、消息映射和配置项到 D1，请按实际隐私要求控制数据库访问权限。
|
||
|
||
## 许可证
|
||
|
||
本项目使用 GNU Affero General Public License v3.0，详见 [LICENSE](LICENSE)。
|