docs: globally rename panel name to baihu-panel and refactor linux dependencies guide
This commit is contained in:
+8
-8
@@ -1,6 +1,6 @@
|
||||
# 前端定制 (WebUI)
|
||||
|
||||
白虎面板支持完全接管和替换默认系统面板界面。你可以开发自己专属的前端主题,甚至添加自定义的前端交互功能,并打包为独立的 WebUI 资源包上传至系统应用。
|
||||
baihu-panel支持完全接管和替换默认系统面板界面。你可以开发自己专属的前端主题,甚至添加自定义的前端交互功能,并打包为独立的 WebUI 资源包上传至系统应用。
|
||||
|
||||
> [!IMPORTANT]
|
||||
> **安全与一致性维护声明**:
|
||||
@@ -21,7 +21,7 @@
|
||||
> 自定义前端包若存在 Bug 或打包不完整可能导致界面白屏。如果不慎应用了错误或不兼容的包,请使用下方命令行工具恢复。
|
||||
|
||||
### 2. 命令行 (CLI) 运维
|
||||
当界面因异常白屏无法访问时,可以进入白虎面板容器/服务器终端,使用 `baihu webui` 命令一键管理或恢复:
|
||||
当界面因异常白屏无法访问时,可以进入baihu-panel容器/服务器终端,使用 `baihu webui` 命令一键管理或恢复:
|
||||
|
||||
- **一键恢复默认内置界面**:
|
||||
```bash
|
||||
@@ -44,7 +44,7 @@
|
||||
|
||||
## 开发自定义前端
|
||||
|
||||
白虎面板的前端架构是完全解耦的。你可以选择以下两种方式之一来定制专属前端:
|
||||
baihu-panel的前端架构是完全解耦的。你可以选择以下两种方式之一来定制专属前端:
|
||||
|
||||
### 方式一:基于现有代码二次开发(推荐)
|
||||
如果你只是想修改部分样式、布局,或者在原有功能基础上增加新特性,最简单的方式是 **Fork `baihu-panel` 项目**。
|
||||
@@ -55,7 +55,7 @@
|
||||
### 方式二:从零开始全新开发
|
||||
如果你想用自己熟悉的技术栈(如 React, Angular,或者是纯静态的 HTML/JS)完全重写整个面板,这也是完全支持的!你只需要按照下方的核心规范进行开发和打包即可。
|
||||
### 1. 核心校验规则
|
||||
白虎面板后端提取并启用前端资源时,会执行以下强校验:
|
||||
baihu-panel后端提取并启用前端资源时,会执行以下强校验:
|
||||
1. **压缩包根目录下必须包含 `index.html`**:作为单页应用 (SPA) 的静态入口文件。
|
||||
2. **压缩包根目录下必须包含 `uimanifest.json`**:声明该前端包的元数据信息。
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
"name": "custom-neon-theme",
|
||||
"version": "1.0.2",
|
||||
"author": "YourName",
|
||||
"description": "白虎面板霓虹暗黑风定制前端主题",
|
||||
"description": "baihu-panel霓虹暗黑风定制前端主题",
|
||||
"min_panel_version": "1.0.0"
|
||||
}
|
||||
```
|
||||
@@ -78,7 +78,7 @@
|
||||
在独立开发自定义前端时,需要配置请求与后端的通信地址及代理:
|
||||
|
||||
- **后端默认服务地址与端口**:
|
||||
白虎面板后端服务默认运行在端口 `8052` 上,本地调试 API 的基础 URL 通常为:
|
||||
baihu-panel后端服务默认运行在端口 `8052` 上,本地调试 API 的基础 URL 通常为:
|
||||
`http://127.0.0.1:8052/api/v1`
|
||||
|
||||
- **本地开发环境代理配置(以 Vite 为例)**:
|
||||
@@ -88,7 +88,7 @@
|
||||
server: {
|
||||
proxy: {
|
||||
'/api/v1': {
|
||||
target: 'http://127.0.0.1:8052', // 本地运行的白虎面板后端地址
|
||||
target: 'http://127.0.0.1:8052', // 本地运行的baihu-panel后端地址
|
||||
changeOrigin: true
|
||||
}
|
||||
}
|
||||
@@ -116,7 +116,7 @@
|
||||
|
||||
## 打包前端资源包(现成)
|
||||
|
||||
你可以利用白虎面板项目自带的 `Makefile` 脚本,在现在的前端页面进行修改,将开发好的前端项目快速编译打包成标准的 `.tar.gz` 前端资源包, 自己使用或者分享使用。
|
||||
你可以利用baihu-panel项目自带的 `Makefile` 脚本,在现在的前端页面进行修改,将开发好的前端项目快速编译打包成标准的 `.tar.gz` 前端资源包, 自己使用或者分享使用。
|
||||
|
||||
### 使用 Makefile 打包
|
||||
|
||||
|
||||
Reference in New Issue
Block a user