Files
TaskPool/docs/guide/usage.md
T
admin e6956aa001 Initial commit: TaskPool React panel
- React frontend with route-level code splitting
- Backend rebranded from Baihu to TaskPool
- DB brand migration script and local compatibility
2026-07-26 08:43:52 +08:00

63 lines
3.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 功能特性
taskpool不仅提供基础的脚本执行功能,还集成了众多的实用工具和管理模块。
## 数据仪表
- **运行状态概览**:实时展示系统运行状态、任务执行统计及资源消耗。
- **动态图表**:通过直观的图表展示任务成功率、并发趋势及系统负载。
## 定时任务管理
- **标准 Cron 表达式**:支持高度灵活的调度配置。
- **控制台快捷键**:常用规则一键选择。
- **手动触发执行**:支持临时执行任务。
- **任务超时控制**:通过配置 `timeout` 参数,系统会自动隔离并中止长时间运行的任务。
## 远程分布式执行 (Agents)
- **子节点管理**:支持注册多个远程 Agent 节点,实现分布式任务分发。
- **跨平台支持**Agent 可部署在 Linux、Windows、macOS 等不同系统,覆盖异构执行环境。
## 脚本文件管理
- **在线代码编辑器**:集成了现代代码编辑器,支持语法高亮和编辑。
- **文件树形结构**:直观展示项目内所有文件。
- **文件上传与解压**:支持单文件、多文件上传和对 ZIP 压缩包的在线解压。
- **文件管理**:支持在线进行创建、重命名、移动和删除操作。
## 在线终端
- **WebSocket 实时终端**:支持常用的 Shell 命令。
- **命令输出实时推流**:实时查看脚本运行的物理设备输出。
## 执行日志
- **任务执行历史**:记录每次运行的状态(成功/失败/超时)。
- **执行耗时统计**:自动统计任务耗时,辅助性能优化。
- **日志压缩存储**:通过对旧日志进行自动清理和压缩,规避存储空间占用问题。
## 环境变量管理 (Secret)
- **机密性管理**:对敏感字段(如脚本 Key、DB 密码)进行脱敏显示和加密存储。
- **全局环境隔离**:在不同脚本运行期间动态注入,确保持久化和隔离。
## 消息推送与系统通知
- **原生内置分发**:集成了企业微信、钉钉、飞书、Telegram、Bark、邮件等十余种主流渠道。
- **多事件灵活通知**:您可以配置「任务失败」、「服务下线」、「登录安全报警」等事件通知条件。
- **API 示例**:系统自动生成各种编程语言的一键集成代码片段,方便用户脚本集成。
- **消息日志**:详细记录每条推送消息的状态、接收人和尝试发送的日志,方便故障排查。
## 仓库任务同步
- **青龙指令兼容**:支持直接粘贴 `ql repo` 指令快速创建同步任务。
- **脚本自动注册**:自动扫描同步目录下的脚本文件,解析其中的 `new Env()` 名称和 `cron` 表达式。
- **灵活筛选规则**:支持通过正则表达式配置白名单、黑名单,精确控制哪些脚本需要转化为面板任务。
- **版本控制集成**:基于 Git 进行增量同步,支持分支切换和稀疏检出(Sparse Checkout)。
## 系统设置
- **数据备份与恢复**:支持全量数据的本地导出和一键导入恢复。
- **页面设置**:自定义站点标题、标语和分页显示逻辑。