yu commited on
Commit
d0bfdc0
·
1 Parent(s): 46b8e9d

docs: 更新配置文档和README以反映新的端点结构

Browse files
Files changed (2) hide show
  1. .env.example +11 -3
  2. README.md +10 -10
.env.example CHANGED
@@ -8,12 +8,20 @@
8
  # API 访问密钥(可选,用于保护 API 端点)
9
  # API_KEY=your-secret-api-key-here
10
 
11
- # 路径前缀(必需,用于隐藏端点路径)
12
- PATH_PREFIX=your-random-path-prefix
 
 
13
 
14
- # 管理员密钥(必需,用于访问管理端点)
15
  ADMIN_KEY=your-admin-secret-key
16
 
 
 
 
 
 
 
17
  # 服务器完整 URL(可选,用于反代公开日志和图片 URL)
18
  # BASE_URL=https://your-domain.com
19
 
 
8
  # API 访问密钥(可选,用于保护 API 端点)
9
  # API_KEY=your-secret-api-key-here
10
 
11
+ # 路径前缀(可选,用于隐藏端点路径)
12
+ # 如果设置了,端点将为: /{PATH_PREFIX}/, /{PATH_PREFIX}/v1/
13
+ # 如果未设置,端点将为: /admin/, /v1/
14
+ # PATH_PREFIX=your-random-path-prefix
15
 
16
+ # 管理员密钥(必需,用于登录管理面板)
17
  ADMIN_KEY=your-admin-secret-key
18
 
19
+ # Session加密密钥(可选,自动生成)
20
+ # SESSION_SECRET_KEY=your-session-secret-key
21
+
22
+ # Session过期时间(可选,单位:小时,默认24小时)
23
+ # SESSION_EXPIRE_HOURS=24
24
+
25
  # 服务器完整 URL(可选,用于反代公开日志和图片 URL)
26
  # BASE_URL=https://your-domain.com
27
 
README.md CHANGED
@@ -253,15 +253,15 @@ ACCOUNTS_CONFIG='[
253
  | ---------------------------------------- | ------ | --------------------------- |
254
  | `/{PATH_PREFIX}/v1/models` | GET | 获取模型列表 |
255
  | `/{PATH_PREFIX}/v1/chat/completions` | POST | 聊天接口(需API_KEY) |
256
- | `/{PATH_PREFIX}/admin` | GET | 管理面板(需ADMIN_KEY) |
257
- | `/{PATH_PREFIX}/admin/accounts` | GET | 获取账户状态(需ADMIN_KEY) |
258
- | `/{PATH_PREFIX}/admin/accounts-config` | GET | 获取账户配置(需ADMIN_KEY) |
259
- | `/{PATH_PREFIX}/admin/accounts-config` | PUT | 更新账户配置(需ADMIN_KEY) |
260
- | `/{PATH_PREFIX}/admin/accounts/{id}` | DELETE | 删除指定账户(需ADMIN_KEY) |
261
- | `/{PATH_PREFIX}/admin/accounts/{id}/disable` | PUT | 禁用指定账户(需ADMIN_KEY) |
262
- | `/{PATH_PREFIX}/admin/accounts/{id}/enable` | PUT | 启用指定账户(需ADMIN_KEY) |
263
- | `/{PATH_PREFIX}/admin/log` | GET | 获取系统日志(需ADMIN_KEY) |
264
- | `/{PATH_PREFIX}/admin/log` | DELETE | 清空系统日志(需ADMIN_KEY) |
265
  | `/public/log/html` | GET | 公开日志页面(无需认证) |
266
  | `/public/stats` | GET | 公开统计信息(无需认证) |
267
  | `/public/stats/html` | GET | 实时状态监控页面(无需认证)|
@@ -488,7 +488,7 @@ curl -X POST http://localhost:7860/v1/v1/chat/completions \
488
 
489
  ### 1. 如何在线编辑账户配置?
490
 
491
- 访问管理面板 `/{PATH_PREFIX}/admin?key=YOUR_ADMIN_KEY`,点击"编辑配置"按钮:
492
  - ✅ 实时编辑 JSON 格式配置
493
  - ✅ 保存后立即生效,无需重启
494
  - ✅ 配置保存到 `accounts.json` 文件
 
253
  | ---------------------------------------- | ------ | --------------------------- |
254
  | `/{PATH_PREFIX}/v1/models` | GET | 获取模型列表 |
255
  | `/{PATH_PREFIX}/v1/chat/completions` | POST | 聊天接口(需API_KEY) |
256
+ | `/{PATH_PREFIX}` | GET | 管理面板(需ADMIN_KEY) |
257
+ | `/{PATH_PREFIX}/accounts` | GET | 获取账户状态(需ADMIN_KEY) |
258
+ | `/{PATH_PREFIX}/accounts-config` | GET | 获取账户配置(需ADMIN_KEY) |
259
+ | `/{PATH_PREFIX}/accounts-config` | PUT | 更新账户配置(需ADMIN_KEY) |
260
+ | `/{PATH_PREFIX}/accounts/{id}` | DELETE | 删除指定账户(需ADMIN_KEY) |
261
+ | `/{PATH_PREFIX}/accounts/{id}/disable` | PUT | 禁用指定账户(需ADMIN_KEY) |
262
+ | `/{PATH_PREFIX}/accounts/{id}/enable` | PUT | 启用指定账户(需ADMIN_KEY) |
263
+ | `/{PATH_PREFIX}/log` | GET | 获取系统日志(需ADMIN_KEY) |
264
+ | `/{PATH_PREFIX}/log` | DELETE | 清空系统日志(需ADMIN_KEY) |
265
  | `/public/log/html` | GET | 公开日志页面(无需认证) |
266
  | `/public/stats` | GET | 公开统计信息(无需认证) |
267
  | `/public/stats/html` | GET | 实时状态监控页面(无需认证)|
 
488
 
489
  ### 1. 如何在线编辑账户配置?
490
 
491
+ 访问管理面板 `/{PATH_PREFIX}?key=YOUR_ADMIN_KEY`,点击"编辑配置"按钮:
492
  - ✅ 实时编辑 JSON 格式配置
493
  - ✅ 保存后立即生效,无需重启
494
  - ✅ 配置保存到 `accounts.json` 文件