服务配置 config.yaml
serve 与 service 命令读取的 YAML 配置文件;preview 也读取其中的 preview 节。
配置文件的查找顺序
- 命令行
--config <path> - 环境变量
DOCDOC_CONFIG - 默认路径
~/.config/docdoc/config.yaml(遵循XDG_CONFIG_HOME)
文件不存在时全部使用缺省值。
service 节
| 字段 | 类型 | 缺省 | 说明 |
|---|---|---|---|
host |
string | 0.0.0.0 |
监听地址 |
port |
number | 10001 |
监听端口(TLS 开启后即为 HTTPS 端口) |
dataDir |
string | ~/.local/share/docdoc |
注册表、站点产物与证书的存放目录,~ 会展开为家目录 |
token |
string | 无 | 管理接口 Bearer 令牌;serve 缺此字段拒绝启动 |
managementPort |
number | 无 | 管理 API 独立监听端口(明文 HTTP,仅 /api/v1/sites 子树与健康探针);未设置时管理 API 监听主端口与 HTTP 端口 |
tls.enabled |
boolean | false |
是否启用 HTTPS |
tls.email |
string | 无 | ACME 账户邮箱 |
tls.directoryUrl |
string | Let's Encrypt 正式目录 | ACME 目录地址,联调切 staging |
tls.httpPort |
number | 80 |
HTTP 质询、管理 API 与 301 跳转的监听端口 |
preview 节
| 字段 | 类型 | 缺省 | 说明 |
|---|---|---|---|
host |
string | 127.0.0.1 |
preview 缺省监听地址 |
port |
number | 3000 |
preview 缺省监听端口 |
凭据缓存
add / del 首次通过令牌认证后,令牌按服务器 host:port 缓存在 ~/.config/docdoc/credentials,之后免输;删除该文件中对应条目即可重新输入。令牌本身由服务器配置文件的 service.token 定义。
