環境設定 (.env)

Komugi は起動時に実行ディレクトリ内の .env ファイルを自動的に読み込みます。未設定の項目には安全な既定値が適用されます。

設定ファイルの準備

cp .env.example .env

最低限必要な設定 (必須項目)

Komugi を起動するには、転送先となるバックエンドサーバーのアドレス (TARGET_HOST) が必ず必要です。

# 転送先 Bedrock サーバーのアドレス (ドメイン名または IP)
TARGET_HOST=mc.example.com

# 転送先サーバーの Bedrock ポート (既定: 19132)
TARGET_PORT=19132

推奨構成例

一般的なマルチサーバー環境（Velocity / Geyser / Paper 構成など）で推奨される設定例です。

# ── ネットワーク ──────────────────────────────────
# リレー待受アドレスとポート (クライアントはこのアドレスに接続します)
RELAY_HOST=0.0.0.0
RELAY_PORT=19132

# 転送先サーバー (メインのプロキシまたはロビーサーバー)
TARGET_HOST=mc.example.com
TARGET_PORT=19132

# ── サーバー表示 ──────────────────────────────────
MOTD_TITLE=Komugi Relay Server
MOTD_SUBTITLE=Bedrock MITM Proxy

# ── 動作・ログ ────────────────────────────────────
MAX_PLAYERS=20

# ログ出力先: stdout (標準出力) | file (ファイル追記) | sqlite (SQLite保存)
LOG_OUTPUT=sqlite
LOG_DB_PATH=./komugi-logs.db

# ── ユーザー情報 ──────────────────────────────────
DB_PATH=./komugi.db
DEFAULT_SERVER=lobby

# ── リソースパック ────────────────────────────────
RESOURCE_PACK_CACHE=./packs-cache
TEXTURE_PACKS_REQUIRED=true

# ── PROXY Protocol (実IP転送) ──────────────────────
# Geyser 側で bedrock.enable-proxy-protocol: true にしている場合は true
ENABLE_PROXY_PROTOCOL=false

設定カテゴリの概要

カテゴリ	主な用途	主要な環境変数
ネットワーク	受付アドレスと転送先の設定	`TARGET_HOST`, `TARGET_PORT`, `RELAY_HOST`, `RELAY_PORT`
MOTD表示	Bedrock サーバーリストに表示される文言	`MOTD_TITLE`, `MOTD_SUBTITLE`
ログ管理	パケット中継ログ・エラーログの保存先	`LOG_OUTPUT`, `LOG_FILE`, `LOG_DB_PATH`, `LOG_PACKETS`
ユーザーDB	最終位置サーバーやプレイヤーUI設定の永続化	`DB_PATH`, `DEFAULT_SERVER`
死活監視・Limbo	バックエンド停止時の切断遮断と待機	`LIMBO_HOST`, `LIMBO_PORT`, `BACKEND_POLL_INTERVAL`
リソースパック	上流サーバーのパック自動中継・キャッシュ	`RESOURCE_PACK_CACHE`, `TEXTURE_PACKS_REQUIRED`
IPC ソケット	`komugi status` コマンド用の UNIX ソケット	`STATUS_SOCKET_PATH`

設定が完了したら、次は初回起動と認証へ進んでください。