zijunchiang/opendance-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 17 Wiki Activity

feat(web): 移除 Docker 与反代部署，改为 Linux 业务服务并自带管理端托管

Browse Source 
需求变更：Web 端只保留业务需求，反向代理交由另外的服务处理，
本项目仅提供 IIS / nginx 反代说明文档，不部署反代。

主要改动：
- web-server: 新增管理端静态托管（ADMIN_DIR、SPA 深链接回退），
  反代因此只需一条全匹配转发规则；新增 adminDir 配置项
- deploy/install.sh: 删除 nginx 安装与站点配置逻辑，改为原生 Linux
  服务部署（systemd → OpenRC → SysVinit → 后台进程四级降级），
  打印反代交接指引
- deploy/ctl.sh: 启停/状态/日志脚本
- deploy/proxy/: 新增反代说明文档（README.md、nginx.conf.example、
  web.config.example），标注上传上限与超时必须同步调整
- 删除 deploy/nginx/、web-server/admin/nginx.conf、Dockerfile、
  docker-compose.yml、.dockerignore
- scripts/package-release.sh: 锚定排除规则 + 产物完整性校验
- 文档同步：README.txt、DSH.md、project.yaml、tasks/008、tasks/010
This commit is contained in:
zijunchiang
2026-09-15 01:25:19 +08:00
parent 653d9d168c
commit 8c76b0a599
17 changed files with 581 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
deploy/proxy/README.md
+182
View File
@@ -0,0 +1,182 @@
# 反向代理说明（nginx / IIS）
> **职责边界**：本 Web 端**只提供业务服务**（NestJS API + 管理端页面），
> **不部署、不配置反向代理**。反向代理由另外的服务或团队负责，本文档只提供配置说明。
>
> 安装脚本 `deploy/install.sh` 不会安装或修改任何反代软件。
## 一、需要转发的目标
本服务**自带管理端页面**，因此反向代理**只需把请求整体转发**到一个地址：
```
http://<后端地址>:3000
```
不需要在代理层单独托管静态文件，也不需要配置 SPA 回退（服务端已处理）。
一个 `location /`（nginx）或一条全匹配规则（IIS）即可。
| 路径 | 内容 | 说明 |
|---|---|---|
| `/` | 管理端页面 | 由 Node 服务提供；前端路由深链接（如 `/songs`）由服务端回退到 `index.html` |
| `/assets/*` | 前端静态资源 | 带内容哈希，可长缓存 |
| `/api/*` | REST API | 契约见 `contracts/rest-api.yaml` |
| `/health` | 健康检查 | 可用作反代的存活探测，数据库不可用时返回 **503** |
| `/static/*` | 上传文件 | 模型 / 音频 / 关键点序列 |
| `/contracts/*` | 契约快照 | 只读，便于另两端查阅 |
> Windows 客户端与 Android 之间的**关键点 WebSocket 链路不经过本服务**，
> 反代无需配置 WebSocket 转发。
## 二、后端绑定地址怎么选
`deploy/.env` 中的 `HOST`：
| 部署形态 | 建议值 | 说明 |
|---|---|---|
| 反代与后端**同机** | `127.0.0.1` | 后端不直接对外暴露，最安全 |
| 反代与后端**不同机** | `0.0.0.0` | 必须用防火墙把 3000 端口限制为仅反代来源可访问 |
改完执行 `systemctl restart opendance-api`（或对应的 `ctl.sh restart`）生效。
## 三、必须同步调整的两项
1. **上传上限**：本服务默认允许 512 MiB（`UPLOAD_MAX_BYTES`）。
代理层默认值通常远小于此（nginx 1 MB、IIS 约 28.6 MB），不改会导致大模型上传失败。
2. **超时**：上传大文件与下载关键点序列可能较慢，代理的读写超时必须放大。
## 四、nginx 配置
完整样例见 [`nginx.conf.example`](nginx.conf.example)。核心内容：
```nginx
upstream opendance_api {
server 127.0.0.1:3000;
keepalive 16;
}
server {
listen 80;
server_name your.domain.com;
client_max_body_size 512m; # ← 必须放开，否则 VRM/FBX 上传失败
client_body_timeout 300s;
location / {
proxy_pass http://opendance_api;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Connection "";
proxy_connect_timeout 30s;
proxy_send_timeout 300s;
proxy_read_timeout 300s;
proxy_request_buffering off; # 大文件直接透传，不在代理落盘
}
}
```
安装位置与重载：
```bash
# Debian / Ubuntu
cp nginx.conf.example /etc/nginx/sites-available/opendance.conf
ln -s /etc/nginx/sites-available/opendance.conf /etc/nginx/sites-enabled/
nginx -t && systemctl reload nginx
# RHEL 系
cp nginx.conf.example /etc/nginx/conf.d/opendance.conf
nginx -t && systemctl reload nginx
```
## 五、IIS 配置
IIS 需要先安装两个模块（**默认都没有**）：
1. **URL Rewrite** — https://www.iis.net/downloads/microsoft/url-rewrite
2. **Application Request Routing (ARR)** — https://www.iis.net/downloads/microsoft/application-request-routing
装完 ARR 后还需启用代理（否则会报 404.4）：
```
IIS 管理器 → 选中服务器节点 → Application Request Routing Cache
→ 右侧 Server Proxy Settings → 勾选 Enable proxy → 应用
```
完整 `web.config` 样例见 [`web.config.example`](web.config.example)，放到站点根目录即可：
```xml
<configuration>
<system.webServer>
<rewrite>
<rules>
<rule name="OpenDanceReverseProxy" stopProcessing="true">
<match url="(.*)" />
<action type="Rewrite" url="http://127.0.0.1:3000/{R:1}" />
</rule>
</rules>
</rewrite>
<security>
<requestFiltering>
<!-- 512 MiB：IIS 默认约 28.6 MB，不改大文件上传必失败 -->
<requestLimits maxAllowedContentLength="536870912" />
</requestFiltering>
</security>
<proxy preserveHostHeader="true" />
<serverRuntime uploadReadAheadSize="536870912" />
</system.webServer>
</configuration>
```
### IIS 容易踩的三个坑
1. **`requestLimits` 与 `serverRuntime` 要一起改**。只改前者，SSL 场景下仍会在
读取请求体时失败（`uploadReadAheadSize` 默认仅 48 KB）。
2. **代理超时改的是服务器级配置**，不是站点级。ARR 默认 120 秒，上传大文件会
中断。在 `applicationHost.config` 的 `<webProxy>` 节点调整：
```xml
<webProxy enabled="true" timeout="00:05:00" />
```
3. **`preserveHostHeader`** 需与 ARR 的 "Preserve host header" 设置一致，
否则后端收到的 Host 会变成 `127.0.0.1:3000`，影响日志与重定向。
## 六、HTTPS 与访问控制（可选）
- **HTTPS 终止在反代**：本服务只监听 HTTP，证书配置在 nginx/IIS 侧即可。
- **访问控制**：本版本**未内置登录认证**，如需公网访问，请在反代层加
Basic Auth、IP 白名单或对接已有 SSO。未加任何防护时请只在内网开放。
## 七、自检清单
配置完成后逐项确认：
```bash
# 1. 后端自身可用（绕过反代）
curl -i http://127.0.0.1:3000/health
# 2. 经反代可访问
curl -i http://<反代地址>/health
# 3. 管理端页面可打开（应返回 HTML）
curl -i http://<反代地址>/ | head -5
# 4. 前端深链接可用（应返回同一份 HTML，而不是 404）
curl -i http://<反代地址>/songs | head -5
# 5. API 可用
curl -i http://<反代地址>/api/catalog/version
# 6. 上传上限已放开：找一个小于 UPLOAD_MAX_BYTES 的文件试传
# 若返回 413 说明代理层限制没改
```
| 现象 | 原因 |
|---|---|
| 反代 502 / 504 | 后端未启动，或 `HOST` 绑定地址不对（同机应为 `127.0.0.1`，异机应为 `0.0.0.0`） |
| 页面能开、接口 404 | 只转发了 `/`，需要把 `/api/`、`/health`、`/static/` 一并转发（最简单是全匹配） |
| 上传大文件 413 | 代理层上传上限没放开（见第三、四、五节） |
| 上传中途断开 | 代理超时太短 |
| `/songs` 直接访问 404 | SPA 回退被代理拦截；本服务已处理，代理**不要**自己加 `try_files`，全匹配转发即可 |
deploy/proxy/nginx.conf.example
+122
View File
@@ -0,0 +1,122 @@
# ============================================================
# OpenDance Studio Web 服务端 —— nginx 反向代理样例
#
# 说明：本 Web 端不自带反向代理。本文件是**给你的反代服务参考**的配置样例，
# 由部署 `deploy/install.sh` 之外的反代负责人使用。
#
# 特点：后端（NestJS）自带管理端页面与 SPA 回退，因此这里
# 只需一个全匹配 location 把请求整体转发过去即可，
# 不需要 root/try_files 托管静态文件。
#
# 安装：
# Debian/Ubuntu: /etc/nginx/sites-available/opendance.conf（再软链到 sites-enabled/）
# RHEL 系: /etc/nginx/conf.d/opendance.conf
# 校验并重载： nginx -t && systemctl reload nginx
# ============================================================
upstream opendance_api {
# 后端地址：同机用 127.0.0.1；异机改成实际 IP，并在后端放防火墙
server 127.0.0.1:3000;
keepalive 16;
}
server {
listen 80;
listen [::]:80;
server_name your.domain.com; # 改成实际域名或 _
# 字符集：管理端与 API 都是 UTF-8
charset utf-8;
# ★ 上传上限：后端默认允许 512 MiB，nginx 默认仅 1 MB，
# 不改会导致 VRM / FBX 等大文件上传直接 413。
client_max_body_size 512m;
client_body_timeout 300s;
access_log /var/log/nginx/opendance.access.log;
error_log /var/log/nginx/opendance.error.log;
# ---- 全部请求转发给后端 ----
# 管理端页面、前端路由深链接、/api、/health、/static、/contracts
# 全部由后端处理，所以这里只需一条规则。
location / {
proxy_pass http://opendance_api;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# 配合 upstream keepalive，避免 Connection: close
proxy_set_header Connection "";
# ★ 超时：大文件上传与关键点序列下载都可能较慢
proxy_connect_timeout 30s;
proxy_send_timeout 300s;
proxy_read_timeout 300s;
# 大文件直接透传，不在代理层落盘
proxy_request_buffering off;
proxy_buffering off;
}
# 健康检查可单独放开日志噪音（可选）
location = /health {
proxy_pass http://opendance_api/health;
proxy_http_version 1.1;
proxy_set_header Host $host;
access_log off;
}
gzip on;
gzip_types text/plain text/css application/json application/javascript
application/x-ndjson text/xml application/xml image/svg+xml;
gzip_min_length 1024;
# 若前端资源由后端返回，代理层不要缓存 HTML，避免升级后页面不更新
location ~* \.html$ {
proxy_pass http://opendance_api;
proxy_http_version 1.1;
proxy_set_header Host $host;
add_header Cache-Control "no-cache";
}
}
# ============================================================
# 可选：HTTPS 终止在反代（后端只监听 HTTP）
#
# server {
# listen 443 ssl;
# http2 on;
# server_name your.domain.com;
#
# ssl_certificate /etc/nginx/ssl/opendance.crt;
# ssl_certificate_key /etc/nginx/ssl/opendance.key;
# ssl_protocols TLSv1.2 TLSv1.3;
#
# client_max_body_size 512m;
#
# location / {
# proxy_pass http://opendance_api;
# proxy_http_version 1.1;
# proxy_set_header Host $host;
# proxy_set_header X-Real-IP $remote_addr;
# proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
# proxy_set_header X-Forwarded-Proto $scheme;
# proxy_send_timeout 300s;
# proxy_read_timeout 300s;
# proxy_request_buffering off;
# }
# }
# ============================================================
# ============================================================
# 可选：本服务未内置登录认证，如需公网访问请在反代加一层防护
#
# location / {
# auth_basic "OpenDance Studio";
# auth_basic_user_file /etc/nginx/.htpasswd; # htpasswd -c 生成
# proxy_pass http://opendance_api;
# ...
# }
# ============================================================
deploy/proxy/web.config.example
+85
View File
@@ -0,0 +1,85 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
============================================================
OpenDance Studio Web 服务端 —— IIS 反向代理样例
说明：本 Web 端不自带反向代理。本文件是**给你的反代服务参考**的配置样例。
前置条件（IIS 默认都不带，需自行安装）：
1. URL Rewrite 模块
https://www.iis.net/downloads/microsoft/url-rewrite
2. Application Request Routing (ARR)
https://www.iis.net/downloads/microsoft/application-request-routing
3. 启用 ARR 代理（否则会 404.4）：
IIS 管理器 → 服务器节点 → Application Request Routing Cache
→ Server Proxy Settings → 勾选 Enable proxy
放置位置：IIS 站点根目录下的 web.config
后端（NestJS）自带管理端页面与 SPA 回退，所以这里只需一条全匹配重写规则，
不需要在 IIS 上再配置默认文档或 URL Rewrite 的 SPA 回退。
============================================================
-->
<configuration>
<system.webServer>
<rewrite>
<rules>
<!-- 全部请求转发给后端：管理端页面 / 前端深链接 / api / health / static / contracts -->
<rule name="OpenDanceReverseProxy" stopProcessing="true">
<match url="(.*)" />
<action type="Rewrite" url="http://127.0.0.1:3000/{R:1}" />
</rule>
</rules>
<!-- 若需要 HTTPS 终止，取消下面一段注释（IIS 侧装证书） -->
<!--
<outboundRules>
<rule name="RewriteRedirectToHttps" preCondition="IsRedirect">
<match serverVariable="RESPONSE_Location" pattern="^http://(.*)" />
<action type="Rewrite" value="https://{R:1}" />
</rule>
<preConditions>
<preCondition name="IsRedirect">
<add input="{RESPONSE_STATUS}" pattern="3\d\d" />
</preCondition>
</preConditions>
</outboundRules>
-->
</rewrite>
<security>
<requestFiltering>
<!-- ★ 上传上限 512 MiB。IIS 默认约 28.6 MB，不改大文件上传必失败（413） -->
<requestLimits maxAllowedContentLength="536870912" />
</requestFiltering>
</security>
<!-- ★ 与上一条配合：SSL 场景下请求体预读缓冲，默认仅 48 KB，不改仍会失败 -->
<serverRuntime uploadReadAheadSize="536870912" />
<!-- 保留原始 Host 头，后端日志与重定向才正确 -->
<proxy preserveHostHeader="true" />
<httpProtocol>
<customHeaders>
<remove name="X-Powered-By" />
</customHeaders>
</httpProtocol>
</system.webServer>
</configuration>
<!--
┌──────────────────────────────────────────────────────────────┐
│ 两个最常踩的坑 │
├──────────────────────────────────────────────────────────────┤
│ 1. 代理超时是**服务器级**配置，不在 web.config 里。 │
│ ARR 默认 120 秒，上传大模型会中途断开。改 │
│ C:\Windows\System32\inetsrv\config\applicationHost.config │
│ 的 <webProxy> 节点： │
│ <webProxy enabled="true" timeout="00:05:00" /> │
│ 改完 iisreset 或重启 W3SVC。 │
│ │
│ 2. requestLimits 与 serverRuntime 必须**同时**改。 │
│ 只改前者，HTTPS 下仍会因 uploadReadAheadSize 太小而失败。 │
└──────────────────────────────────────────────────────────────┘
-->