XuqmGroup-PrivateDeploy/README.md

# XuqmGroup 私有化部署

## 快速开始

**首次部署：**

```bash
curl -fsSL https://xuqinmin.com/xuqmGroup/XuqmGroup-PrivateDeploy/raw/branch/main/install.sh \
  -o install.sh && bash install.sh
```

脚本自动完成：依赖检测 → 配置生成 → 镜像拉取 → 容器启动 → 租户初始化（新建或迁移）→ 全量验证。

**升级已有部署：**

```bash
curl -fsSL https://xuqinmin.com/xuqmGroup/XuqmGroup-PrivateDeploy/raw/branch/main/upgrade.sh \
  -o upgrade.sh && bash upgrade.sh
```

升级脚本自动完成：下载最新脚本 → 保留全部数据和配置 → 修复配置问题 → 可选拉取新镜像 → 重启容器 → 全量验证。

部署完成后根据输出的端口表配置宿主机 nginx，详见 [docs/runbook.md](docs/runbook.md)。

## 部署架构

```
上层 nginx（任意层级）
    │
    └── 本机 IP:80  内置 nginx 容器（统一入口，无需宿主机 nginx）
            │
            ├── tenant-service   /api/  /actuator/
            ├── file-service     /file/
            ├── tenant-web       /（兜底）
            ├── im-service       /api/im/  /ws/im
            ├── update-service   /api/v1/updates/  /api/v1/rn/
            ├── license-service  /api/license/
            └── push-service     （厂商回调，按需）
```

内置 nginx 容器直接绑定宿主机 `0.0.0.0:80`，**宿主机无需任何 nginx 配置**，上层 nginx 直接 proxy_pass 到本机 IP 即可。各业务容器（11224–11231）绑定 `127.0.0.1`，仅用于本地调试。

## 租户初始化方式

安装脚本启动后交互式选择：

- **新建租户**：填写邮箱、用户名、密码，首次启动自动创建
- **迁移租户**：在公有化平台安全中心生成迁移密钥（`pmk_` 开头），粘贴后自动完成导入

## 服务说明

| Profile | 服务 | 说明 |
|---------|------|------|
| base | tenant-service, file-service, tenant-web, nginx | 必选核心服务（含内置路由 nginx） |
| infra-mysql | mysql | 托管数据库 |
| infra-redis | redis | 托管缓存 |
| im | im-service | IM HTTP + WebSocket |
| push | push-service | 厂商推送 |
| update | update-service | 版本管理 + RN 热更新 |
| license | license-service | License 校验 |

## 后期启用/禁用服务

```bash
./scripts/enable-service.sh im
./scripts/disable-service.sh im
```

## 注意事项

- `application.yml` 中数据库 URL 硬编码了生产地址，`docker-compose.yml` 的 `environment:` 节负责覆盖，**不能删除**
- 上层 nginx `proxy_pass` 写本机 IP（端口 80），须透传 `Upgrade` / `Connection` 头（WebSocket 必需），每层都要加，详见 [docs/runbook.md](docs/runbook.md)
- 宿主机本身无需配置 nginx

## 文档

- [运行手册](docs/runbook.md) — 完整部署流程、nginx 配置、常用运维命令
- [配置说明](docs/configuration.md) — 各配置文件字段说明
- [验收清单](docs/acceptance-checklist.md) — 交付验收检查项