From 660d4bc4e857a92c6cf6606d2af95d1b5f2f6d04 Mon Sep 17 00:00:00 2001 From: ila <2+ila@noreply.git.ilapage.cn> Date: Tue, 25 Aug 2026 14:59:52 +0800 Subject: [PATCH] docs: document Portal YAML runtime settings (#56) --- Local-Development-and-Verification.-.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Local-Development-and-Verification.-.md b/Local-Development-and-Verification.-.md index 898d392..93a906c 100644 --- a/Local-Development-and-Verification.-.md +++ b/Local-Development-and-Verification.-.md @@ -194,14 +194,14 @@ scripts\chorus-dev.bat restart scripts\chorus-dev.bat stop ``` -`start` 会校验环境文件、本地 MySQL TCP 连接和监听端口，构建临时可执行文件，在后台启动 portal，并检查 `/login`。重复启动不会创建第二个 portal；`restart` 只重启 portal；`stop` 只停止由脚本记录且可执行文件路径匹配的 portal 和 mock 进程。脚本不会执行迁移、GORM AutoMigrate、seed 或创建测试账号。 +`start` 会校验环境文件、`portal/config/settings.yml`、本地 MySQL TCP 连接和监听端口，构建临时可执行文件，以 `--config` 显式传入 YAML 后在后台启动 portal，并检查 `/login`。重复启动不会创建第二个 portal；`restart` 只重启 portal；`stop` 只停止由脚本记录且可执行文件路径匹配的 portal 和 mock 进程。脚本不会执行迁移、GORM AutoMigrate、seed 或创建测试账号。 脚本默认读取仓库外的 `D:\OPC\chorus-tools\chorus-test.env.ps1`；也可把其他可信环境文件作为带引号的第二个参数传入，例如 `scripts\chorus-dev.bat start "D:\tools\chorus local.env.ps1"`。日志、PID 状态和临时可执行文件位于 `%LOCALAPPDATA%\Chorus\dev`。 需要在当前终端观察输出时，仍可运行： ```powershell -go run ./portal +go run ./portal --config portal/config/settings.yml ``` 浏览器验证： @@ -353,6 +353,7 @@ portal: host: 127.0.0.1 port: 8080 environment_file: ../../chorus-tools/chorus-test.env.ps1 + settings_file: ../portal/config/settings.yml admin: settings_file: ../admin/config/settings.yml admin_ui: @@ -360,7 +361,7 @@ admin_ui: port: 9528 ``` -相对路径以 `local-services.yml` 所在目录为基准。配置严格拒绝未知字段、非 loopback Host、无效/重复端口、缺失文件或错误扩展名。`chorus-local-config` 读取 Admin settings 时只投影 `settings.application.host/port`，不会输出其他配置内容。Admin Host/Port 不在统一配置重复保存，避免两个事实源漂移。 +相对路径以 `local-services.yml` 所在目录为基准。Portal `environment_file` 保存数据库、Session 等敏感环境变量；`settings_file` 保存 Provider/worker 运维参数，环境变量优先覆盖 YAML。配置严格拒绝未知字段、非 loopback Host、无效/重复端口、缺失文件或错误扩展名。`chorus-local-config` 读取 Admin settings 时只投影 `settings.application.host/port`，不会输出其他配置内容。Admin Host/Port 不在统一配置重复保存，避免两个事实源漂移。 从仓库根目录执行： @@ -390,7 +391,7 @@ D:\supervisor\supervisord.exe ctl /c D:\supervisor\supervisord.conf status | Supervisor 实例 | 组件 | 地址来源 | |---|---|---| -| `chorus-user` | Portal 与内嵌 worker | `config/local-services.yml` 的 `portal` | +| `chorus-user` | Portal 与内嵌 worker | `config/local-services.yml` 的 `portal` 地址、环境文件和 settings 文件 | | `chorus-admin-api` | Admin API | `admin/config/settings.yml` 的 `settings.application` | | `chorus-admin-ui` | Vue 开发服务 | `config/local-services.yml` 的 `admin_ui`；API 基址由 Admin 地址派生 |