Files
pikasTech-unidesk/docs/reference/config.md
T
2026-05-04 11:09:35 +00:00

1.3 KiB

UniDesk Configuration Reference

根目录 config.json 是 UniDesk CLI 的唯一配置来源。CLI 启动时必须完整校验配置结构,读取失败或字段不合法时直接返回 JSON 错误,不允许静默 fallback。

Runtime

TypeScript 运行时固定为 Bun。根目录 CLI、backend-core、frontend 和 provider-gateway 都直接运行 .ts 入口;Docker 镜像使用 oven/bun 基础镜像,本机命令使用 bun scripts/cli.ts

Fixed Ports

config.json 中固定三个对外端口:backend-core、frontend、database。network.publicHost 必须是浏览器和外部客户端可访问的主 server 地址;公网 E2E 不允许把它保留为 127.0.0.1server start 会在启动前检查这些端口,避免因端口冲突产生多个版本混乱的服务实例。

Compose Env Generation

Docker Compose 本身不读取 JSON,因此 CLI 会从 config.json 生成 .state/docker-compose.env。该文件是派生状态,不应手写;如需改端口、token、provider 标签或主机名,应修改 config.json 后重新运行 CLI。

Secrets

当前配置面向主 server 开发部署,包含开发用数据库密码和 provider token。公网暴露前必须在 config.json 中修改这些值,并重新启动栈以刷新派生环境文件。