vk-ssl-auto-deploy 0.2.1 → 0.3.0

package/README.md

@@ -1,18 +1,18 @@
-## 安装部署
-
+## 安装部署
+
 ### 1. 安装node环境（如果node环境已安装，则跳过这一步骤）
-
-#### linux系统
+
+#### linux系统
 
 ```bash
 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
-```
+```
+
+#### Windows系统
+
+```bash
+winget install --id OpenJS.NodeJS.LTS -e
+```
 
 验证是否完成完成
 
@@ -36,42 +36,42 @@ npm install -g vk-ssl-auto-deploy@latest
 
 ```bash
 npm root -g
-```
-
-假设返回 `/usr/lib/node_modules`
-
-则执行命令 `cd /usr/lib/node_modules/vk-ssl-auto-deploy` 进入工具目录
-
-### 5. 修改部署成功回调命令
-
-查看配置文件 [查看配置说明](#配置说明)
-
+```
+
+假设返回 `/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配置
-
+```
+
+编辑配置文件
+
+**基本操作:**
+
+- 按 i      - 进入插入模式(可以编辑)
+- 按 ESC    - 退出插入模式
+- 输入 :wq  - 保存并退出
+- 输入 :q!  - 不保存退出
+- 输入 :w   - 仅保存
+
+Linux系统下重载nginx配置
+
 ```bash
 sudo nginx -t && sudo service nginx reload
-```
-
-Windows系统下重载nginx配置（注意：地址需要用 / 不能用 \）
-
-```bash
+```
+
+Windows系统下重载nginx配置（注意：地址需要用 / 不能用 \）
+
+```bash
 cd C:/Users/Administrator/Desktop/nginx-openresty-1.15.8.1-win64&nginx.exe -s reload
-```
-
+```
+
 ### 6. 启动程序
 
 安装后可以直接使用命令启动：
@@ -79,14 +79,109 @@ cd C:/Users/Administrator/Desktop/nginx-openresty-1.15.8.1-win64&nginx.exe -s re
 ```bash
 # 调试启动（关闭命令窗口后程序会停止运行）
 vk-ssl
-
-# mp2方式运行（关闭命令窗口后程序依然会运行）
+
+# 【推荐】mp2方式运行（关闭命令窗口后程序依然会运行）
 cd <安装目录>，如 cd /usr/lib/node_modules/vk-ssl-auto-deploy
 npm run start
-```
-
-**注意服务器需要开放端口：6001**
-
+```
+
+**注意服务器需要开放端口：6001**
+
+### 7. 开机自动启动服务
+
+#### Linux系统
+
+使用PM2的startup功能来实现开机自动启动：
+
+**步骤1：生成开机启动脚本**
+
+```bash
+pm2 startup
+```
+
+**步骤2：启动服务并保存进程列表**
+
+```bash
+# 进入安装目录
+cd /usr/lib/node_modules/vk-ssl-auto-deploy
+
+# 启动服务
+npm run start
+
+# 保存当前PM2进程列表（重要！）
+pm2 save
+```
+
+**步骤3：验证开机启动**
+
+```bash
+# 重启服务器
+sudo reboot
+
+# 重启后检查服务是否自动运行
+pm2 list
+```
+
+**取消开机自动启动**
+
+```bash
+# 取消开机启动
+pm2 unstartup systemd
+
+# 删除保存的进程列表
+pm2 delete all
+pm2 save --force
+```
+
+#### Windows系统
+
+**方法一：使用pm2-windows-startup（推荐）**
+
+```bash
+# 安装pm2-windows-startup
+npm install -g pm2-windows-startup
+
+# 配置开机启动（需要管理员权限运行PowerShell或CMD）
+pm2-startup install
+
+# 进入安装目录并启动服务
+cd <安装目录>
+npm run start
+
+# 保存当前PM2进程列表
+pm2 save
+```
+
+**方法二：使用任务计划程序**
+
+1. 打开"任务计划程序"（Win+R，输入 `taskschd.msc`）
+2. 点击"创建基本任务"
+3. 名称：`vk-ssl-auto-deploy`
+4. 触发器：选择"计算机启动时"
+5. 操作：选择"启动程序"
+6. 程序或脚本：`npm`
+7. 添加参数：`--prefix <安装目录> run start`
+   - 例如：`--prefix C:\Users\Administrator\AppData\Roaming\npm\node_modules\vk-ssl-auto-deploy run start`
+8. 起始于：填写安装目录路径
+9. 完成创建
+
+**验证开机启动**
+
+```bash
+# 重启电脑后，检查服务是否自动运行
+pm2 list
+```
+
+**取消开机自动启动**
+
+```bash
+# 方法一：卸载pm2-windows-startup
+pm2-startup uninstall
+
+# 方法二：在任务计划程序中删除对应的任务
+```
+
+
 ## 配置说明
 
 编辑 `config.json` 文件可以修改服务端口和路由前缀：
