Revise README for clarity and formatting

Updated README to improve clarity and fix formatting issues.
This commit is contained in:
engigu
2025-12-26 10:28:13 +08:00
committed by GitHub
parent 38d8a3715d
commit a6346aae8d
+23 -19
View File
@@ -1,8 +1,8 @@
# 白虎面板 🐯
# 白虎面板
白虎面板是一个轻量级定时任务管理系统,基于`Go` + `Vue3`构建,`docker`或者`docker-compose`,内置`python3``nodejs`环境,开箱即用。
白虎面板是一个轻量级定时任务管理系统,基于`Go`+`Vue3`构建,`docker`或者`docker-compose`,内置`python3``nodejs``bash`环境,开箱即用。
## 项目缘起 💡
## 项目来由
多少和青龙面板有点关系,我自己也是青龙面板的使用者,但是现在的青龙面板性能我觉得有点难以接受。以我自己的使用(`机器1C2G`)为例,一个`python``requests`脚本每隔`30s`执行一次,有时候cpu执行的时候能跳变到`50%`以上。可以看看下面gif图片(如果不动,点击图片查看)
@@ -10,22 +10,22 @@
我觉得一个内存和性能占用低的面板更合适自己,所以做了这个项目。
如果你和我一样需要管理多个定时任务、脚本文件、简洁的 Web 界面、支持 Cron 表达式调度、在线终端、脚本编辑、环境变量管理等功能,并希望有一个性能和内存占用低的定时面板,这个项目你可以体验下。
如果你和我一样需要一个性能和内存占用低的定时面板,这个项目你可以体验下。
同样的定时场景和代码,这个项目的情况如下(cpu执行定时跳变不超过`20%`):
![baihu.gif](https://f.pz.al/pzal/2025/12/24/f0d171f9a686d.gif)
## 特色
## 特色
- 🔄 **轻量级:** 单文件部署,无需复杂配置,开箱即用
- 📋 **任务调度:** 支持标准 Cron 表达式,常用时间规则快捷选择
- 📝 **脚本管理:** 在线代码编辑器,支持文件上传、压缩包解压
- 🖥️ **在线终端:** WebSocket 实时终端,命令执行结果实时输出
- 🔐 **环境变量:** 安全存储敏感配置,任务执行时自动注入
- 🎨 **现代 UI** 响应式设计,深色/浅色主题切换
- **轻量级:** docker/compose部署,无需复杂配置,开箱即用
- **任务调度:** 支持标准 Cron 表达式,常用时间规则快捷选择
- **脚本管理:** 在线代码编辑器,支持文件上传、压缩包解压
- **在线终端:** WebSocket 实时终端,命令执行结果实时输出
- **环境变量:** 安全存储敏感配置,任务执行时自动注入
- **现代 UI:** 响应式设计,深色/浅色主题切换
## 功能特性 📋
## 功能特性
<details>
<summary><b>点击展开查看详细功能</b></summary>
@@ -69,12 +69,12 @@
</details>
## 效果图 📺
## 效果图
![baihu-display.gif](https://raw.githubusercontent.com/engigu/resources/refs/heads/images/baihu-display.gif)
<!-- TODO: 添加效果图 -->
## 快速开始 🚀
## 快速部署
<details>
<summary><b>方式一:环境变量部署(推荐)</b></summary>
@@ -221,9 +221,9 @@ services:
**默认账号:** `admin` / `123456`
> ⚠️ 首次登录后请立即修改默认密码
> 首次登录后请立即修改默认密码
## 目录结构 📁
## 目录结构
```
./
@@ -250,7 +250,7 @@ services:
> 通过挂载 `./envs:/app/envs` 可以持久化 Python 和 Node.js 环境,避免每次重启容器都重新安装依赖。
## 配置说明 ⚙️
## 配置说明
<details>
<summary><b>点击展开查看配置详情</b></summary>
@@ -310,10 +310,14 @@ table_prefix = baihu_
</details>
## 贡献 🤝
#### 关于推送
面板现在没有推送功能,还在考虑方式,但是现在有很多现成的消息聚合面板(这里自荐下自己的另一个项目[Message-Push-Nest](https://github.com/engigu/Message-Push-Nest)),如果大家有合适的方式可以提交Issue。
## 贡献
欢迎提交 Issue 和 Pull Request
## 许可证 📄
## 许可证
[MIT License](LICENSE)