Skip to content

Commit e32f89c

Browse files
committed
docs: remove deprecated channel management docs and add new ones
- Removed outdated New API and Octopus channel management documentation across all languages (en/ja/zh) - Added comprehensive self-hosted site management documentation in all supported languages - Added model list and price comparison documentation in all languages - Updated all references to channel management in existing documentation to point to the new self-hosted site management docs - Updated navigation menus in VuePress config to reflect new documentation structure
1 parent 0c947bc commit e32f89c

46 files changed

Lines changed: 806 additions & 1033 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/docs/.vuepress/config.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ export default defineUserConfig({
7272
children: [
7373
'/balance-history',
7474
'/usage-analytics',
75+
'/model-list',
7576
'/auto-refresh',
7677
]
7778
},
@@ -98,9 +99,8 @@ export default defineUserConfig({
9899
text: '🛠️ 站长管理工具',
99100
collapsible: true,
100101
children: [
101-
'/new-api-model-sync',
102-
'/new-api-channel-management',
103-
'/octopus-channel-management',
102+
'/managed-site-model-sync',
103+
'/self-hosted-site-management',
104104
'/model-redirect',
105105
]
106106
},
@@ -153,6 +153,7 @@ export default defineUserConfig({
153153
children: [
154154
'/en/balance-history',
155155
'/en/usage-analytics',
156+
'/en/model-list',
156157
'/en/auto-refresh',
157158
]
158159
},
@@ -179,9 +180,8 @@ export default defineUserConfig({
179180
text: '🛠️ Admin Management',
180181
collapsible: true,
181182
children: [
182-
'/en/new-api-model-sync',
183-
'/en/new-api-channel-management',
184-
'/en/octopus-channel-management',
183+
'/en/managed-site-model-sync',
184+
'/en/self-hosted-site-management',
185185
'/en/model-redirect',
186186
]
187187
},
@@ -234,6 +234,7 @@ export default defineUserConfig({
234234
children: [
235235
'/ja/balance-history',
236236
'/ja/usage-analytics',
237+
'/ja/model-list',
237238
'/ja/auto-refresh',
238239
]
239240
},
@@ -260,9 +261,8 @@ export default defineUserConfig({
260261
text: '🛠️ 管理者向けツール',
261262
collapsible: true,
262263
children: [
263-
'/ja/new-api-model-sync',
264-
'/ja/new-api-channel-management',
265-
'/ja/octopus-channel-management',
264+
'/ja/managed-site-model-sync',
265+
'/ja/self-hosted-site-management',
266266
'/ja/model-redirect',
267267
]
268268
},

docs/docs/api-credential-profiles.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,24 +70,37 @@
7070
- **OpenAI Billing**:适合标准 OpenAI Billing 查询。
7171
- **Sub2API**:适合 Sub2API 风格接口。
7272
- **Custom Read-only Endpoint**:适合站点有自定义只读查询接口。
73-
- **Disabled(禁用)**:不查询余额与用量,只保留凭证本身。
73+
- `Disabled(禁用)`:不查询余额与用量,只保留凭证本身。
74+
75+
### 详细遥测指标
76+
77+
开启遥测后,插件会尝试获取以下指标:
78+
- **实时余额** (Balance)
79+
- **今日花费** (Today Cost)
80+
- **今日请求数** (Today Requests)
81+
- **今日 Prompt/Completion Tokens**
82+
- **总已用/总赠送/总可用额度**
83+
- **过期时间** (Expires At)
7484

7585
### 自定义只读查询
7686

7787
如果自动方式不适配当前站点,可改用自定义只读查询:
7888

7989
1. 选择 **`Custom Read-only Endpoint`**
80-
2. 填写查询地址。
81-
3. 配置返回 JSON 中各字段的路径映射。
90+
2. 填写查询地址(必须与 `Base URL` 同源,支持 `/usage` 这种根相对路径)。
91+
3. **配置字段映射**:支持为上述所有遥测指标配置 JSON Path。
92+
- JSON Path 采用点分隔形式,例如 `data.today_total_tokens`
93+
- 插件会自动解析并将其转换为统一的展示格式。
94+
95+
## 稳定性与频率限制
8296

83-
限制如下
97+
为了保护你的账号不被上游站点判定为异常调用,All API Hub 内置了**智能频率限制器**
8498

85-
- 只允许当前 `Base URL` 同源下的只读 GET 地址。
86-
- 查询地址可以写成根相对路径,例如 `/usage`,也可以写完整同源 URL。
87-
- JSON Path 采用点分隔字段形式,例如 `data.balance`
88-
- 至少需要配置一个可解析的字段映射。
99+
- **并发控制**:默认限制对单个站点的并发请求数为 2。
100+
- **速率控制**:限制对单个站点的请求速率约为每分钟 18 次(支持小规模突发)。
101+
- **自动排队**:当刷新多个账号或执行批量验证时,超出限制的请求会自动进入排队序列,避免触发 429 Too Many Requests 错误。
89102

90-
这类配置适合“站点不是标准 New API / OpenAI Billing 返回格式,但你又希望在卡片上看余额和今日用量”的场景
103+
> 💡 **说明**:该限制主要针对插件后台的刷新和验证动作,不影响你通过其他工具(如 CherryStudio)直接调用接口的性能
91104
92105
## 常用操作
93106

docs/docs/changelog.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@
273273
- 密钥管理:新增 `所有账号` 视图,按账号分组聚合展示密钥,便于跨账号搜索与复制。
274274
- 模型重定向:新增 `清空模型重定向映射` 批量操作,可按渠道选择并二次确认后快速重置 `model_mapping`(不可撤销)。
275275
- **体验优化:**
276-
- New API 渠道管理:渠道列表中的 URL 支持点击跳转,并优化搜索体验。
276+
- 自建站点管理:渠道列表中的 URL 支持点击跳转,并优化搜索体验。
277277
- **问题修复:**
278278
- 渠道管理:修复渠道对话框中 `优先级` 提示文案不准确的问题。
279279
- 模型重定向:自动生成映射加入“版本守卫”,避免跨版本错误匹配。
@@ -437,7 +437,7 @@ v3.15.0 **对自动刷新配置做了强制修改**:
437437

438438
## 3.11.0
439439
- **新功能:**
440-
- New API 渠道管理:新增「重复渠道」提醒——当检测到已存在相同/相似渠道时,会弹出警告对话框,可选择继续创建或取消(不再用错误 Toast 阻止创建)。
440+
- 自建站点管理:新增「重复渠道」提醒——当检测到已存在相同/相似渠道时,会弹出警告对话框,可选择继续创建或取消(不再用错误 Toast 阻止创建)。
441441
- **问题修复:**
442442
- 账号管理:修复站点名称等文本过长导致布局溢出的问题,改为自动截断显示。
443443

docs/docs/cliproxyapi-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,5 @@
7878
## 相关文档
7979

8080
- [快速导出站点配置](./quick-export.md)
81-
- [New API 渠道管理](./new-api-channel-management.md)
82-
- [New API 模型列表同步](./new-api-model-sync.md)
81+
- [自建站点管理](./self-hosted-site-management.md)
82+
- [自建站点模型同步](./managed-site-model-sync.md)

docs/docs/cloudflare-helper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
- **IP 质量**:若连续无法通过,需要更换网络或在站点侧临时放宽防护;默认超时时间为 20 秒。
2222
- **弹窗权限**:请允许浏览器弹出窗口,否则插件无法创建临时标签页。
23-
- **重复挑战**:若频繁触发 429,可在 New API 渠道管理中调低速率或启用模型白名单,减少无效请求。
23+
- **重复挑战**:若频繁触发 429,可在 自建站点管理中调低速率或启用模型白名单,减少无效请求。
2424

2525
## 常见问题
2626

@@ -35,5 +35,5 @@
3535

3636
- [Cloudflare 防护与临时窗口降级(快速上手)](./get-started.md#cloudflare-window-downgrade)
3737
- [快速导出站点](./quick-export.md)
38-
- [New API 渠道管理](./new-api-channel-management.md)
38+
- [自建站点管理](./self-hosted-site-management.md)
3939
- [权限管理(可选权限)](./permissions.md)

docs/docs/en/api-credential-profiles.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,22 +72,35 @@ You can choose the balance/usage query method for each credential:
7272
- **Custom Read-only Endpoint**: Suitable for sites with custom read-only query endpoints.
7373
- **Disabled**: Does not query balance and usage, only retains the credential itself.
7474

75+
### Detailed Telemetry Metrics
76+
77+
After enabling telemetry, the extension will attempt to retrieve the following metrics:
78+
- **Real-time Balance**
79+
- **Today Cost**
80+
- **Today Requests**
81+
- **Today Prompt/Completion Tokens**
82+
- **Total Used/Total Granted/Total Available Quota**
83+
- **Expiration Time** (Expires At)
84+
7585
### Custom Read-only Query
7686

7787
If the automatic method is not compatible with the current site, you can use a custom read-only query:
7888

7989
1. Select **`Custom Read-only Endpoint`**.
80-
2. Enter the query address.
81-
3. Configure the path mapping for each field in the returned JSON.
90+
2. Enter the query address (must be from the same origin as the `Base URL`, supports root-relative paths like `/usage`).
91+
3. **Configure Field Mapping**: Supports configuring JSON Paths for all telemetry metrics mentioned above.
92+
- JSON Path uses a dot-separated format, e.g., `data.today_total_tokens`.
93+
- The extension will automatically parse and convert it into a unified display format.
94+
95+
## Stability and Rate Limiting
8296

83-
Limitations:
97+
To protect your account from being judged as abnormal by upstream sites, All API Hub has a built-in **Smart Request Limiter**:
8498

85-
- Only read-only GET endpoints from the same origin as the current `Base URL` are allowed.
86-
- The query address can be a root-relative path, e.g., `/usage`, or a complete same-origin URL.
87-
- JSON Path uses dot-separated fields, e.g., `data.balance`.
88-
- At least one resolvable field mapping must be configured.
99+
- **Concurrency Control**: Defaults to limiting the number of concurrent requests to a single site to 2.
100+
- **Rate Control**: Limits the request rate to a single site to approximately 18 times per minute (supports small bursts).
101+
- **Auto-Queueing**: When refreshing multiple accounts or performing batch verification, requests exceeding the limit will automatically enter a queue to avoid triggering 429 Too Many Requests errors.
89102

90-
This type of configuration is suitable for scenarios where "the site is not in the standard New API / OpenAI Billing return format, but you still want to see the balance and today's usage on the card."
103+
> 💡 **Note**: This limit is primarily for refresh and verification actions in the extension background and does not affect the performance of direct interface calls via other tools (such as CherryStudio).
91104
92105
## Common Operations
93106

docs/docs/en/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ This page records major updates for general users (feature changes / experience
273273
- Key Management: Added an `All Accounts` view, aggregating keys by account group for easier cross-account searching and copying.
274274
- Model Redirect: Added a `Clear Model Redirect Mappings` batch operation, allowing you to select by channel and confirm a quick reset of `model_mapping` (irreversible).
275275
- **Experience Optimizations:**
276-
- New API Channel Management: URLs in the channel list are now clickable and search experience has been optimized.
276+
- Self-Hosted Site Management: URLs in the channel list are now clickable and search experience has been optimized.
277277
- **Bug Fixes:**
278278
- Channel Management: Fixed an issue with inaccurate prompt copy for `Priority` in the channel dialog.
279279
- Model Redirect: Automatic mapping generation now includes a "version guard" to prevent cross-version mismatches.
@@ -436,7 +436,7 @@ v3.15.0 **has forcibly modified auto-refresh configurations**:
436436

437437
## 3.11.0
438438
- **New Features:**
439-
- New API Channel Management: Added "Duplicate Channel" reminder. When a duplicate/similar channel is detected, a warning dialog will pop up, allowing you to choose to continue creation or cancel (no longer blocking creation with error toasts).
439+
- Self-Hosted Site Management: Added "Duplicate Channel" reminder. When a duplicate/similar channel is detected, a warning dialog will pop up, allowing you to choose to continue creation or cancel (no longer blocking creation with error toasts).
440440
- **Bug Fixes:**
441441
- Account Management: Fixed layout overflow issues caused by excessively long text in site names, now automatically truncated.
442442

@@ -751,7 +751,7 @@ v3.15.0 **has forcibly modified auto-refresh configurations**:
751751

752752
## 2.13.0
753753
- **New Features:**
754-
- Added "New API Channel Management" functionality.
754+
- Added "Self-Hosted Site Management" functionality.
755755
- Added a "Warning" button style.
756756
- Introduced Radix UI components and Tanstack Table for improved interface aesthetics and functionality.
757757
- **Bug Fixes:**

docs/docs/en/cliproxyapi-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,5 @@
7878
## Related Documentation
7979

8080
- [Quick Export Site Configuration](./quick-export.md)
81-
- [New API Channel Management](./new-api-channel-management.md)
82-
- [New API Model List Synchronization](./new-api-model-sync.md)
81+
- [Self-Hosted Site Management](./self-hosted-site-management.md)
82+
- [Managed Site Model Synchronization](./managed-site-model-sync.md)

docs/docs/en/cloudflare-helper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
- **IP Quality**: If verification fails continuously, you need to change your network or temporarily relax protection on the site side; the default timeout is 20 seconds.
2222
- **Pop-up Permissions**: Please allow the browser to pop up windows, otherwise the plugin cannot create temporary tabs.
23-
- **Repeated Challenges**: If 429 is frequently triggered, you can lower the rate or enable a model whitelist in New API Channel Management to reduce invalid requests.
23+
- **Repeated Challenges**: If 429 is frequently triggered, you can lower the rate or enable a model whitelist in Self-Hosted Site Management to reduce invalid requests.
2424

2525
## Common Issues
2626

@@ -35,5 +35,5 @@
3535

3636
- [Cloudflare Protection and Temporary Window Degradation (Quick Start)](./get-started.md#cloudflare-window-downgrade)
3737
- [Quick Site Export](./quick-export.md)
38-
- [New API Channel Management](./new-api-channel-management.md)
38+
- [Self-Hosted Site Management](./self-hosted-site-management.md)
3939
- [Permission Management (Optional Permissions)](./permissions.md)

docs/docs/en/get-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,13 @@ Through these integration capabilities, you can synchronize the same upstream si
212212
- Supports filtering by site, account, Token, and date to view request volume, Token consumption, model distribution, expenses, and latency trends.
213213
- Suitable for answering questions like "Where have I used the most recently, spent the most, or which link is the slowest?"
214214

215-
### 5.10 New API Model List Synchronization
215+
### 5.10 Managed Site Model Synchronization
216216

217-
For detailed documentation on the New API model list synchronization feature, please refer to [New API Model List Synchronization](./new-api-model-sync.md).
217+
For detailed documentation on the New API model list synchronization feature, please refer to [Managed Site Model Synchronization](./managed-site-model-sync.md).
218218

219-
### 5.11 New API Channel Management (Beta)
219+
### 5.11 Self-Hosted Site Management (Beta)
220220

221-
Create/edit/delete channels directly within the extension. Combined with model whitelisting and single-channel synchronization debugging, this can significantly reduce the frequency of back-and-forth operations with the New API backend. Refer to [New API Channel Management](./new-api-channel-management.md) for detailed operations and precautions.
221+
Create/edit/delete channels directly within the extension. Combined with model whitelisting and single-channel synchronization debugging, this can significantly reduce the frequency of back-and-forth operations with the New API backend. Refer to [Self-Hosted Site Management](./self-hosted-site-management.md) for detailed operations and precautions.
222222

223223
<a id="cloudflare-window-downgrade"></a>
224224
### 5.12 Cloudflare Protection and Temporary Window Downgrade
@@ -241,8 +241,8 @@ Create/edit/delete channels directly within the extension. Combined with model w
241241
- [Automatic Refresh and Real-time Data](./auto-refresh.md)
242242
- [Automatic Check-in and Check-in Monitoring](./auto-checkin.md)
243243
- [WebDAV Backup and Automatic Synchronization](./webdav-sync.md)
244-
- [New API Model List Synchronization](./new-api-model-sync.md)
245-
- [New API Channel Management](./new-api-channel-management.md)
244+
- [Managed Site Model Synchronization](./managed-site-model-sync.md)
245+
- [Self-Hosted Site Management](./self-hosted-site-management.md)
246246
- [CLIProxyAPI Integration](./cliproxyapi-integration.md)
247247
- [Model Redirection](./model-redirect.md)
248248
- [Sorting Priority Settings](./sorting-priority.md)

0 commit comments

Comments
 (0)