@@ -95,8 +190,8 @@ npm run start
 {
   "port": 6001,
   "routerName": "api",
-	"certPath": "/vk-cert",
-	"ipWhitelist": [],
+	"certSaveDir": "/vk-cert",
+	"ipWhitelist": [],
 	"callbackCommand": [
 		"sudo nginx -t && sudo service nginx reload"
 	]
@@ -104,18 +199,135 @@ npm run start
 ```
 
 - `port`: 服务监听端口（默认 6001）（一般无需改动）
-- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）（一般无需改动）
-- `certPath`: 证书存储目录，最终证书路径为 `${certPath}/${证书id}/`（一般无需改动）
-- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
-- `callbackCommand`: 证书部署成功后执行的服务器命令，一般用于重载nginx配置等
-
-## 进入证书目录
-
-```js
-cd /vk-cert ; ls
-```
-
-## PM2 进程管理
+- `routerName`: API 路由前缀（默认 "api"，即访问路径为 `/api/...`）（一般无需改动）
+- `certSaveDir`: 证书存储目录，最终证书路径为 `${certSaveDir}/${证书id}/`（一般无需改动）
+- `ipWhitelist`: IP白名单，默认为空，表示不限制IP，如果需要限制IP，可以填写IP地址，多个IP地址用逗号分隔
+- `callbackCommand`: 证书部署成功后执行的服务器命令，一般用于重载nginx配置等
+
+## 查找nginx安装目录
+
+通过查看进程信息
+
+```bash
+ps aux | grep nginx
+
+// 查找nginx配置所在地址
+find / -name nginx.conf 2>/dev/null
+
+// 查看配置，确认证书所在地址
+vim /www/server/nginx/conf/nginx.conf
+
+// 假设
+证书内容文件地址：/www/server/nginx/cert/xxx.xxx.xxx/cert.pem
+证书私钥文件地址：//www/server/nginx/cert/xxx.xxx.xxx/key.pem;
+
+
+// 重载nginx配置，假设nginx的安装目录是 /www/server/nginx/sbin/nginx 
+执行nginx重载配置：/www/server/nginx/sbin/nginx -s reload
+```
+
+## 重置 root账号密码
+
+```
+sudo passwd root
+```
+
+## 服务器常用命令
+
+### 进入证书目录
+
+```bash
+ls /vk-cert
+```
+
+### 查看证书文件
+
+```bash
+ls /vk-cert/你的域名
+```
+
+### 基础文件列表命令
+
+```bash
+ls                    # 列出当前目录文件
+ls -l                 # 详细列表（长格式）
+ls -la                # 显示所有文件（包括隐藏文件）
+ls -lh                # 人类可读的文件大小（KB, MB, GB）
+ls -lt                # 按修改时间排序
+ls -ltr               # 按时间倒序（最新的在最后）
+ls -lS                # 按文件大小排序
+ls /path/to/dir       # 列出指定目录
+```
+
+### 分页查看（长列表时很有用）
+
+```bash
+ls -la | less         # 使用 less 分页查看
+ls -la | more         # 使用 more 分页查看
+
+# 在 less 或 more 中：
+Space / f           # 下一页（向下翻页）
+b                   # 上一页（向上翻页）
+d                   # 向下半页
+u                   # 向上半页
+j / ↓               # 向下一行
+k / ↑               # 向上一行
+g                   # 跳到开头
+G                   # 跳到结尾
+/keyword            # 向下搜索关键词
+?keyword            # 向上搜索关键词
+n                   # 下一个搜索结果
+N                   # 上一个搜索结果
+q                   # 退出
+```
+
+### 目录导航命令
+
+```bash
+cd /path/to/dir     # 进入指定目录
+cd ..               # 返回上一级目录
+cd -                # 返回上一次所在目录（切换）
+cd ~                # 返回用户主目录
+cd /                # 返回根目录
+pwd                 # 显示当前目录的完整路径
+```
+
+### 快捷键（命令行通用）
+
+```bash
+Ctrl + C            # 终止当前命令
+Ctrl + D            # 退出当前 shell（或结束输入）
+Ctrl + L            # 清屏（等同于 clear）
+Ctrl + R            # 搜索历史命令
+Ctrl + A            # 光标移到行首
+Ctrl + E            # 光标移到行尾
+Ctrl + U            # 删除光标前的内容
+Ctrl + K            # 删除光标后的内容
+↑ / ↓              # 浏览历史命令
+Tab                 # 自动补全
+```
+
+### 查找文件
+
+```bash
+find . -name "*.txt"              # 查找当前目录下所有 .txt 文件
+find /path -type f -name "file*"  # 查找指定路径的文件
+find . -mtime -7                  # 查找最近7天修改的文件
+locate filename                   # 快速查找文件（需要更新数据库）
+```
+
+### 文件内容预览
+
+```bash
+cat file.txt        # 显示整个文件内容
+head file.txt       # 显示文件前10行
+head -n 20 file.txt # 显示文件前20行
+tail file.txt       # 显示文件最后10行
+tail -n 20 file.txt # 显示文件最后20行
+tail -f file.log    # 实时追踪文件更新（日志文件常用）
+```
+
+### PM2 进程管理
 
 ```bash
 cd /usr/lib/node_modules/vk-ssl-auto-deploy

package/config.json

@@ -2,8 +2,8 @@
 	"port": 6001,
 	"routerName": "api",
 	"ipWhitelist": [],
-	"certPath": "/vk-cert",
+	"certSaveDir": "/vk-cert",
 	"callbackCommand": [
-		"sudo nginx -t && sudo service nginx reload"
+		"/www/server/nginx/sbin/nginx -s reload"
 	]
 }

package/package.json

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

package/routes/cert.js

@@ -65,11 +65,11 @@ router.post('/deploy-cert', upload.single('file'), async (req, res, next) => {
 
 		// 2. 创建cert目录和子目录
 		const projectRoot = path.join(__dirname, '..');
-		// 使用配置文件中的 certPath，支持绝对路径和相对路径
-		const certBaseDir = path.isAbsolute(config.certPath) ?
-			config.certPath :
-			path.join(projectRoot, config.certPath);
-		const certDir = path.resolve(certBaseDir, certName);
+		// 使用配置文件中的 certSaveDir，支持绝对路径和相对路径
+		const certBaseDir = path.isAbsolute(config.certSaveDir) ?
+			config.certSaveDir :
+			path.join(projectRoot, config.certSaveDir);
+		const certDir = path.resolve(certBaseDir, certName);
 		const userCertDir = certDir.replace(/\\/g, '/');
 
 		// 确保cert根目录存在