oms/backend/env.production.example
liufumingren 5908cacdf5 docs(backend): 补充生产 .env 模板说明(SMTP 必填、LF 行尾、端口来源)
- SMTP 段标注为生产必填,并说明未配置时 sendCode 走「仅记录日志」分支:
  邮件不会发出,但 email_logs 仍写 status=1,排查时不要只看这张表
- 补充行尾警告:本文件必须为 LF,CRLF 会让 dotenv 把 \r 带进值里,
  典型症状是 getaddrinfo ENOTFOUND smtp.qq.com(主机名尾部多了 \r)
- 修正端口说明:EGG_PORT 由 config.default.js 的 config.cluster 读取
  (config.local.js 只在 env=local 时加载,生产不生效)
2026-09-14 22:20:02 +08:00

72 lines
3.3 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 一致。
# 注意:端口由 config/config.default.js 的 config.cluster 读取本变量(默认 6090)。
# (不要写在 config.local.js 里:egg 只在 env=local 时加载该文件,生产不生效)
# 两套实例用同一端口会抢端口(EADDRINUSE),表现为发布健康检查一直不通过。
EGG_PORT=6090
# —— 邮件(生产必填;不配置 SMTP_HOST 时验证码只写日志、前端收不到)——
# ⚠️ 未配置时 sendCode 会走「仅记录日志」分支:邮件不发出,
# 但 email_logs 仍写 status=1(成功),排查时别只看这张表
# ⚠️ 本文件必须是 LF 行尾:用 CRLF 写入会让 dotenv 把 \r 带进值里,
# 典型症状是 getaddrinfo ENOTFOUND smtp.qq.com(主机名尾部多了个 \r)
# SMTP_HOST=smtp.qq.com
# 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