Skip to content

Commit af413c9

Browse files
committed
mod(doc): support one key deploy
fix(doc): baidu pan vars
1 parent 13be6d1 commit af413c9

2 files changed

Lines changed: 73 additions & 66 deletions

File tree

README.md

Lines changed: 71 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -26,50 +26,8 @@
2626

2727
部署完成后,请登录[Cloudflare Worker后台](https://dash.cloudflare.com/),修改环境变量,请参考[变量说明](#变量说明)部分
2828

29-
### 手动部署
3029

31-
#### 克隆代码
32-
33-
```shell
34-
git clone https://github.com/OpenListTeam/OpenList-APIPages.git
35-
```
36-
37-
#### 修改配置
38-
39-
创建并修改`wrangler.jsonc`
40-
41-
```shell
42-
cp wrangler.example.jsonc wrangler.jsonc
43-
```
44-
45-
修改变量信息:
46-
- MAIN_URLS:部署回调地址的域名
47-
- 其他参数?:各个网盘的应用信息
48-
```
49-
"vars": {
50-
"MAIN_URLS": "api.example.com",
51-
"onedrive_uid": "*****************************",
52-
"onedrive_key": "*****************************",
53-
"alicloud_uid": "*****************************",
54-
"alicloud_key": "*****************************",
55-
"baiduyun_uid": "*****************************",
56-
"baiduyun_key": "*****************************",
57-
"baiduyun_ext": "*****************************",
58-
"cloud115_uid": "*****************************",
59-
"cloud115_key": "*****************************",
60-
"googleui_uid": "*****************************",
61-
"googleui_key": "*****************************",
62-
"yandexui_uid": "*****************************",
63-
"yandexui_key": "*****************************",
64-
"dropboxs_uid": "*****************************",
65-
"dropboxs_key": "*****************************",
66-
"quarkpan_uid": "*****************************",
67-
"quarkpan_key": "*****************************"
68-
},
69-
```
70-
71-
72-
### Docker部署
30+
### 容器部署
7331
#### 拉取镜像
7432
```
7533
docker pull openlistteam/openlist_api_server
@@ -132,29 +90,70 @@ docker run -d --name oplist-api-server \
13290
| `OPLIST_QUARKPAN_KEY` || string | 夸克云盘应用密钥 |
13391

13492

93+
### 边缘部署
94+
95+
#### 克隆代码
96+
97+
```shell
98+
git clone https://github.com/OpenListTeam/OpenList-APIPages.git
99+
```
100+
101+
#### 修改配置 (CloudFlare才需要)
102+
103+
创建并修改`wrangler.jsonc`
104+
105+
```shell
106+
cp wrangler.example.jsonc wrangler.encrypt.jsonc
107+
```
108+
109+
修改变量信息:
110+
- MAIN_URLS:部署回调地址的域名
111+
- 其他参数?:各个网盘的应用信息
112+
```
113+
"vars": {
114+
"MAIN_URLS": "api.example.com",
115+
"onedrive_uid": "*****************************",
116+
"onedrive_key": "*****************************",
117+
"alicloud_uid": "*****************************",
118+
"alicloud_key": "*****************************",
119+
"baiduyun_uid": "*****************************",
120+
"baiduyun_key": "*****************************",
121+
"baiduyun_ext": "*****************************",
122+
"cloud115_uid": "*****************************",
123+
"cloud115_key": "*****************************",
124+
"googleui_uid": "*****************************",
125+
"googleui_key": "*****************************",
126+
"yandexui_uid": "*****************************",
127+
"yandexui_key": "*****************************",
128+
"dropboxs_uid": "*****************************",
129+
"dropboxs_key": "*****************************",
130+
"quarkpan_uid": "*****************************",
131+
"quarkpan_key": "*****************************"
132+
},
133+
```
134+
135135
### 变量说明
136136

137-
| 变量名称 | 必要 | 变量类型 | 变量说明 |
138-
| -------------- | ---- | -------- | --------------------------------- |
137+
| 变量名称 | 必要 | 变量类型 | 变量说明 |
138+
| -------------- | ---- | -------- |--------------------------|
139139
| `MAIN_URLS` || string | 绑定主域名,示例:api.example.com |
140-
| `onedrive_uid` || string | OneDrive 客户端ID |
141-
| `onedrive_key` || string | OneDrive 客户端密钥 |
142-
| `alicloud_uid` || string | 阿里云盘开发者AppID |
143-
| `alicloud_key` || string | 阿里云盘开发者AppKey |
144-
| `baiduyun_uid` || string | 百度网盘应用密钥AppKey |
145-
| `baiduyun_key` || string | 百度网盘应用密钥SecretKey |
146-
| `baiduyun_ext` || string | 百度网盘应用ext |
147-
| `cloud115_uid` || string | 115网盘应用ID |
148-
| `cloud115_key` || string | 115网盘应用密钥 |
149-
| `googleui_uid` || string | 谷歌客户端ID |
150-
| `googleui_key` || string | 谷歌全局API Key |
151-
| `yandexui_uid` || string | Yandex应用ID |
152-
| `yandexui_key` || string | Yandex应用密钥 |
153-
| `dropboxs_uid` || string | Dropboxx应用ID |
154-
| `dropboxs_key` || string | Dropbox应用密钥 |
155-
| `quarkpan_uid` || string | 夸克云盘x应用ID |
156-
| `quarkpan_key` || string | 夸克云盘应用密钥 |
157-
140+
| `onedrive_uid` || string | OneDrive 客户端ID |
141+
| `onedrive_key` || string | OneDrive 客户端密钥 |
142+
| `alicloud_uid` || string | 阿里云盘开发者AppID |
143+
| `alicloud_key` || string | 阿里云盘开发者AppKey |
144+
| `baiduyun_uid` || string | 百度网盘应用ID |
145+
| `baiduyun_key` || string | 百度网盘应用密钥AppKey |
146+
| `baiduyun_ext` || string | 百度网盘应用密钥SecretKey |
147+
| `cloud115_uid` || string | 115网盘应用ID |
148+
| `cloud115_key` || string | 115网盘应用密钥 |
149+
| `googleui_uid` || string | 谷歌客户端ID |
150+
| `googleui_key` || string | 谷歌全局API Key |
151+
| `yandexui_uid` || string | Yandex应用ID |
152+
| `yandexui_key` || string | Yandex应用密钥 |
153+
| `dropboxs_uid` || string | Dropboxx应用ID |
154+
| `dropboxs_key` || string | Dropbox应用密钥 |
155+
| `quarkpan_uid` || string | 夸克云盘x应用ID |
156+
| `quarkpan_key` || string | 夸克云盘应用密钥 |
158157

159158

160159
#### 测试代码
@@ -163,10 +162,14 @@ docker run -d --name oplist-api-server \
163162
npm install
164163

165164
# 以Cloudflare Worker环境运行
166-
npm run dev-cf
165+
npm run dev-cf
167166

168167
# 以Edgeone Functions环境运行
169-
npm run dev-eo
168+
npm run dev-eo
169+
170+
# 以Node Service Work环境运行
171+
npm run dev-js
172+
170173
```
171174

172175
#### 部署项目
@@ -177,6 +180,9 @@ npm run deploy-cf
177180

178181
# 以Edgeone Functions环境部署
179182
npm run deploy-eo
183+
184+
# 以Node Service Work本地运行
185+
npm build-js && npm deploy-js
180186
```
181187

182188
## 接口文档

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
"scripts": {
44
"dev-js": "tsx watch src/basic.ts",
55
"build-js": "webpack --mode production",
6+
"deploy-js": "node dist/bundle.js",
67
"dev-cf": "wrangler dev",
7-
"deploy-cf": "wrangler deploy --minify",
8+
"deploy-cf": "wrangler deploy --minify --config wrangler.encrypt.jsonc",
89
"dev-eo": "edgeone pages dev",
910
"build-eo": "edgeone pages build",
1011
"deploy-eo": "rm -rf ./node_modules && edgeone pages deploy ./ -n edgeone-hono-app -t ",

0 commit comments

Comments
 (0)