コンテンツにスキップ

設定

このページでは、コンテナの環境変数、テンプレートが用意するマウント、セキュリティモデル、SSH 経由の VM バックアップ、オフサイトの設定を説明します。バックアップの行き先は、環境変数ではなく、アプリ内で保存先として設定します。

環境変数

変数 必須 説明
APP_KEY はい restic リポジトリのパスワードを導出するための、32 バイトの 16 進数のシークレット(16 進数 64 文字)。openssl rand -hex 32 で生成します。安全に保管してください。なくすと、暗号化されたバックアップは復元できなくなります。
LIBVIRT_HOST VM と ZFS データセットで必要 VM と ZFS データセットのバックアップで SSH 接続する Unraid ホスト(テンプレートのフィールド Host SSH: Address、標準は host.docker.internal)。テンプレートはプレースホルダー 192.168.x.x を事前入力していますが、これは未設定として扱われます。Unraid の LAN IP を使ってください。カスタムの br0.x ネットワークでは必須です。TrueNAS のアプリのように host.docker.internal が名前解決できず、LIBVIRT_URI にもホストの指定がない場合、BombVault はコンテナのデフォルトゲートウェイを使い、起動ログにその名前を書きます。
LIBVIRT_SSH_PORT いいえ VM と ZFS データセットのバックアップに使うホストの SSH ポート(テンプレートのフィールド Host SSH: Port、標準は 22)。
LIBVIRT_SSH_USER いいえ VM と ZFS データセットのバックアップに使う、ホストの SSH ユーザー(テンプレートのフィールド Host SSH: User、標準は root)。
LIBVIRT_URI いいえ libvirt の完全な接続 URI。上の 3 つの LIBVIRT_* 変数から作る代わりに、そのまま使われます(その場合、3 つの変数は接続文字列には使われません)。標準では未設定です。TrueNAS Scale では必要です。その libvirtd は、組み立てた文字列の形では表せない標準外のソケットで待ち受けているからです:qemu+ssh://<user>@<truenas-host>/system?socket=/run/truenas_libvirt/libvirt-sock。VM バックアップガイドを参照してください。qemu+ssh:// の URI の場合、未設定の LIBVIRT_HOST、LIBVIRT_SSH_USER、LIBVIRT_SSH_PORT は URI から取られます。BombVault 自身の SSH コマンド(NVRAM の転送、ZFS データセット)でも同様です。
PORT いいえ HTTP ポート(標準は 3000。HTTP_ONLY=true のときだけ使われます)。
HTTPS_PORT いいえ HTTPS ポート(標準は 3443。テンプレートは 1 対 1 で公開するので、WebUI は https://<ip>:3443 で応答します)。
HTTP_ONLY いいえ true にすると、自己署名の HTTPS リスナーを無効にして、通常の HTTP だけで提供します(TLS を終端するリバースプロキシの背後で使う場合)。
BIND_HOST いいえ WebUI が待ち受けるアドレス(標準は 0.0.0.0、すべてのインターフェース)。コンテナでは未設定のままにしてください。公開されたポートにはすべてのインターフェースが必要です。Docker の外で実行する場合は 127.0.0.1 が向いています。ヘルスチェックも同じアドレスに問い合わせます。
TRUSTED_PROXY いいえ BombVault の前にあるリバースプロキシのアドレスまたは CIDR 範囲を、カンマ区切りで指定します(例:192.168.20.11 や 10.0.0.0/8)。X-Forwarded-For が信用されるのはそれらの経由地からだけで、ログインのスロットルは、プロキシの背後の全員を 1 つの枠に入れる代わりに、実際のクライアントごとに失敗を数えるようになります。未設定(標準)では誰も信用しません。無条件に信用されるヘッダーがあると、呼び出し元が自分で枠を選べてしまうからです。
HOST_SOURCE_ROOT いいえ ホストデータとしてマウントされるホストのパス(標準は /mnt)。BombVault は、Docker が報告するバインドマウントのソースを、このマウントの下のパスに変換します。別のホストルートをマウントした場合にだけ変更してください。
HOST_MOUNT_ROOT いいえ コンテナ内でホストデータがマウントされる場所(標準は /host/user)。TrueNAS では、ホストデータはホスト自身のパスにマウントされるため、これと HOST_SOURCE_ROOT はどちらもそのパス(たとえば /mnt/tank)を指します(TrueNAS SCALEを参照)。
DATA_ROOT_SEGMENTS いいえ バインドマウントのソースをバックアップデータとして扱うパスのセグメント名を、カンマ区切りで指定します(標準は appdata。Unraid の /mnt/user/appdata/<container> の慣習に合わせています)。コンテナのバインドマウントは、挙げられたセグメントのどれかが、ホスト側のソースの完全なパスセグメントとして現れると、バックアップ対象に自動選択されます。たとえば DATA_ROOT_SEGMENTS=appdata,config にすると、.../config のバインドも拾います。一致判定は大文字小文字を区別しないので、標準でも ZimaOS の /DATA/AppData/<container> に一致します。コンテナのデータフォルダーを見つける、常に有効なほかの方法についてはバックアップ元の検出を参照してください。
PLATFORM いいえ 自動検出する代わりに、BombVault が自分をどのプラットフォームで動いていると見なすかを強制します:unraid、generic、truenas(標準は未設定で、フラッシュのマウント下にある dockerMan マーカーを調べて Unraid を自動検出し、それ以外は generic です。認識できない値も generic に戻り、ログに記録されます)。汎用 Docker ホストや TrueNAS Scale では、Unraid 専用の自動判定に頼らず、明示的に設定してください。汎用の compose ファイルはそうしています。appdata のフォールバックの慣習、インスタンス間の復元先の標準、そして Unraid 専用の通知やコンパニオンプラグインの手順を試みるかどうかが変わります(internal/platform を参照)。
BOMBVAULT_SELF_CONTAINER いいえ BombVault コンテナ自身の名前。自分自身をバックアップして(つまり停止して)しまうことがなくなります。
BACKUP_MAX_HOURS いいえ 1 回のバックアップ実行が、そのドメインのロックを保持できる最大の実時間(時間)。これを超えると強制キャンセルされます(止まった実行がドメインを永久にふさがないようにする保護です)。空(標準)なら 48 を使います。非常に大きい、または遅いクラウドバックアップでは引き上げてください(上限で中止された実行は context deadline exceeded で失敗します)。0 にすると上限を完全に無効にします。プルーンも同じ上限に従い、チェックとプルーンは restic が進捗を報告し続ける限り実行されます。
BACKUP_STALL_HOURS いいえ バックアップがまったく進捗しないまま、キャンセルされるまでの時間。空(標準)なら 2 を使います。0 にすると、停滞してもキャンセルしません。2 つの保護のうち細かいほうで、通常はこちらが働きます。実行にかかった時間ではなく、何かがまだ起きているかを見ているので、遅くても健全な数 TB のバックアップはそのまま続き、応答しない共有で止まったものは、何日もかけずに数時間で停止されます。30 分間何もないと、何かをキャンセルする前に警告がログに出ます。スキャンは進捗として数えられます。大きなツリーをたどっているあいだ restic はバイトを書き込まないので、その段階は書き込んだバイト数ではなく、ファイル数とバイト数の合計で監視されます。2 つの変数は独立しており、BACKUP_MAX_HOURS は、バックアップ本体のあとの段階(保持処理、統計、オフサイトコピー)を、監視できるカウンターがないため、引き続き制限します。
DB_DUMP_MAX_HOURS いいえ 1 回の自動データベースダンプが、停止されるまで実行できる時間。空(標準)なら 6 を使います。1 から 48 が使え、上限は BACKUP_MAX_HOURS より 1 時間低く保たれます(それが 2 時間未満なら半分)。長いダンプはバックアップ全体を巻き込むことなく、自身の上限で打ち切られ、そう報告されます。進捗のないダンプは、それより早く、BACKUP_STALL_HOURS のあとに停止されます。停止されたダンプは単独で失敗し、コンテナのバックアップは続行します。Unraid では、Add another Path, Port, Variable で BombVault コンテナに追加してください。
TZ いいえ スケジューラーのタイムゾーン(例:Europe/Berlin)。未設定のままだと、すべてのスケジュールが UTC で動きます。たとえば 02:30 に設定したものは、自分の壁時計ではなく UTC の 02:30 に実行されます。Unraid では自分で設定する必要はありません。システムが自身のタイムゾーンをすべてのコンテナに渡します。起動ログには、どのゾーンに解決されたかが書かれます。夏時間のあるゾーンでは、春に 1 回の実行が飛ばされ、秋に 1 回が二重に実行されます。UTC はどちらもありませんが、年に 2 回、自分の時計と 1 時間ずれます。
DATA_DIR いいえ BombVault がデータベース、鍵、キャッシュを置く場所(標準は /config)。コンテナ内ではそのままにしてください。バイナリを Docker の外で動かすときに意味を持ちます。
FLASH_DIR、FLASH_TEMPLATES_DIR いいえ コンテナ内で、フラッシュドライブとその Docker テンプレートがマウントされる場所(標準は /host/boot と /host/boot/config/plugins/dockerMan/templates-user)。テンプレートの /boot マウントに従うので、未設定のままにしてください。
MODE いいえ full(標準)はアプリ全体を動かします。node はノードを動かします。Web 画面も自分のスケジュールもなく、ホームインスタンスが指示したことだけを行います。それ以外の値では、メッセージを出して起動を止めます。ノードの compose ファイルでは、ホームインスタンスが代わりに入れます。
NODE_HOME ノードで必要 ノードがどのホームインスタンスに属するかを、ホームインスタンスの鍵とリレーとともに、bvhome1. で始まる 1 つの値で示します。ホームインスタンスがノードの compose ファイルに書き込みます。ないとノードは起動しますが、どのホームインスタンスからも届きません。あるホームインスタンスが引き受けたノードは、NODE_HOME が別のホームインスタンスを指している場合、そのホームインスタンスが解放するまで起動を拒否します。
NODE_NAME いいえ ノードの名前。付けた名前をもとにホームインスタンスが入れます。

マウント

CA テンプレートに示されているとおり、Docker ソケット、フラッシュ(/boot)、ホストデータのルート(/mnt)をマウントします。バックアップのソースと保存先は、どちらもホストデータの下にあり、slave でマウントされるので、コンテナの起動後にマウントされるリモート共有(たとえば /mnt/remotes の下)も、再起動なしで見えるようになります。

TrueNAS では、ホストデータは /mnt/tank のようなデータセットのパスで、ixVolume ではありません。アプリが ixVolume に置いたデータは、その外にあり、バックアップされません。TrueNAS SCALEを参照してください。

ZFS データセットのバックアップにも、このモードが必要です。ホストは、コンテナが起動してからでないと、データセットのスナップショットをマウントしないからです。ZFS データセットを参照してください。

ローカルリポジトリは、標準では /mnt/user/bombvault/{container,vms,flash,config,files,zfs} で、最初のバックアップで作られます。これらはセクションの専用フォルダーで、ローカルの保存先になります。保存先の下のそのページにある接続カードで、セクションごとのフォルダーを変更できます。

セクションの専用フォルダーは、すでにある保存先(NAS や S3 バケットなど)の中に置くこともできます。その保存先のページで専用フォルダーにするを使うと、そこに移され、先に、すでに作ったバックアップがどうなるかが示されます。セクションの専用フォルダーを参照してください。

ローカルリポジトリのフォルダーは、モード 0755 と 0644 のままなので、SMB 経由の root 以外の同期ユーザーが締め出されることはなく、リポジトリは暗号化されているので何も露出しません。復旧用の定義は各リポジトリの中にあるため、コピーしたフォルダーはそれだけで完結しています。セルフバックアップのリポジトリは、root だけが読み取れるままです。

ホスト統合のチェック

概要のホスト統合カード(カスタマイズで追加します)は、すべてのマウントと CLI(Docker ソケット、libvirt、restic、qemu-img、rclone)を調べて、足りないものを報告します。

バックアップ元の検出

BombVault は、コンテナごとに、どのバインドマウントと名前付きボリュームをバックアップするかを自動選択します。次のどれかに当てはまると、そのパスが選ばれます(結果はコンテナの設定タブのバックアップ対象フォルダカードでいつでも上書きできます)。

  • データルートのセグメントの一致: バインドのホスト側ソースに、DATA_ROOT_SEGMENTS のセグメントのどれかが、完全なパスの構成要素として含まれる(標準は appdata のみ)。
  • Docker の名前付きボリュームは、使い捨ての代替物がなく、絞り込むものがないため、常に含まれます。ただし、ボリュームの実際のホスト上の保存パスが、ホストデータのマウントを通じて到達できる場合に限ります。BombVault がバックアップするほかのホストのパスと同じです。Docker の標準のローカルボリュームドライバーは、ボリュームをデーモン自身のデータルート(カスタマイズしていなければ /var/lib/docker/volumes/<name>/_data。docker info -f '{{.DockerRootDir}}' で確認できます)の下に保存しますが、そこは、汎用の docker-compose.yml が標準で使う、狭い、単一ディレクトリのホストデータのマウントでは届きません。届かないボリュームは、エラーにならず黙ってスキップされます。汎用ホストで名前付きボリュームを実際にバックアップするには、ホストデータ(と HOST_SOURCE_ROOT)を、Docker のデータルートも含む共通の親フォルダーに向けてください。compose ファイルのホストデータのコメントに、トレードオフが説明されています(Unraid は、同じ理由で、独自の汎用的な最上位の慣習である /mnt 全体をマウントすることで、これを回避しています)。
  • Docker Compose のプロジェクトディレクトリ: コンテナが標準の com.docker.compose.project.working_dir ラベル(docker compose up が自動で設定します)を持っていれば、データルートのセグメントに一致するバインドがあるかどうかに関係なく、そのディレクトリも追加されます。
  • bombvault.data ラベルによる上書き: コンテナにラベル bombvault.data=true を設定すると、そのすべてのバインドマウントが含まれます。上の 2 つの慣習のどちらにも当てはまらない構成(たとえば Compose プロジェクトのない 1 つの /srv/plex/config バインド)向けです。false 以外の空でない値は、真として扱われます。ラベルがない場合や bombvault.data=false では、何も変わりません。
  • bombvault.dbdump ラベル: コンテナに bombvault.dbdump=false を設定すると、自動データベースダンプがオフになります(0、no、off も同じです)。または、BombVault が自分で認識しないコンテナをダンプするために、エンジン名(postgres、mysql、mariadb)を指定します。ラベルは、コンテナの設定タブのデータベースカードのスイッチより優先されます。Unraid ではそちらのカードを使うのが普通です。

セキュリティモデル

ホストに対する root 相当の制御

Docker ソケットを通じて、BombVault はコンテナの停止、削除、再作成を行い、appdata の読み書きができます。また VM バックアップのために、ホストに SSH(qemu+ssh://、標準では root)でログインして virsh を実行します。その Web UI に到達できる者は、実質的にホストの root 権限を持つことになります。

ログイン

  • 任意のパスワード保護(設定、セキュリティ のパスワードカード):パスワードを設定するとログインが必要になり、消去すると無効になります。信頼できる LAN で使うことを想定して、標準ではオフです。パスワードは、APP_KEY をキーとするペッパーを付けた Argon2id で保存されるので、コピーした /config は鍵がなければ無価値で、鍵があっても攻撃に時間がかかります。新しいパスワードは 12 文字以上が必要です。既存の短いパスワードは、変更するまで引き続き使えます。セッションは署名され(APP_KEY から導出した HMAC)、パスワードを変更すると無効になります。ログインは、クライアントごとに 1 分間に 5 回の失敗までに制限されます。パスワードの変更や消去には、現在のパスワードと、二段階認証がオンのときはコードが必要です。
  • パスワードが必要なことがあります。 リカバリーキット、バグ報告、フラッシュバックアップの ZIP のダウンロード、フラッシュバックアップやセルフバックアップのエクスポート、鍵の保管側への鍵の預け入れ、預け入れの引き渡しの許可、新しいリカバリーコードの作成、認証情報つきの設定のエクスポート、二段階認証、パスキー、ノードの追加、ノードの compose ファイルの再表示、ノードの項目を開くことは、ログインパスワードが設定されるまで拒否され、そのインスタンス自身でのサインインが必要です。バックアップの削除はパスワードがなくても行えます。パスワードを設定している場合は、削除にもこのサインインが必要です。
  • 保存先にパスワードは表示されません。 保存先には rest:https://user:password@host/repo のように認証情報を含められますが、どのページでも API の応答でも、ログインパスワードの有無にかかわらず rest:https://[redacted]@host/repo と表示されます。その後ろのパスを変えても、保存されたパスワードはそのまま残ります。保存先を別のサーバーに向けるときは、パスワードを含めて保存先全体を入力してください。隠されたパスワードは、元のサーバーにひも付いたままだからです。
  • 二段階認証(設定、セキュリティ):パスワードに加えて、認証アプリの時間コードを使います。オンにしたときに一度だけ渡される、使い捨てのリカバリーコード 8 個もあります。共有シークレットは APP_KEY で暗号化されて保存され、二段階認証をもう一度オフにするには、現在のコードが必要です。
  • パスキー(WebAuthn)は、パスワードの設定後に専用のカードに表示され、パスワードと併用するものでパスワードの代わりにはならないので、すべてのパスキーを削除しても誰も締め出されません。実在するドメイン名と、ブラウザーが信頼する証明書が必要です。標準の https://<ip>:3443 は、まさに WebAuthn が拒否するもので、カードは、失敗するボタンを出す代わりにそう伝えます。二段階認証がオンの場合、パスキーは PIN、指紋、顔の確認を行う必要があり、そうでなければサインインでコードも求められます。
  • 設定の復元(緊急ウィザードの設定を戻す)は、すべてのセッションを終了し、すべてのパスキーを削除し、すべての API トークンと MCP キーを取り消します。復元される設定が、保存後に削除されたものを戻してしまうおそれがあるからです。パスワードでサインインし、設定、セキュリティ でパスキーを設定し直してください。
  • 忘れたパスワードは、ログインページでリセットします。パスワードをお忘れですか?を押すと、BombVault が 12 文字(4 文字 3 組)のコードをコンテナのログに書き込みます(Unraid では、Docker タブの BombVault アイコンからログ)。そのコードと新しいパスワードで、サインインできます。リセットでは、二段階認証がオフになり、すべてのパスキーが削除され、すべての API トークン、MCP キー、OAuth サインインが取り消され、ほかのすべてのセッションが終了し、ペアリング済みのスマートフォンはすべてサインアウトされ、スマートフォンのペアリングがオフになります。その後のページに、なくなったものが一覧されます。コードの有効時間は 10 分で、間違った推測では消費されません。ウィジェットとメトリクスのトークンは読み取りしかしないため、そのまま残ります。
  • コンテナのログを読める人は、パスワードをリセットできます。 それはホストの root のことですが、Dozzle のようなログビューア、Docker ソケットを渡されたコンテナ(読み取り専用でも十分です)、コンテナの出力を転送するログ転送ツールも同じです。パスワードを預けてもよい人にだけ、これらを渡してください。Web 画面にしか到達できない人が、コードを目にすることはありません。

スマートフォンとグループのメンバー

  • ペアリング済みのスマートフォンが届くのは許可リストの範囲です。 グループの 12 個の単語を知っているスマートフォンは、設定、セキュリティ の Android アプリカードでグループの12個の単語でスマートフォンをペアリングできるがオンのあいだ、パスワードなしでサインインします。そのセッションが届くのは、アプリが表示するものだけです。概要、実行、見るためのバックアップ、開始と復元、読むための異常、見るためのインスタンスのページです。保存先とコマンドは、アドレスとシークレットを取り除いた形で届き、元のものを置き換える復元は、先に現在の状態をバックアップします。フォルダーへの復元が受け付けるのは、復元フォルダーの中の新しいフォルダーか空のフォルダーだけで、スマートフォンからはほかのフォルダーの中を見られません。それ以外はすべて、そのインスタンス自身でのサインインが必要だと応答します。鍵、リカバリーキット、鍵の預け入れ、設定、バックアップの削除です。パスワードをリセットすると、もう一度オンにするまでスマートフォンのペアリングはオフになります。インスタンスのページから削除されたスマートフォン、または詳細でこのインスタンスを照会をオフにされたスマートフォンは、すぐにセッションを失い、削除されたスマートフォンがアプリをもう一度開くと、オフの状態で戻ってきます。
  • 外出先では、スマートフォンはリレー経由でページを開きます。 ページの各リクエストは、リレーが読むことも変更することもできないグループの鍵で封じられ、スマートフォンの最初の呼び出しでサーバーが固定し、誰かがペアリングページでそのスマートフォンを承認すると受け入れる、スマートフォン自身の鍵で署名されます。サーバーはリクエストを一度だけ、それが新しいあいだだけ実行します。スマートフォンのペアリングがオンのあいだにインスタンスのページに載っているスマートフォンだけに、そしてそのスマートフォンに渡したセッションでだけ応答するので、すべての場所でのサインアウトやパスワードのリセットで、これらのページも終了します。サーバーはすべての応答に署名し、アプリはその署名を、そのサーバーについて固定した鍵と照合して、鍵が変わると警告します。そのようなページは、ログインパスワードの有無にかかわらず、ペアリング済みのスマートフォンと同じ許可リストと、ページが最初に読むサインイン状態に届きます。サインインとサインアウト、パスワードのリセット、ダウンロードはサーバー自身のアドレスにとどまり、1 つの応答は 16 MB が上限です。
  • メンバーは、求めるものに署名します。 ロールの要求とその応答、保存先の提供、restic のパスワードのレシーバーや取得側への引き渡し、レシーバーのログイン、鍵の預け入れは、各メンバーの鍵で署名されます。インスタンスは、そのメンバーを最初に見たときにその鍵を固定します。別の鍵で署名された呼び出しは拒否されます。インスタンスの詳細のキーを忘れるは、固定した鍵を破棄します。ここで知られている鍵がメンバー自身のものでない場合のためです。メンバーは、次に署名する呼び出しで、もう一度鍵を求められます。BombVault 9.x のメンバーは署名しないため、9.9 と同じように、単語を知っている人なら誰でもなりすませます。10.4 以前のメンバーからのロールの要求や保存先の提供は、そのメンバーが更新されるまで拒否されます。
  • 12 個の単語はパスワードです。 それを持つ人は誰でもグループに加わり、メンバーの保護状況を見て、ロールを求められます。ロールは、もう一方のインスタンスの人が許可する必要があります。ログインパスワードがないと、Web 画面を開ける人なら誰でもそれを読めてしまい、ペアリングカードはパスワードが設定されるまでそう伝えます。

鍵

  • APP_KEY は 2 つのことをします。 このインストールが保存するもの(パスワード、認証情報、トークン)を封じ、そしてバックアップの鍵でもあります。restic のパスワードがそこから導出され、コンテナと VM の定義がそれで封じられます。
  • 引き継いだ鍵は別に保管されます。 緊急ウィザードがほかのサーバーのバックアップを引き継ぐとき、このインストールは自分の APP_KEY で封じ続け、相手のサーバーの鍵をバックアップ鍵として、ほかのシークレットと同様に封じて保存します。リカバリーキットには両方が印字されます。その後 APP_KEY を変更すると、バックアップ鍵は開けなくなります。BombVault は、間違った鍵で書き込む代わりに、バックアップを止めて、要対応でそう伝えます。復元、緊急 でリカバリーキットをもう一度アップロードするか、APP_KEY を元に戻してください。緊急ウィザードを参照してください。
  • 暗号化は標準でオンです(設定、セキュリティ の暗号化カードのバックアップを暗号化)。バックアップは、バックアップ鍵から導出したパスワードで、restic によって暗号化されます。
  • 鍵の預け入れ。 グループ内の鍵の保管側は、このサーバーのリカバリーキットの封じた写しを保持していて、自分では開けません。開けるのは 20 文字のリカバリーコードだけで、保管側がそれを渡すのは、そこで誰かが許可を押したあとだけです。鍵の保管側を参照してください。

ノード

ノードは Web 画面のない BombVault で、ホームインスタンスから指示を受けます。

  • ホームインスタンスがノードを握ります。 ノードは自分のサーバーの Docker ソケットをマウントし、それはそのサーバーの root と同じです。そしてホームインスタンスがノードを操作します。ホームインスタンスを乗っ取られると、攻撃者はそのノードもすべて操作できます。ホームインスタンスにはログインパスワードを設定し、その Web 画面をインターネットに出さないでください。
  • ノードが持つものはわずかです。 ノードを乗っ取られても、攻撃者はペアリンググループも、要塞も、ほかのノードも、ほかのリポジトリも手に入れられません。ノードが持つのは、自分のホームインスタンスへの経路、受信サーバーでの専用のログイン、保存先での専用のフォルダーだけです。受信サーバーは append-only なので、ノードはそこで履歴を削除できません。rest-server には容量制限がないので、サーバーのディスクを埋めることはできます。受信サーバーには十分な空きか専用の共有を用意してください。保存先では、ノードの認証情報でたいていそこにあるものを削除できます。ノードに保管したバックアップは攻撃者の手に渡ります。そのため、ホームインスタンスがそのコピーを取得します。
  • 経路はプライベートで、署名されています。 ホームインスタンスとノードは、ノードの APP_KEY から導出した秘密で封じた専用の経路で、リレー越しに話します。どちらも最初の呼び出しの前に相手の鍵を知っているので、承認の手順はありません。ホームインスタンスは呼び出しのたびに自分の鍵とカウンターで署名し、ノードは、ホームインスタンスの署名がない呼び出しや、すでに受け取った呼び出しを拒否します。ノードがホームインスタンスに送るのは、あいさつだけです。
  • ホームインスタンスが届くのは決まった一覧だけです。 ホームインスタンスがノードに中継する要求は、GET /api/nodes/routes に一覧されたノードのルートの決まった一覧だけで動き、ノードはそれに JSON だけで答えます。一覧には、削除を行うものも、設定、ストレージ、鍵、グループ、トークンに届くものもありません。ホームインスタンスでは、これらにパスワードでのサインインが必要です。ペアリングしたスマートフォン、API トークン、MCP キーはノードに届きません。こうして開始したバックアップと復元は、ホームインスタンスによる開始として表示されます。
  • 鍵の預け入れにはノードの鍵が含まれます。 ホームインスタンスは各ノードの APP_KEY を保管し、リカバリーキットはそれをノードの章に印字するので、鍵の預け入れにも含まれます。預け入れとリカバリーコードを受け取った鍵の保管側は、ノードのリポジトリを開けます。ただし、ノードを操作するにはホームインスタンスの署名が必要なので、ノードに指示することはできません。
  • 解放は取り消せません。 解放したノードは、同じ APP_KEY では二度とホームインスタンスを持てません。解放したときにつながっていなかったノードは、戻ったときにホームインスタンスからそれを受け取ります。

ネットワーク

  • 変更には JSON が必要です。 何かを変更するリクエストは Content-Type: application/json を送る必要があり、ブラウザーからクロスサイトとマークされていてはいけません。そのため、ほかのサイトのページが、LAN アドレス上の設定をあなたのブラウザーに変更させることはできません。API を操作するスクリプトはこのヘッダーを送ります。それ以外は 415 で拒否されます。
  • このゲートは任意で有効にするものなので、未設定のときは、UI と API の全体(保存先、改ざんテストのルート、復元のルートを含む)に、ポートへ到達できる人なら誰でもアクセスできます。オフサイト、append-only のバックアップ、暗号化を使い始めたら、一度ログインパスワードを設定してください。
  • BombVault は、信頼できる、外部に公開されていないネットワークでのみ実行してください。リモートアクセスには、認証と TLS を追加するリバースプロキシの背後に置きます。応答には、基本的なセキュリティヘッダー(CSP、nosniff、X-Frame-Options、Referrer-Policy)が付きます。
  • リバースプロキシの背後では、すべてのリクエストにプロキシのアドレスが付くので、TRUSTED_PROXY がないと、ログインのスロットルが全クライアントを 1 つの枠で数え、攻撃者の失敗であなたも締め出されます。TRUSTED_PROXY にプロキシを指定すると、クライアントごとの集計に戻ります。
  • BombVault の前にあるリバースプロキシは、Authorization または X-API-Key ヘッダーを /mcp へ通す必要があり、応答をバッファリングしてはいけません。そうしないと、アシスタントが接続できません。MCP サーバーを参照してください。
  • MCP エンドポイント /mcp は、キーが作成されるか、OAuth によるサインインがオンになるまで 404 で応答し、ログインパスワードがオフでも、すべてのクライアントにキーまたはトークンを求めます。例外となるアドレスはなく、localhost も同じです。復元や削除のツールはなく、設定バックアップを復元すると、すべてのキーが取り消されます。MCP サーバーを参照してください。
  • HTTP_ONLY=true では、セッションクッキーから Secure フラグが外れます(通常の HTTP で動かすために必要です)。そのため、機密性が重要な場合は、TLS を終端するプロキシの背後でのみパスワードを有効にしてください。
  • VM バックアップの SSH 接続は、最初の接続でホストの鍵を信頼し(TOFU)、その後は固定します。コンテナからホストまでの経路が信頼できない場合は、ホストの鍵を別の経路で確認してください。
  • リンクでマウントの外には出られません。 パスより上にあるリンクがホストのマウントの外を指していると、バックアップやその場での復元はメッセージを出して止まります。自分の共有に書き込むコンテナなら、そのようなリンクを置けてしまうからです。ホストや rclone のリモートが - で始まる保存先も、保存時と次の実行時に同じように拒否されます。ssh や rclone がそれをオプションとして読んでしまうからです。

MCP サーバー

MCP サーバーに環境変数は不要です。設定、連携、MCP サーバー でキーを作成するとオンになり、Web 画面と同じポートの /mcp で応答します(例:https://192.168.1.10:3443/mcp)。有効なキーがないと、そのパスは 404 で応答します。クライアント、証明書、制限については、MCP サーバーで説明しています。

SSH 経由の VM バックアップ

BombVault は、libvirt のパスを一切マウントせずに KVM/libvirt VM をバックアップします。SSH(qemu+ssh://)経由でホスト上の virsh を実行するので、ホストの VM Manager に影響することはありません。

ホストの libvirt ソケットをコンテナにマウントすることは、Unraid では壊れやすい方法です。VM Manager がそれらのパスを所有していて、「Enable VMs」を切り替えると、libvirt が起動できなくなることがあります。SSH 鍵はホストの root 権限を与えるもので、BombVault がすでに使っている Docker ソケットと同じ水準の信頼です。

簡単なセットアップ:

  1. 設定、連携、ホスト SSH: 表示された公開鍵をコピーします。
  2. それを Unraid の /root/.ssh/authorized_keys に追記します(再起動後も残るよう、フラッシュにも保存されます)。
  3. 接続をテストをクリックします。

テンプレートは、コンテナがホストに届くよう --add-host=host.docker.internal:host-gateway を追加します。その名前が解決できない場合(たとえばコンテナがカスタムの br0.x ネットワークで動いている場合)は、LIBVIRT_HOST を Unraid の LAN IP に設定してください。Unraid の SSH ポートを変更した場合は、LIBVIRT_SSH_PORT を合わせてください。ライブスナップショットには、VM の qemu ゲストエージェントと、/mnt/cache(/mnt/user ではなく)にあるディスクも必要です。

VM の完全なセットアップとネットワークのガイド

手順を完全に説明したガイド(SSH の有効化、永続的な鍵の承認、カスタムネットワークと VLAN のルーティング、VM ごとの方式、ホスト側のトラブルシューティング)は、VM バックアップガイドです。

オフサイトの設定

オフサイトのコピーは保存先に送られます。設定のタイルから保存先を開き(またはサイドバーに固定して)、保存先を追加を選びます。完全な流れ(削除に対する保護、改ざんテスト、DR ドリル)は、オフサイトと復旧を参照してください。要点は次のとおりです。

  • バックエンド: rclone 経由でホストのマウントなしに使える SMB/CIFS と WebDAV、NFS(エクスポートをホストにマウントして、ローカルフォルダーとして使う)、rclone なしのネイティブ restic バックエンド(s3:...、rest:http://host:8000/repo、sftp:user@host:/repo)、または任意の rclone リモート(rclone:<remote>:<bucket>/path)。Backblaze B2 にはここでネイティブバックエンドがありません。S3 エンドポイント(s3:https://s3.<region>.backblazeb2.com/<bucket>/<path>)経由で、キー ID とアプリケーションキーを S3 の認証情報として使ってください。
  • 認証情報は暗号化して保存され、設定、保存先 の認証情報カードに、保存済みの認証情報の 1 つの一覧としてあります。星印が標準のもので、認証情報を選んでいない場所ではそれが使われます。保存先自身のページでは、その認証情報カードで使うものを選びます。認証情報を参照してください。
  • SSH の保存先では、相手側に何もインストールする必要はありません。 sftp: に必要なのは SSH サーバーだけです。設定、連携、ホスト SSH の公開鍵(/config/ssh/id_ed25519.pub にもあります)を、対象ユーザーの ~/.ssh/authorized_keys に追加するか、保存先を追加の鍵を追加でアカウントのパスワードを使って置かせてください。
  • 自己署名証明書の rest-server: その証明書、または署名した認証局の証明書を、PEM ファイルとして BombVault のデータフォルダーの certs フォルダー(コンテナ内では /config/certs、Unraid では appdata/bombvault/certs)に置きます。バックアップ、コピー、削除に対する保護のテストは、再起動なしでそれを信頼します。
  • オフサイトコピー: BombVault は、新しいスナップショットを restic copy でベストエフォートでコピーします。通常はローカルの、プライマリの上に重ねる形です。保存先のコピーカードで、バックアップのたびにコピーするか、専用のプランでコピーするかを設定でき、設定、スケジュール、セクションごとのオフサイトコピーで、1 つのセクションに専用のコピープランを与えられます。今すぐ複製は、設定、保存先 のオフサイトコピーカードにある、セクションの行にあります。
  • セクションごとに複数の保存先: 保存先のページのセクションごとの保存先カードでは、セクションから保存先への各行を、ワンクリックでオンまたはオフにできます(ローカルを含みます)。オフサイトの保存先しかないセクションは、そこへ直接バックアップし、すべての行がオフのセクションはバックアップされません。保存先のセクションごとのルールで、1 つのセクションに、そこでの専用のリポジトリ、保持、圧縮を設定できます。
  • 項目ごとの配置: コンテナ、VM、フォルダーセットはそれぞれ、設定タブのスケジュールと保存先カードで、ローカルと、そのバックアップを受け取る保存先が点灯します。自分の選択がない項目は、セクションに従います。項目ごとの配置を参照してください。
  • 保持: 各保存先は、その保持期間カードに従ってバックアップを保持し、セクションはセクションごとのルールで独自の値を持てます。セクションのオフサイトフィールドにあるコピーも含みます。すべてゼロにすると、保存先のスナップショットは一切整理されません。
  • 帯域幅の制限: 設定、保存先 のオフサイト帯域幅カードで、または保存先ごとにそのコピーカードで、restic のアップロードとダウンロードの速度を制限します。KiB/s で入力すると、フィールドには同じ速度が MB/s と Mbit/s で表示されます。
  • ストリーミング優先: 保存先のページのストリーミングカードで、メディアサーバー(Plex、Jellyfin、Emby はイメージ名で事前に選択されています)、ストリーミングしていると見なす送信速度、ストリーミング中のアップロード制限、ストリームのあと通常の制限に戻るまでの時間を選びます。
  • コールドおよびアーカイブのストレージクラス(S3): S3 の保存先では、そのページで、復元に読み取れる階層(Standard、Standard-IA、One Zone-IA、Intelligent-Tiering、Glacier Instant Retrieval)を選びます。rclone のリモートは、rclone の設定でクラスを決めます。
  • ローカルではなく保存先の中の専用フォルダー: セクションの専用フォルダーは、上の保存先のどれかの中に置けます。ローカルコピーも、コピーの手順もありません。セクションの専用フォルダーを参照してください。

異常

異常検出に環境変数は不要です。設定、検証 の異常カードで設定します。異常で説明しています。

持ち運べる設定(エクスポートとインポート)

設定、システム の設定のエクスポート / インポートカードは、BombVault の設定全体(セクションの設定、保存先、スケジュール、保持、通知)を、ほかのインスタンスにインポートできる持ち運べる JSON ファイルに書き出します。新しいマシンへの移行やセットアップの複製で、すべてを手で入力し直す必要はありません。インポートではプレビューが表示されて確認を求められ、バックアップのデータや履歴には一切触れません。すでに存在しない保存先やリポジトリへのファイル内のリンクは除外され、プレビューにその名前が示されます。ZFS レプリカの実行中は、何かが書き込まれる前にインポートが拒否されます。

エクスポートには認証情報が含まれることがあります

オフサイト、通知、MQTT ブローカーの認証情報をファイルに含めるかどうかは、あなたが選びます。認証情報を含めると、エクスポートはリカバリーキットと同じくらい機密性が高くなるので、安全な場所に保管してください。含めなければ、ファイルには機密でない設定しか入りません。

APP_KEY はファイルと一緒には移りません

リポジトリは APP_KEY から導いたパスワードでロックされていて、ファイルにはその鍵が含まれません。計画的に移行するときは、新しいマシンのテンプレートに古い APP_KEY を設定するか、緊急でリカバリーキットを使って鍵を引き継いでください。別の鍵のもとでは、リポジトリはパスワードが違うと応答します。何も失われてはおらず、正しい鍵を設定すればまた開けます。