配置参考

配置文件为 YAML,定位顺序:--config 参数 → DOCDOC_CONFIG 环境变量 → 默认路径 ~/.config/docdoc/config.yaml。结构分 Service(服务器)与 Preview(预览默认值)两节。

配置项 用途 默认值 必填 环境变量
Service.Host 服务器监听地址 0.0.0.0 否 —
Service.Port 服务器监听端口,TLS 启用时为 HTTPS 端口 10001 否 —
Service.DataDir 数据目录(站点产物、注册表、证书) ~/.local/share/docdoc 否 —
Service.Token 管理 API 的 Bearer Token — serve 必填 —
Service.ManagementPort 管理 API 独立监听端口(明文 HTTP,仅对内网开放) 未设置 否 —
Service.TLS.Enabled 启用 HTTPS 与 ACME false 否 —
Service.TLS.Email ACME 账户邮箱 — TLS 启用时必填 —
Service.TLS.DirectoryURL ACME 目录地址 https://acme-v02.api.letsencrypt.org/directory 否 —
Service.TLS.HTTPPort HTTP 质询、管理 API 与 301 跳转监听端口 80 否 —
Preview.Host preview 缺省监听地址 127.0.0.1 否 —
Preview.Port preview 缺省监听端口 3000 否 —
(全局)配置文件路径 配置文件定位 ~/.config/docdoc/config.yaml 否 DOCDOC_CONFIG

preview 命令的 --host / --port 参数覆盖 Preview 节取值。