vk-ssl-auto-deploy 0.0.3 → 0.1.1

package/README.md

@@ -1,79 +1,130 @@
-### 1. NPM 全局安装（推荐）
-
-安装node环境
+## 安装部署
+
+### 1. 安装node环境（如果node环境已安装，则跳过这一步骤）
+
+#### linux系统
 
 ```bash
-curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
-sudo yum install -y nodejs
-```
+curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash - && sudo yum install -y nodejs
+```
+
+#### Windows系统
+
+```bash
+winget install --id OpenJS.NodeJS.LTS -e
+```
 
-验证npm
+验证是否完成完成
 
 ```bash
-node -v
-npm -v
+node -v && npm -v
 ```
 
-安装pm2
+### 2. 安装pm2
 
 ```bash
 npm install -g pm2
 ```
 
-安装自动部署工具
+### 3. 安装证书自动部署工具
 
 ```bash
 npm install -g vk-ssl-auto-deploy@latest
 ```
 
-查看安装目录
+### 4. 查看安装目录
 
 ```bash
 npm root -g
-```
-
-在返回的结果中拼接 `/vk-ssl-auto-deploy`
-
-如 `/usr/lib/node_modules/vk-ssl-auto-deploy`
-
-### 2. 启动
+```
+
+假设返回 `/usr/lib/node_modules`
+
+则执行命令 `cd /usr/lib/node_modules/vk-ssl-auto-deploy` 进入工具目录
+
+### 5. 修改部署成功回调命令
+
+查看配置文件 [查看配置说明](#配置说明)
+
+```bash
+vim config.json
+```
+
+编辑配置文件
+
+**基本操作:**
+
+- 按 i      - 进入插入模式(可以编辑)
+- 按 ESC    - 退出插入模式
+- 输入 :wq  - 保存并退出
+- 输入 :q!  - 不保存退出
+- 输入 :w   - 仅保存
+
+Linux系统下重载nginx配置
+
+```bash
+sudo nginx -t && sudo service nginx reload
+```
+
+Windows系统下重载nginx配置（注意：地址需要用 / 不能用 \）
+
+```bash
+cd C:/Users/Administrator/Desktop/nginx-openresty-1.15.8.1-win64&nginx.exe -s reload
+```
+
+### 6. 启动程序
 
 安装后可以直接使用命令启动：
 
 ```bash
-# 直接启动
+# 调试启动（关闭命令窗口后程序会停止运行）
 vk-ssl
-
-# 或使用 PM2 管理（需要先安装 PM2）
-npm install -g pm2
+
+# mp2方式运行（关闭命令窗口后程序依然会运行）
 cd <安装目录>，如 cd /usr/lib/node_modules/vk-ssl-auto-deploy
 npm run start
+```
+
+**注意服务器需要开放端口：6001**
+
+## 配置说明
+
+编辑 `config.json` 文件可以修改服务端口和路由前缀：
+
+```json
+{
+  "port": 6001,
+  "routerName": "api",
+	"certPath": "/vk-cert",
+	"ipWhitelist": [],
+	"callbackCommand": [
+		"sudo nginx -t && sudo service nginx reload"
+	]
+}
 ```
 
+- `port`: 服务监听端口（默认 6001）（一般无需改动）
+- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）（一般无需改动）
+- `certPath`: 证书存储目录，最终证书路径为 `${certPath}/${证书id}/`（一般无需改动）
+- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
+- `callbackCommand`: 证书部署成功后执行的服务器命令，一般用于重载nginx配置等
+
+## 进入证书目录
+
 ```js
-cd /usr/lib/node_modules/vk-ssl-auto-deploy/cert
-```
+cd /vk-cert ; ls
+```
 
-### 3. 本地开发安装
+## PM2 进程管理
 
 ```bash
-# 克隆项目
-git clone <repository-url>
-cd vk-ssl-auto-deploy
-
-# 安装依赖
-npm install
-
-# 启动运行
-npm dev
-```
-
-### 4. PM2 进程管理（生产环境推荐）
+cd /usr/lib/node_modules/vk-ssl-auto-deploy
 
-```bash
 # 启动服务
 npm run start
 
+或直接 npm --prefix /usr/lib/node_modules/vk-ssl-auto-deploy run start
+
 # 停止服务
 npm run stop
 
@@ -90,25 +141,25 @@ npm run delete
 npm run list
 ```
 
-### 5. 证书自动部署API
+## 证书自动部署API
 
-#### 接口说明
+### 接口说明
 
 证书续期后台可以通过HTTP POST请求将证书文件自动部署到本项目。
 
-#### 请求地址
+### 请求地址
 
 ```
 POST http://your-domain:3000/api/deploy-cert
 ```
 
-#### 请求参数
+### 请求参数
 
 - Content-Type: `multipart/form-data`
 - `name`: 证书名称（必填），用于创建子目录，例如 `aaa` 会创建 `cert/aaa` 目录
 - `file`: zip格式的证书文件（必填）
 
-#### 返回格式
+### 返回格式
 
 成功响应：
 ```json
@@ -128,7 +179,7 @@ POST http://your-domain:3000/api/deploy-cert
 }
 ```
 
-#### 错误码说明
+### 错误码说明
 
 - `1001`: 缺少参数 name
 - `1002`: 缺少文件
@@ -136,7 +187,7 @@ POST http://your-domain:3000/api/deploy-cert
 - `2001`: 解压zip文件失败
 - `5000`: 服务器内部错误
 
-#### 证书文件说明
+### 证书文件说明
 
 上传的zip文件解压后应包含以下内容：
 
@@ -152,7 +203,7 @@ POST http://your-domain:3000/api/deploy-cert
 - cert.pfx（pfx格式证书文件，iis服务器使用）
 - one.pem（证书和私钥简单合并成一个文件，pem格式，crt正文+key正文）
 
-#### 使用示例
+### 使用示例
 
 使用curl命令：
 ```bash
