ipmideck を提供します。これはサーバーを起動し、管理者
パスワードをリセットし、または自己署名証明書を生成します。
CLI は ipmideck を直接実行する場合 (pip インストールまたはソースチェックアウト) にのみ適用されます。
Docker イメージは
uvicorn backend.main:app を直接起動し、CLI を一切呼び出さないため、これらの
フラグ、バインドの優先順位、単一インスタンスガードのいずれもコンテナーには適用されません。コンテナーのバインドは独自の起動コマンドで設定されます。インストール を参照してください。サーバーの起動
start は主要な配信コマンドです。サブコマンドなしの単独の呼び出しも同一に配信するので、これらは
等価です。
0.0.0.0:3000 にバインドし、すべてのインターフェイスで、
ポート 3000 で到達可能です。起動したら http://<your-ip>:3000 を開いてください。
--host と --port でバインドを上書きします。
サブコマンド
serve は start の非推奨エイリアスです。新しいスクリプトでは start (または単独の ipmideck) を
優先してください。フラグ
これらのトップレベルフラグは配信パスに適用されます。--demo と --config はサブコマンドの分岐の
前に読み取られるので、reset-password と --gen-cert にも影響します。
バインドの優先順位
ipmideck が実際にバインドするホストとポートは、この順序で解決されます。優先度の高い順:- コマンドライン上の明示的な
--host/--portフラグ。 - 設定。これ自体が環境変数 (
IPMIDECK_SERVER_HOST/IPMIDECK_SERVER_PORT) をconfig.yamlより、config.yamlを組み込みデフォルトより優先して解決します。 - ハードコードされたフォールバック
0.0.0.0:3000。初期の設定読み込みが失敗した場合に使用されます。
config.yaml に永続化した値は、次の起動時に IPMIDECK_ 環境変数または
--host / --port フラグによって上書き されます。環境変数と CLI が常に勝ちます。
config.yaml が不正な形式の場合、ipmideck は stderr に警告を出力し、0.0.0.0:3000 にフォールバックします。
IPMIDECK_SERVER_HOST と IPMIDECK_SERVER_PORT 環境変数は IPMIDECK_ プレフィックスを使用します。
上書きの完全な一覧は 設定 を参照してください。—gen-cert による HTTPS
--gen-cert は自己署名証明書とキーを生成し、終了します。サーバーを起動 せず、
HTTPS をそれ自体では 有効にしません。
data/certs/ の下に証明書 + キーのペアを書き込み、それらのパスを config.yaml の server ブロックに
記録し、3 行を出力します。
config.yaml で server.https: true を設定し、ipmideck を再起動します。HTTPS が自動的に有効になることはありません。
デモモード
--demo は実際の BMC ではなくシミュレートされたハードウェアに対して ipmideck を実行します。サーバーを
1 つも接続せずにダッシュボードを評価するのに便利です。
管理者パスワードのリセット
reset-password は管理者ログインを対話的に作成または更新し、サーバーを一度も起動せずに
終了します。
Username: を尋ね、次に New password: (非表示入力) を尋ねます。アカウントがすでに存在する場合、
そのユーザーのパスワードを更新し、Password updated for <username> を出力します。そうでなければ
ユーザーを作成し、User <username> created を出力します。
開発用の自動リロード
--reload は開発専用の高速パスです。uvicorn 自身の自動リロードスーパーバイザーに引き渡して
戻ります。これは意図的に、下記で説明する 単一インスタンスポートガードをスキップ します。
リローダーが独自のスーパーバイザープロセスを実行するためです。
終了コード
配信パス (
--reload ではない) では、ipmideck はバインドの前に単一インスタンスガードを実行します。
ポートがすでに使用中の場合、stderr にエラーを出力し、1 で終了します。アドレスが利用不可または
許可されていないためにバインドが失敗した場合、別個のエラーを出力し、同じく 1 で終了します。
次のステップ
- 設定:
config.yamlのキーとIPMIDECK_環境変数による上書き。 - インストール: Docker または pip で ipmideck をインストールします。
- トラブルシューティング: 接続、ポート、IPMI のエラー。