Skip to content

Commit f0e2af7

Browse files
authored
Update README.md
1 parent 017c222 commit f0e2af7

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
> [!CAUTION]
2-
> #### 注:CPA 上游已于 [v6.10.0](https://github.com/router-for-me/CLIProxyAPI/releases/tag/v6.10.0) 正式去除 `/usage` 接口,若继续使用本项目追踪使用数据,请一并配置 [adapter.js](#cpa-近端适配器adapterjs)
2+
> #### 注:CPA 上游已于 [v6.10.0](https://github.com/router-for-me/CLIProxyAPI/releases/tag/v6.10.0) 正式去除 `/usage` 接口,若希望继续使用本项目追踪使用数据,请一并配置 [adapter.js](#cpa-近端适配器adapterjs)
33
> 或者回退 v6.9.49 或更早版本。
44
55

@@ -66,14 +66,23 @@
6666

6767
由于 CPA 新版已移除 `/usage` 接口,可将 [adapter.js](adapter.js) 部署在 CPA 近端,实现从 CPA Redis 队列聚合 usage,还原接口功能,再自动提供给本项目的 `/api/sync` 拉取。
6868

69-
迁移时可在看板配置 `USAGE_API_BASE_URL=http://adapter-host:36871` 以正常使用看板的同步功能,同时保持对原管理接口的访问。
69+
部署脚本时可以添加反代以正常使用看板的同步功能,同时保持对原管理接口的访问。
7070

71-
`adapter-host` 一般为 CPA 部署服务器 IP 。
71+
```
72+
your.domain {
73+
reverse_proxy /usage* localhost:36871
74+
reverse_proxy /v0/management/usage* localhost:36871
75+
76+
reverse_proxy * localhost:8317
77+
}
78+
```
79+
80+
或者在看板配置 `USAGE_API_BASE_URL=http://adapter-host:36871``adapter-host` 一般为 CPA 部署服务器 IP 。
7281

7382
```
7483
curl -L -o adapter.js https://github.com/sxjeru/CLIProxyAPI-Monitor/raw/refs/heads/main/adapter.js
7584
npm install ioredis
76-
node adapter.js
85+
# node adapter.js
7786
7887
# 推荐使用 PM2
7988
npm install -g pm2
@@ -103,8 +112,8 @@ pm2 start adapter.js --name cpa-adapter
103112
| 环境变量 | 说明 | 默认值 |
104113
|---|---|---|
105114
| `ENABLE_PERIODIC_SYNC` | 是否启用内置定时 sync | `false` |
106-
| `DASHBOARD_URL` | 远端看板地址,如 `https://your-domain.com` ||
107-
| `SYNC_TOKEN` | 远端看板 `/api/sync` 的 Bearer token,建议填看板的 `CRON_SECRET``PASSWORD` ||
115+
| `DASHBOARD_URL` | Vercel 部署看板地址,如 `https://your-domain.com` ||
116+
| `SYNC_TOKEN` | 远端看板 `/api/sync` 的 Bearer token,一般填前述 `CRON_SECRET``PASSWORD` ||
108117
| `SYNC_INTERVAL` | 定时触发 `/api/sync` 的间隔(毫秒) | `600000` |
109118
| `SYNC_TIMEOUT_MS` | 单次 sync 超时(毫秒) | `300000` |
110119
| `SYNC_ON_START` | 启动后是否立即触发一次 sync | `false` |

0 commit comments

Comments
 (0)