Files

admin b346b7e194 Add HTTPS demo entry for microphone access

- Add a self-signed HTTPS Nginx entrypoint on Docker port 4443 so browser microphone APIs can run in demo mode.

- Keep the existing HTTP port 4002 unchanged while exposing container port 443 and generating the demo certificate during image build.

- Update CORS defaults and Compose environment for the HTTPS frontend origin.

- Clarify the report editor microphone message with localhost, HTTPS, and browser trusted-origin demo options.

- Document the browser HTTP microphone limitation, HTTPS demo URL, and Chrome/Edge insecure-origin workaround in README and docs.

2026-05-02 03:34:31 +08:00

4.0 KiB

Raw Blame History

部署运行

如果是第一次安装项目，建议先阅读安装与初始设置。本文档主要记录开发运行、质量检查、环境变量和 Docker/Nginx 部署边界。

本地开发

前端：

npm install
npm run dev

开发服务监听 0.0.0.0:3001。开发模式下 Vite 会把 /api 代理到 VITE_API_PROXY_TARGET，默认 http://localhost:3100。

后端：

cp .env.example .env
npm run prisma:generate
npm run server:dev

本地直接运行 API 默认监听 0.0.0.0:3100，健康检查为：

http://localhost:3100/api/health

如需连接真实 PostgreSQL：

npm run prisma:migrate
npm run prisma:seed

质量检查

npm run lint
npm run test
npm run server:build
npm run build

当前 lint 实际执行 tsc --noEmit，用于 TypeScript 类型检查。

环境变量

复制示例文件：

cp .env.example .env.local

AI 和语音密钥由后端 Settings API 保存并由代理使用，前端不再注入 Gemini 旧环境变量。

后端新增变量：

API_PORT：API 监听端口。本地直接运行默认 3100；Docker Compose 暴露到宿主机的默认端口是 3002。
API_BODY_LIMIT：API JSON/urlencoded 请求体上限，默认 100mb。报告正文、关键帧、模板图片和通用文件上传仍可能携带 Data URL，调小会导致保存或上传出现 request entity too large。
CORS_ORIGIN：允许跨域携带 Cookie 的前端来源。
DATABASE_URL：PostgreSQL 连接串。Docker Compose 暴露到宿主机的默认端口是 5433，容器内部仍使用 db:5432。
SESSION_SECRET：Session Cookie 签名密钥。
SESSION_COOKIE_SECURE：是否只通过 HTTPS 发送 Session Cookie。本地 HTTP/Compose 默认 false，生产 HTTPS 应设为 true。
FILE_STORAGE_DIR：后端文件目录。Docker Compose 默认 /app/uploads，并挂载到 uploads_data volume。
VITE_API_PROXY_TARGET：前端开发服务器 /api 代理目标。直接运行后端用 http://localhost:3100；连接 Docker Compose API 用 http://localhost:3002。
VITE_ENABLE_LOCAL_FALLBACK：生产构建是否允许本地兼容回退。开发模式默认启用，生产默认关闭。

Docker 部署

docker-compose up -d --build

默认通过 Nginx 暴露 http://localhost:4002，并额外暴露自签名证书的语音演示入口 https://localhost:4443。

当前 Compose 服务：

web：前端静态站点，暴露 http://localhost:4002 和 https://localhost:4443。
api：NestJS API，暴露 http://localhost:3002。
db：PostgreSQL 16，暴露 localhost:5433。
uploads_data：后端文件持久化 volume。

构建流程：

Dockerfile 使用 Node 构建 dist/。
运行阶段使用 nginx:alpine 托管静态文件。
Dockerfile.server 构建并运行 NestJS API。
nginx.conf 已配置 SPA 路由回退、/api 反向代理、100m 请求体上限和自签名 HTTPS 演示入口。

麦克风访问

浏览器不允许普通局域网 HTTP 页面调用麦克风，代码无法绕过这个限制。Docker 演示环境建议使用：

https://localhost:4443

首次打开会看到自签名证书提示，接受后即可让浏览器开放麦克风权限。如果必须用 http://局域网IP:4002 演示，只能在 Chrome/Edge 启动时加临时参数，把该 HTTP 来源标记为可信：

google-chrome --unsafely-treat-insecure-origin-as-secure=http://局域网IP:4002 --user-data-dir=/tmp/surclaw-chrome-demo

这是浏览器演示开关，不是系统安全方案；正式环境仍建议使用 HTTPS。

部署边界

当前后端已承载登录认证、数据库 Session、Dashboard、报告、报告媒体关系、模板、字段库、通用文件/签名文件、视频/关键帧文件、用户管理、部门模板授权、系统设置、AI 代理、语音代理、HTML 清洗和审计日志查询。生产化前还需要补齐第三方代理调用摘要、限流、备份恢复、对象存储和更完整的旧数据迁移。

4.0 KiB Raw Blame History Unescape Escape