vk-ssl-auto-deploy 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -51
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,7 +38,27 @@ npm install -g vk-ssl-auto-deploy@latest
|
|
|
38
38
|
npm root -g
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
假设返回 `/usr/lib/node_modules`
|
|
42
|
+
|
|
43
|
+
则执行命令 `cd /usr/lib/node_modules/vk-ssl-auto-deploy` 进入工具目录
|
|
44
|
+
|
|
45
|
+
### 5. 修改部署成功回调命令
|
|
46
|
+
|
|
47
|
+
查看配置文件 [查看配置说明](#配置说明)
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
vim config.json
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
编辑配置文件
|
|
54
|
+
|
|
55
|
+
**基本操作:**
|
|
56
|
+
|
|
57
|
+
- 按 i - 进入插入模式(可以编辑)
|
|
58
|
+
- 按 ESC - 退出插入模式
|
|
59
|
+
- 输入 :wq - 保存并退出
|
|
60
|
+
- 输入 :q! - 不保存退出
|
|
61
|
+
- 输入 :w - 仅保存
|
|
42
62
|
|
|
43
63
|
Linux系统下重载nginx配置
|
|
44
64
|
|
|
@@ -46,53 +66,56 @@ Linux系统下重载nginx配置
|
|
|
46
66
|
sudo nginx -t && sudo service nginx reload
|
|
47
67
|
```
|
|
48
68
|
|
|
49
|
-
Windows系统下重载nginx
|
|
69
|
+
Windows系统下重载nginx配置（注意：地址需要用 / 不能用 \）
|
|
70
|
+
|
|
50
71
|
```bash
|
|
51
|
-
// 注意：地址需要用 / 不能用 \
|
|
52
72
|
cd C:/Users/Administrator/Desktop/nginx-openresty-1.15.8.1-win64&nginx.exe -s reload
|
|
53
73
|
```
|
|
54
|
-
|
|
55
|
-
在返回的结果中拼接 `/vk-ssl-auto-deploy`
|
|
56
|
-
|
|
57
|
-
如 linux系统可能是 `/usr/lib/node_modules/vk-ssl-auto-deploy`
|
|
58
74
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
## 2. 启动
|
|
75
|
+
### 6. 启动程序
|
|
62
76
|
|
|
63
77
|
安装后可以直接使用命令启动：
|
|
64
78
|
|
|
65
79
|
```bash
|
|
66
|
-
#
|
|
80
|
+
# 调试启动（关闭命令窗口后程序会停止运行）
|
|
67
81
|
vk-ssl
|
|
68
|
-
|
|
69
|
-
#
|
|
70
|
-
npm install -g pm2
|
|
82
|
+
|
|
83
|
+
# mp2方式运行（关闭命令窗口后程序依然会运行）
|
|
71
84
|
cd <安装目录>，如 cd /usr/lib/node_modules/vk-ssl-auto-deploy
|
|
72
85
|
npm run start
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
```js
|
|
76
|
-
cd /usr/lib/node_modules/vk-ssl-auto-deploy/cert
|
|
77
86
|
```
|
|
78
87
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
##
|
|
82
|
-
|
|
83
|
-
```bash
|
|
84
|
-
# 克隆项目
|
|
85
|
-
git clone <repository-url>
|
|
86
|
-
cd vk-ssl-auto-deploy
|
|
88
|
+
**注意服务器需要开放端口：6001**
|
|
89
|
+
|
|
90
|
+
## 配置说明
|
|
87
91
|
|
|
88
|
-
|
|
89
|
-
npm install
|
|
92
|
+
编辑 `config.json` 文件可以修改服务端口和路由前缀：
|
|
90
93
|
|
|
91
|
-
|
|
92
|
-
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"port": 6001,
|
|
97
|
+
"routerName": "api",
|
|
98
|
+
"certPath": "/vk-cert",
|
|
99
|
+
"ipWhitelist": [],
|
|
100
|
+
"callbackCommand": [
|
|
101
|
+
"sudo nginx -t && sudo service nginx reload"
|
|
102
|
+
]
|
|
103
|
+
}
|
|
93
104
|
```
|
|
94
105
|
|
|
95
|
-
|
|
106
|
+
- `port`: 服务监听端口（默认 6001）（一般无需改动）
|
|
107
|
+
- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）（一般无需改动）
|
|
108
|
+
- `certPath`: 证书存储目录，最终证书路径为 `${certPath}/${证书id}/`（一般无需改动）
|
|
109
|
+
- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
|
|
110
|
+
- `callbackCommand`: 证书部署成功后执行的服务器命令，一般用于重载nginx配置等
|
|
111
|
+
|
|
112
|
+
## 进入证书目录
|
|
113
|
+
|
|
114
|
+
```js
|
|
115
|
+
cd /vk-cert ; ls
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## PM2 进程管理
|
|
96
119
|
|
|
97
120
|
```bash
|
|
98
121
|
cd /usr/lib/node_modules/vk-ssl-auto-deploy
|
|
@@ -118,7 +141,7 @@ npm run delete
|
|
|
118
141
|
npm run list
|
|
119
142
|
```
|
|
120
143
|
|
|
121
|
-
##
|
|
144
|
+
## 证书自动部署API
|
|
122
145
|
|
|
123
146
|
### 接口说明
|
|
124
147
|
|
|
@@ -203,24 +226,6 @@ fetch('http://localhost:3000/api/deploy-cert', {
|
|
|
203
226
|
.then(data => console.log(data));
|
|
204
227
|
```
|
|
205
228
|
|
|
206
|
-
##
|
|
207
|
-
|
|
208
|
-
编辑 `config.json` 文件可以修改服务端口和路由前缀：
|
|
209
|
-
|
|
210
|
-
```json
|
|
211
|
-
{
|
|
212
|
-
"port": 6001,
|
|
213
|
-
"routerName": "api",
|
|
214
|
-
"certPath": "../../../vk-cert",
|
|
215
|
-
"ipWhitelist": []
|
|
216
|
-
}
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
- `port`: 服务监听端口（默认 6001）
|
|
220
|
-
- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）
|
|
221
|
-
- `certPath`: 证书存储目录，最终证书路径为 `${certPath}/${证书id}/`
|
|
222
|
-
- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
|
|
223
|
-
|
|
224
|
-
## 7. License
|
|
229
|
+
## License
|
|
225
230
|
|
|
226
231
|
MIT
|