@@ -175,64 +226,6 @@ fetch('http://localhost:3000/api/deploy-cert', {
 .then(data => console.log(data));
 ```
 
-### 6. 配置说明
-
-编辑 `config.json` 文件可以修改服务端口和路由前缀：
-
-```json
-{
-  "port": 6001,
-  "routerName": "api",
-	"ipWhitelist": []
-}
-```
-
-- `port`: 服务监听端口（默认 6001）
-- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）
-- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
-
-### 7. License
-
-MIT
-
-### 8. 发布到 NPM（维护者使用）
-
-#### 发布前准备
-
-1. 确保已登录 npm 账号：
-```bash
-npm login
-```
-
-2. 更新版本号（遵循语义化版本）：
-```bash
-# 修复bug
-npm version patch
-
-# 新功能
-npm version minor
-
-# 破坏性更新
-npm version major
-```
-
-#### 发布命令
-
-```bash
-# 发布到 npm
-npm publish
-
-# 如果是第一次发布公开包
-npm publish --access public
-```
-
-#### 测试包
-
-发布前可以本地测试：
-```bash
-# 打包测试
-npm pack
+## License
 
-# 本地安装测试
-npm install -g ./vk-ssl-auto-deploy-1.0.0.tgz
-```
+MIT

package/config.json

@@ -2,6 +2,7 @@
 	"port": 6001,
 	"routerName": "api",
 	"ipWhitelist": [],
+	"certPath": "/vk-cert",
 	"callbackCommand": [
 		"sudo nginx -t && sudo service nginx reload"
 	]

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vk-ssl-auto-deploy",
-	"version": "0.0.3",
+	"version": "0.1.1",
 	"description": "SSL证书自动部署工具 - 提供HTTP API接口，支持证书文件自动上传和部署",
 	"main": "app.js",
 	"bin": {

package/public/stylesheets/style.css

@@ -1,8 +1,8 @@
-body {
-  padding: 50px;
-  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
-}
-
-a {
-  color: #00B7FF;
-}
+body {
+  padding: 50px;
+  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
+}
+
+a {
+  color: #00B7FF;
+}

package/routes/cert.js

@@ -65,8 +65,11 @@ router.post('/deploy-cert', upload.single('file'), async (req, res, next) => {
 
 		// 2. 创建cert目录和子目录
 		const projectRoot = path.join(__dirname, '..');
-		const certBaseDir = path.join(projectRoot, 'cert');
-		const certDir = path.join(certBaseDir, certName);
+		// 使用配置文件中的 certPath，支持绝对路径和相对路径
+		const certBaseDir = path.isAbsolute(config.certPath) 
+			? config.certPath 
+			: path.join(projectRoot, config.certPath);
+		const certDir = path.resolve(certBaseDir, certName);
 
 		// 确保cert根目录存在
 		if (!fs.existsSync(certBaseDir)) {
@@ -159,7 +162,7 @@ router.post('/deploy-cert', upload.single('file'), async (req, res, next) => {
 				});
 			}
 
-		console.log(`[证书部署成功] 名称: ${certName}, 路径: ${certDir}, 保存: ${stats.saved}个, 过滤: ${stats.filtered}个`);
+		console.log(`[证书部署成功] 名称: ${certName}, 路径: ${certDir.replace(/\\/g, '/')}, 保存: ${stats.saved}个, 过滤: ${stats.filtered}个`);
 
 		// 4. 执行回调命令
 		const commandResults = [];
@@ -211,7 +214,7 @@ router.post('/deploy-cert', upload.single('file'), async (req, res, next) => {
 		return res.json({
 			code: 0,
 			msg: '证书部署成功',
-			path: 'cert/' + certName,
+			path: path.join(config.certPath, certName),
 			stats: {
 				total: stats.total,
 				saved: stats.saved,

package/views/error.ejs

@@ -1,3 +1,3 @@
-<h1><%= message %></h1>
-<h2><%= error.status %></h2>
-<pre><%= error.stack %></pre>
+<h1><%= message %></h1>
+<h2><%= error.status %></h2>
+<pre><%= error.stack %></pre>

package/views/index.ejs

@@ -1,10 +1,10 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title><%= title %></title>
-    <link rel='stylesheet' href='/stylesheets/style.css' />
-  </head>
-  <body>
-    <h1><%= title %></h1>
-  </body>
-</html>
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <link rel='stylesheet' href='/stylesheets/style.css' />
+  </head>
+  <body>
+    <h1><%= title %></h1>
+  </body>
+</html>