Docs / リファレンス

Configuration Reference

通常の運用で触る項目と、実装上の上級設定を分けて記載します。

まず Compose を見る

Docker運用では docker-compose.yml の置換変数が利用者向けの入口です。backend内部の調整用変数を、通常設定として並べることはしません。

Composeで設定する項目

項目	用途	既定値
`VYLINE_IMAGE`	使用するコンテナimage	`ghcr.io/tqmane/vyline:latest`
`VYLINE_BIND_ADDRESS`	ホスト側で公開するアドレス	`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`	コンテナ内タイムゾーン	`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側で固定されています。

backendの通常設定

変数	意味	既定値
`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 の意味は Access Model を参照してください。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のpath	`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の環境変数を変えた後はcontainerをrecreateしてください。