XuqmGroup-PrivateDeploy/docs/configuration.md

57 行
1.5 KiB
Markdown

# 配置说明
## `.env`
部署入口配置,控制镜像版本、服务 profile、域名和 MySQL/Redis 模式。
关键字段:
- `REGISTRY`:私有 Docker 镜像仓库。
- `IMAGE_TAG`:本次部署镜像版本。
- `COMPOSE_PROFILES`:启用的服务集合,例如 `base,im,push,update,license`
- `MYSQL_MODE``external` 或 `managed`
- `REDIS_MODE``external` 或 `managed`
- `ENABLE_IM`、`ENABLE_PUSH`、`ENABLE_UPDATE`、`ENABLE_LICENSE`:运行时功能开关。
## `config/secrets.env`
敏感配置文件,不提交 Git。
关键字段:
- `MYSQL_PASSWORD`
- `MYSQL_ROOT_PASSWORD`
- `REDIS_PASSWORD`
- `SMTP_PASSWORD`
托管模式下,如果密码为空或为 `change-me`,脚本会自动生成并写回该文件。
## `config/xuqm.env`
业务服务共享配置,包含私有化运行模式、单租户初始化、域名和基础中间件连接信息。
私有化必须保持:
```env
DEPLOYMENT_MODE=PRIVATE
TENANT_REGISTER_ENABLED=false
TENANT_BOOTSTRAP_ENABLED=true
```
## `config/sdk/xuqm-private-sdk.json`
私有化 SDK 初始化配置,由 `scripts/render-config.sh` 生成。
文档站和客户应用示例必须使用该文件,不再指向 `dev.xuqinmin.com` 公有化逻辑。
## `config/vendors`
厂商能力配置:
- `push.env`华为、小米、OPPO、vivo、荣耀 Push 凭据。
- `store-submit.env`华为、小米、OPPO、vivo、荣耀应用市场自动发布凭据。
## `config/mail/smtp.env`
邮件服务配置。生产环境必须使用客户提供的 SMTP 服务。