Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

設定

laurus-server は CLI 引数、環境変数、TOML 設定ファイルで設定できます。

設定の優先順位

サーバーとインデックスの設定は以下の順序で解決されます(優先度が高い順)。

CLI 引数 > 環境変数 > 設定ファイル > デフォルト値

ログの詳細度は RUST_LOG 環境変数でのみ制御します(デフォルト: info)。

例:

# CLI 引数が環境変数と設定ファイルより優先される
LAURUS_PORT=4567 laurus serve --config config.toml --port 1234
# -> ポート 1234 でリッスン

# 環境変数が設定ファイルより優先される
LAURUS_PORT=4567 laurus serve --config config.toml
# -> ポート 4567 でリッスン

# CLI 引数も環境変数も未設定の場合、設定ファイルの値が使用される
laurus serve --config config.toml
# -> config.toml のポートを使用(未設定の場合はデフォルト 50051)

TOML 設定ファイル

フォーマット

[server]
host = "0.0.0.0"
port = 50051
http_port = 8080  # オプション: HTTP ゲートウェイを有効化

[index]
data_dir = "./laurus_index"

ログの詳細度は設定ファイルではなく、RUST_LOG 環境変数で制御します(デフォルト: info)。

フィールドリファレンス

[server] セクション

フィールドデフォルト説明
hostString"0.0.0.0"gRPC サーバーのリッスンアドレス
portInteger50051gRPC サーバーのリッスンポート
http_portIntegerHTTP ゲートウェイポート。設定すると gRPC と並行して HTTP/JSON ゲートウェイが起動

[index] セクション

フィールドデフォルト説明
data_dirString"./laurus_index"インデックスデータディレクトリのパス

環境変数

変数対応する設定説明
LAURUS_HOSTserver.hostリッスンアドレス
LAURUS_PORTserver.portgRPC リッスンポート
LAURUS_HTTP_PORTserver.http_portHTTP ゲートウェイポート
LAURUS_INDEX_DIRindex.data_dirインデックスデータディレクトリ
RUST_LOGログフィルタディレクティブ(例: info, debug, laurus=debug,tonic=warn
LAURUS_CONFIGTOML 設定ファイルのパス

CLI 引数

オプション短縮形デフォルト説明
--config <PATH>-cTOML 設定ファイルのパス
--host <HOST>-H0.0.0.0リッスンアドレス
--port <PORT>-p50051gRPC リッスンポート
--http-port <PORT>HTTP ゲートウェイポート
--index-dir <PATH>./laurus_indexインデックスデータディレクトリ(グローバルオプション)

よくある設定例

開発環境(gRPC のみ)

[server]
host = "127.0.0.1"
port = 50051

[index]
data_dir = "./dev_data"
RUST_LOG=debug laurus serve --config config.toml

本番環境(gRPC + HTTP ゲートウェイ)

[server]
host = "0.0.0.0"
port = 50051
http_port = 8080

[index]
data_dir = "/var/lib/laurus/data"

最小構成(環境変数のみ)

export LAURUS_INDEX_DIR=/var/lib/laurus/data
export LAURUS_PORT=50051
export LAURUS_HTTP_PORT=8080
export RUST_LOG=info
laurus serve