XuqmGroup-PrivateDeploy/docs/deployment-defaults.md
徐勤民 dde3f9ece7 docs: 整理全量文档
- README: 补充 reset.sh 快速入口和脚本对比表
- runbook: 新增「容器重置」章节和「故障排查」(502/crash-loop/WebSocket/镜像未生效)
- configuration: 修正端口表(im=11228/push=11229/update=11230/license=11231),
  补充 SPRING_DATASOURCE_PASSWORD 设计说明,移除已废弃的 environment 密码块说明
- acceptance-checklist: 修正端口号,补充 WebSocket 多层透传说明,移除不存在的 11227 行
- deployment-defaults: 同步端口表,补充 reset.sh 和 WebSocket 注意事项

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-21 11:48:45 +08:00

2.2 KiB

部署信息记录模板

部署完成后将此文件复制填写,不要将含有真实凭据的版本提交到 Git


部署信息

项目
部署版本 (见 VERSION 文件)
部署主机
部署目录 /opt/xuqm-private
部署时间
外部访问地址

租户信息

项目
租户名称
登录邮箱
登录用户名
初始密码 (见 config/secrets.env 或部署时设置)
迁移来源 新建 / 公有化平台迁移

应用列表

应用名称 App Key

服务端口

宿主机端口 服务 容器内端口
11224 tenant-service 9001
11225 file-service 8086
11226 tenant-web 80
11228 im-service 8082
11229 push-service 8083
11230 update-service 8084
11231 license-service 8085

宿主机 nginx 配置参考见 docs/runbook.md


数据目录

路径 说明
data/mysql/ MySQL 数据文件
data/redis/ Redis AOF 文件
data/uploads/ 文件服务上传目录
data/update/ 版本管理包存储
data/backups/ 备份文件
logs/ 审计日志

常用运维命令

# 查看所有容器状态
docker compose -f docker-compose.yml -f docker-compose.infra.yml ps

# 查看服务日志
docker compose -f docker-compose.yml -f docker-compose.infra.yml logs --tail 100 tenant-service

# 运行全量验证
bash scripts/verify.sh

# 停止所有服务(保留数据)
docker compose -f docker-compose.yml -f docker-compose.infra.yml down

# 容器异常时重置(保留数据)
bash scripts/reset.sh

注意事项

  1. 注册功能已禁用TENANT_REGISTER_ENABLED=false,只能用初始化的账号登录。
  2. 数据持久化MySQL 和 Redis 数据存储在 data/ 目录,容器重启不丢失。
  3. 推送服务push-service 已启动,各厂商推送默认关闭,需填写 config/vendors/push.env 并重启。
  4. WebSocket:每一层 nginx 代理都必须透传 Upgrade / Connection 头,否则 IM 连接失败。