oms/backend/config/deploy.config.example.cjs
liufumingren 3daa95c96f feat(backend): 新增蓝绿发布脚本与跨域支持
跨域:
- 新增 app/middleware/cors.js:按白名单回 Access-Control-Allow-Origin,OPTIONS 预检直接
  204,使用 Bearer Token 鉴权故不回 Allow-Credentials
- config.default.js 注册全局中间件 cors(置于 requestLog 之前),并新增 config.cors.origins
  (可用环境变量 CORS_ORIGINS 覆盖,默认放行 http/https 的 oms.gztbyc.com 与本地 vite)

端口:
- config.default.js 新增 config.cluster(读 EGG_PORT,默认 6090)
  原因:egg 只在 env=local 时加载 config.local.js,生产(env=prod)不加载它,
  原先把端口写在 config.local.js 会让生产退回框架默认的 7001

发布(参考 WMS 后端的 v1/v2 双实例蓝绿):
- 新增 script/deploy-lib.cjs、deploy-remote.cjs、rollback-remote.cjs、init-deploy-config.cjs
- 目标目录:清理旧代码(保留 logs/run/node_modules/.env)→ 解压 → 缺 .env 时从
  deployRoot/.env 复制 → npm install --production → 释放端口 → 启动 → 健康检查 →
  改写 nginx-upstream.conf 并 reload → 停旧实例;健康检查失败则不切换、回滚 current.md
  并清理新实例,线上不受影响
- 回滚 = 切回另一套版本目录(npm run rollback [-- --to=v1|v2]),秒级完成
- 发布包按 git 文件清单 + include/exclude 白名单生成,.env/uploads/logs 等不入包
  (含 .sequelizerc,便于服务器上直接跑迁移)

配置与依赖:
- 新增 config/deploy.config.example.cjs(模板入库;真实配置 deploy.config.local.cjs 已忽略)
- 新增 env.production.example:生产 .env 模板,说明 MySQL 端口、Redis 密码、
  JWT_SECRET、UPLOAD_DIR(必须放版本目录之外以让 v1/v2 共用)等
- package.json 增加 deploy/deploy:prod/deploy:init/rollback/rollback:prod;
  顺带登记导出任务用到的 exceljs 依赖
- .gitignore 增加:真实部署配置、backend/temp/(本地发布包)、backend/upload/(导出产物)
2026-09-14 22:14:20 +08:00

95 lines
4.6 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
/**
* 后端部署配置模板(此文件提交 git,供复制使用)
*
* 真实配置请复制为同目录下的 config/deploy.config.local.cjs 并填写实际值;
* 该文件已被 .gitignore 排除,**不要提交**(内含服务器地址与 SSH 私钥路径)。
*
* 发布模型(双实例蓝绿,与 WMS 后端一致):
* <deployRoot>/v1、<deployRoot>/v2 两套代码目录,每次发布交替部署另一套
* <deployRoot>/current.md 当前活跃版本(内容为 v1 或 v2)
* <deployRoot>/nginx-upstream.conf Nginx 反代目标:proxy_pass http://127.0.0.1:<端口>;
* 需要站点配置里 include 它(见下方「Nginx 前置」)
* <deployRoot>/.env 服务器端真实环境变量(密钥/数据库等),不入库、
* 发布时按需复制到各版本目录
* <deployRoot>/.deploy/ 发布工作目录(incoming 上传包、state 状态文件)
*
* Nginx 前置(仅首次,站点 api.oms.gztbyc.com):
* 把反向代理 `location /` 里的 `proxy_pass http://127.0.0.1:6090;` 换成
* `include /www/wwwroot/api.oms.gztbyc.com/nginx-upstream.conf;`
* 之后每次发布只需改写该文件并 reload,即可实现零中断切换。
* (若不改,发布脚本会在切换 upstream 时告警:新版实例已起在另一个端口,
* 但站点仍指向旧端口,需要人工处理。)
*
* 服务器端环境变量(仅首次,需手工创建一次):
* /www/wwwroot/api.oms.gztbyc.com/.env —— 真实配置,不入库
* 可从本地 backend/.env 复制,并注意:
* - MYSQL_HOST / MYSQL_PORT / MYSQL_USER / MYSQL_PASSWORD / MYSQL_DATABASE:生产数据库
* - REDIS_HOST / REDIS_PORT / REDIS_PASSWORD
* - JWT_SECRET:生产必须单独设置
* - UPLOAD_DIR=/www/wwwroot/api.oms.gztbyc.com/uploads
* (上传文件必须放在 deployRoot 下、版本目录之外,v1/v2 才能共用同一份文件)
* - OMS_CALLBACK_BASE_URL=http://api.oms.gztbyc.com (可选,用于对外展示回调地址)
* 发布时若目标版本目录没有 .env,会自动从该文件复制一份(各版本目录各自保留副本,
* 已存在则不覆盖)。
*/
module.exports = {
production: {
// —— SSH 连接 ——
host: '112.124.21.102',
port: 22,
username: 'root',
// SSH 私钥:可用绝对路径,或相对 backend 根目录的路径
privateKeyPath: 'C:/Users/lfmingren/.ssh/112.124.21.102_id_ed25519',
sshOptions: [ 'StrictHostKeyChecking=accept-new' ],
// —— 发布目录 ——
deployRoot: '/www/wwwroot/api.oms.gztbyc.com',
// —— 双实例端口(v1 / v2);nginx-upstream.conf 指向当前活跃版本的端口 ——
ports: { v1: 6090, v2: 6091 },
// —— 版本目录内需要跨发布保留的目录/文件(清理旧代码时不会删除)——
// node_modules 保留可让 npm install 增量安装;如需每次全新安装,去掉它即可
// .env 必须保留:每个版本目录的 .env 里写着本实例的 EGG_PORT(v1=6090 / v2=6091),
// 被清理掉后会从 deployRoot/.env 复制一份(那份是 v1 的端口),导致 v2 起在 6090 上
sharedDirs: [ 'logs', 'run', 'node_modules', '.env' ],
// —— 发布包内容(相对 backend 根目录,`**` 表示该目录下全部内容)——
// 说明:.env / uploads / logs / run 等已被 .gitignore 忽略,git ls-files 不会列出,
// 这里再写进 deployExcludePaths 作为兜底。
deployIncludePaths: [
'.sequelizerc',
'app.js',
'app/**',
'config/**',
'database/**',
'package.json',
'package-lock.json',
],
deployExcludePaths: [
'config/deploy.config.local.cjs',
'config/deploy.config.example.cjs',
'.env',
'.env.*',
'uploads/**',
'logs/**',
'run/**',
'temp/**',
'test/**',
'swagger.json',
],
// —— 启动 / 安装命令 ——
// 若需要在服务器上跑迁移(npm run migration:up)、或希望 npx sequelize-cli 可用,
// 把 installCommand 改成 'npm install'(会一并装 devDependencies)
installCommand: 'npm install --production',
// 实例端口由 config/config.local.js 的 EGG_PORT 决定(默认 6090),
// 双实例发布时请在各版本目录的 .env 里分别写 EGG_PORT(v1=6090、v2=6091)
startCommand: 'npm start',
// 健康检查:实例启动后轮询 http://127.0.0.1:<端口><healthCheckPath>
healthCheckPath: '/',
},
};