oms/backend/env.production.example
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

68 lines
3.0 KiB
Plaintext
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.

# OMS 后端生产环境变量模板(此文件提交 git,供服务器上创建真实 .env 用;真实 .env 不入库)
#
# 服务器上的真实文件位置:/www/wwwroot/api.oms.gztbyc.com/.env
# cp env.production.example /www/wwwroot/api.oms.gztbyc.com/.env && vim /www/wwwroot/api.oms.gztbyc.com/.env
# 各版本目录(v1 / v2)下必须各有一份 .env:config.default.js 的 dotenv 只读「进程工作目录」下的 .env,
# 而实例的工作目录就是各自的版本目录。发布脚本会在目标版本目录缺少 .env 时自动从 deployRoot/.env 复制一份
# (已存在则不覆盖,便于个别版本目录单独调整)。
# —— MySQL(必填)——
# ⚠️ 服务器本机 MySQL 监听 3306;不配置时 database/config.js 的默认值是 3307(本地开发库端口),
# 会出现 ECONNREFUSED 127.0.0.1:3307 导致实例启动失败
MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=__FILL_MYSQL_USER__
MYSQL_PASSWORD=__FILL_MYSQL_PASSWORD__
MYSQL_DATABASE=oms
# —— Redis(必填)——
# 未设置 REDIS_PASSWORD 时 config.default.js 会回落到默认值 qwe2019,生产请显式写明
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
REDIS_PASSWORD=__FILL_REDIS_PASSWORD__
# —— JWT(必填)——
# 生产必须单独设置,不要使用 config.default.js 里的开发默认值
JWT_SECRET=__FILL_RANDOM_SECRET__
JWT_EXPIRES_IN=2h
JWT_RENEW_THRESHOLD=1800
# —— 上传文件目录(必填)——
# 必须放在 deployRoot 下、版本目录之外,v1 / v2 才能共用同一份上传文件
UPLOAD_DIR=/www/wwwroot/api.oms.gztbyc.com/uploads
# —— 对外回调地址(可选)——
# 外部系统(WMS 等)回推 /openapi 时展示/使用的地址;不配则按请求 Host 动态生成
OMS_CALLBACK_BASE_URL=http://api.oms.gztbyc.com
# —— 跨域白名单(可选)——
# 不配时默认已放行 http/https 的 oms.gztbyc.com 与 localhost:5173
# CORS_ORIGINS=http://oms.gztbyc.com,https://oms.gztbyc.com
# —— 实例监听端口(双实例发布必填且两套必须不同)——
# v1 → 6090、v2 → 6091,需与 backend/config/deploy.config.local.cjs 的 ports 一致。
# 注意:Egg 端口取 config/config.local.js 的 EGG_PORT(默认 6090),
# 两套实例都用默认值会抢同一端口(EADDRINUSE,表现为健康检查一直不通过)。
# 若使用「发布脚本传入 EGG_PORT」的方式,本项可省略;手工 npm start 启动时必须写对。
EGG_PORT=6090
# —— 邮件(可选;不配置时邮箱验证码只输出到日志)——
# SMTP_HOST=
# SMTP_PORT=465
# SMTP_SECURE=true
# SMTP_USER=
# SMTP_PASS=
# SMTP_FROM=
# —— AI 收件人智能识别(可选;不配置时该接口返回 400 提示)——
# DEEPSEEK_API_KEY=
# —— 其它可选(有默认值,一般不用改)——
# REQUEST_LOG_KEEP_DAYS=60
# REQUEST_LOG_MAX_BODY=2000
# CACHE_TTL_USER=600
# CACHE_TTL_PRINCIPAL=600
# CACHE_TTL_PRINCIPAL_OPTIONS=600
# EMAIL_CODE_INTERVAL=60
# EMAIL_CODE_DAILY_LIMIT=10