Docs / 参考

配置参考

把日常运维需要的设置与实现层面的高级配置分开说明。

先看 Compose

Docker 运维时，docker-compose.yml 中的替换变量是普通用户配置入口。Backend 内部调优变量不会和常规设置混在一起。

Compose 配置项

项目	用途	默认值
`VYLINE_IMAGE`	使用的 container image	`ghcr.io/tqmane/vyline:latest`
`VYLINE_BIND_ADDRESS`	主机侧 published port 绑定地址	`0.0.0.0`
`VYLINE_PORT`	主机侧 Web 端口	`3000`
`VYLINE_DATA_PATH`	`/app/data` 的主机保存路径	`./data`
`VYLINE_STORAGE_PATH`	`/app/storage` 的主机保存路径	`./storage`
`VYLINE_LAN_ACCESS`	LAN/subdevice 访问行为	`false`
`VYLINE_TRUST_REMOTE_OWNER`	把受保护路径上的 remote browser 作为 owner	`false`
`TZ`	container 内时区	`Asia/Tokyo`

# 示例：仅在 localhost 发布
VYLINE_BIND_ADDRESS=127.0.0.1
VYLINE_PORT=3000
docker compose up -d

pull_policy: always、restart: unless-stopped、init: true、stop_grace_period: 30s 固定写在 Compose file 中。

变量	含义	默认值
`PORT`	Backend listen 端口	`3001`；Compose 设置为 `3000`
`VYLINE_HOST`	Backend listen 地址	通常为 loopback；Compose 使用 `0.0.0.0`
`VYLINE_DATA_DIR`	账号状态、设置、DB、日志、备份等 root	Backend 的 `data`；Compose 使用 `/app/data`
`VYLINE_STORAGE_DIR`	cache、已保存媒体等 root	Backend 的 `storage`；Compose 使用 `/app/storage`
`VYLINE_CDN_CACHE_DIR`	把贴图等 CDN cache 放到其他路径	`VYLINE_STORAGE_DIR/cache/cdn-cache`
`VYLINE_MEDIA_CACHE_DIR`	保存媒体的兼容设置，在未配置 `VYLINE_MEDIA_STORAGE_DIR` 时使用	`VYLINE_STORAGE_DIR/saved-media`
`VYLINE_CORS_ORIGIN`	允许的 CORS origin，多个值用逗号分隔	`http://localhost:5173`
`VYLINE_STATIC_DIR`	Backend 提供的 Frontend build	`Vyline/apps/desktop/dist`
`VYLINE_DEVICE`	Protocol device mode	`IOSIPAD`

VYLINE_LAN_ACCESS 与 VYLINE_TRUST_REMOTE_OWNER 的含义见访问模型。它们属于认证/信任设置，与 bind address 分开。

下面变量确实会被 Backend 读取，但普通 Compose 使用不需要设置。只有在明确改变路径布局或 API 运维方式时才使用。

变量	内容	默认值
`VYLINE_PUBLIC_HOST`	为 subdevice pairing 指定外部 host	未设置时从 request 信息解析
`VYLINE_API_ADMIN_SECRET`	管理 API（如 token 操作）认证；未设置时管理 API 关闭	未设置
`VYLINE_OPENAPI_PATH`	替换 `/openapi.yaml` 使用的 YAML 文件	仓库 root 的 `openapi.yaml`
`VYLINE_MAX_REQUEST_BODY_BYTES`	HTTP request body 上限	与 backup storage limit 相同
`VYLINE_PLUGIN_DIR`	plugin directory	`VYLINE_DATA_DIR/plugins`
`VYLINE_LOG_DIR`	诊断与 message log directory	`VYLINE_DATA_DIR/logs`
`VYLINE_BACKUP_DIR`	VylineBackup snapshot directory	`VYLINE_DATA_DIR/backups`
`VYLINE_MEDIA_STORAGE_DIR`	已保存媒体 directory	`VYLINE_STORAGE_DIR/saved-media`
`VYLINE_ICON_CACHE_DIR`	单独指定 icon cache 路径	`VYLINE_STORAGE_DIR/cache/icons`
`VYLINE_MEDIA_INDEX_PATH`	media index SQLite 路径	`VYLINE_STORAGE_DIR/media-index.sqlite`

VYLINE_SQLITE_*、VYLINE_BACKUP_HEAVY_*、VYLINE_CONTACT_*_TIMEOUT_MS 等是用于性能、容量与故障诊断的实现参数。它们会随代码和测试变化，因此这里不把它们固定成用户配置 API；需要时直接查看对应模块实现。

信息源

用户配置以 docker-compose.yml 与 .env.example 为准，高级配置以 Vyline/backend/src 实现为准。修改 Compose 环境变量后请 recreate container。