バックアップ

はじめての方

アップデートの失敗、ディスクの故障、新しいマシンへの移行に備えて、元に戻せるようにセットアップの控えを残しておきます。

始める前に

Settings > Backups(設定 > バックアップ)には Change settings(設定の変更)権限が必要です。復元できるのはオーナーだけです。
ダウンロード、削除、復元には、直近数分以内のパスワードでのサインインが必要です。

バックアップを作成する

Settings > Backups を開きます。
Back up now(今すぐバックアップ)を選択します。Saved backups(保存済みのバックアップ)に新しいバックアップが表示されます。
その横の Download(ダウンロード)を選択して、サーバーの外にも保管します。

マスターキーを保存する

バックアップにマスターキーは含まれません。マスターキーは、設定内のパスワードと API キーを開くためのものです。対応するキーがないと、復元したバックアップからそれらを読み取れません。

Master key(マスターキー)で、オーナーが Download key kit(キーキットをダウンロード)を選択します。
このファイルは、サーバーから離れた場所に、バックアップとは別にして保管します。Settings > Backups とヘルスチェックから、キーキットの警告が消えます。

あとで使うときは、ファイル名を holyarrs.key に変更して設定フォルダーに置きます。オーナーでない場合は、オーナーにダウンロードを頼んでください。

バックアップを復元する

Restore from a file(ファイルから復元)を選択し、HolyArrs のバックアップ zip を選びます。
確認します。
HolyArrs がファイルをチェックします。Restore ready. It applies on the next start.(復元の準備ができました。次回の起動時に適用されます。)が表示されます。
HolyArrs が再起動し、バックアップを反映します。推奨の Docker 再起動ポリシーなら、これは自動で行われます。

現在のデータベースは /config/backups/before-restore-<time> に移動されるので、復元を取り消せます。

オプション

頻度

オプション	バックアップの間隔	保持する内容
Balanced(バランス、既定値)	毎日	直近 7 日分と週次の 4 つ
Light(軽め)	週に 1 回	4 週間分。使う容量が最も少ない
Careful(念入り)	毎日	30 日間のすべて

スケジュールによる最新のバックアップは必ず残ります。これらのルールで整理されるのは、スケジュールによるバックアップだけです。自分で作成したバックアップは、削除するまで残ります(行のごみ箱ボタン。元に戻せません)。HolyArrs は、保存データを変更するアップデートの前にもバックアップを作成し、最新の 3 つを残します。アップデートを参照してください。

新しいマシンに移行する

新しくインストールすると、初回の起動時に専用のマスターキーが作られます。そのキーでは以前のバックアップを開けないため、復元は拒否されます。先に以前のキーを置いてください。例ではコンテナ名を holyarrs としています。自分のコンテナ名に置き換えてください。

初回の起動前に、コンテナを起動せずに作成します。docker compose create を使うか、docker run の行で docker run -d の代わりに docker create を使います。
以前のキーをコピーします: docker cp holyarrs.key holyarrs:/config/。holyarrs.key に名前を変更したキーキットも使えます。名前付きボリュームでもホストのフォルダーでも同じ方法で行えます。HolyArrs は起動時に、/config 内のファイルの所有者を PUID と PGID に変更します。HOLYARRS_MASTER_KEY_FILE を使っている場合は、代わりにホスト上のそのパスにキーを置き、PUID と PGID で読み取れるようにします。
バックアップを復元します。次のどちらかを選びます。
- HolyArrs を起動して初回セットアップを終え、Settings > Backups の Restore from a file を使います。
- または、初回の起動前に復元します。zip を名前を変えずに backups というフォルダーに入れ、docker cp backups holyarrs:/config/ でコピーします。続いて、同じイメージで復元を 1 回実行します。
  - Compose: docker compose run --rm holyarrs restore <zip name>
  - Docker CLI: docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>
  キーファイルのパスを使う場合は、-e HOLYARRS_MASTER_KEY_FILE=<its path> を追加して、復元時に自分のキーと照合されるようにします。restore --list で、認識されているバックアップ名を確認できます。
HolyArrs を起動します。ライブラリと設定が元どおりに表示されます。

キーをコピーする前に新しいインストールを起動してしまった場合は、そこに残したいものがなければ、HolyArrs を停止し、同じ docker cp で新しいキーを以前のキーで上書きして、復元してから起動します。

うまくいかないとき

症状: 「Backups are off in this build」(このビルドではバックアップがオフです)と表示される。 原因: このビルドは、バックアップ管理機能なしで動いています。 対処: アプリ内でできることはありません。バックアップの操作項目自体がありません。

症状: ダウンロード、削除、復元でパスワードを求められる。 原因: これらの操作には、直近のパスワードでのサインインが必要です。 対処: パスワードでサインインし直して、もう一度試します。

症状: マスターキーが原因で復元が拒否される。 原因: 設定フォルダーのキーがバックアップと一致していません。 対処: 一致する holyarrs.key を戻して、もう一度試します。

zip が大きすぎる、壊れている、想定外のファイルを含む、より新しいデータベースバージョンのものである、自分のキーで読めないデータを含む、といった場合も復元は拒否されます。

上級者向け

バックアップに含まれるもの

各バックアップは zip で、メインのデータベース、イベントのデータベース(ある場合)、backup.json(HolyArrs のバージョン、データベースのバージョン、バックアップの種類、作成日時)が入っています。メディア、ダウンロード、アートワーク、ログ、マスターキーは含まれません。

初回の起動前に復元する

docker cp は名前付きボリュームでもホストのフォルダーでも使えます。HolyArrs は起動時に、/config 内のファイルの所有者を PUID と PGID に変更します。HOLYARRS_MASTER_KEY_FILE を使う場合は、代わりにホスト上のそのパスにキーを置き、PUID と PGID で読み取れるようにします。

zip を名前を変えずに backups というフォルダーに入れ、コピーします: docker cp backups holyarrs:/config/。
同じイメージで復元を 1 回実行します。
- Compose: docker compose run --rm holyarrs restore <zip name>
- Docker CLI: docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>
キーファイルのパスを使う場合は、-e HOLYARRS_MASTER_KEY_FILE=<its path> を追加して、復元時に自分のキーと照合されるようにします。
HolyArrs を起動します。

restore --list で、認識されているバックアップ名を確認できます。