Install
This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/kamihicouki/wordpress-r2-backup/archive/refs/heads/main.zipWordPressのファイルとDB(データベース)をage公開鍵で暗号化し、Cloudflare R2へ保存するプラグインです。元サイトのファイルや索引が失われても、保存先の暗号文と対応する秘密鍵から独立復旧キットを使えます。
主な機能
- 手動バックアップと毎時・毎日・毎週の定期バックアップ。
- 保守あり/保守なしの取得、工程別の進捗と所要時間の表示。
- 完全保存、フォーム送信情報の除外、テーブル・フィールド・ファイル・設定行の個別指定。
- パック単位の暗号化、世代間の同一内容の再利用、R2保存物の全内容照合。
- 保存期限と世代指定の削除。別世代が参照する共有暗号文は保持。
- WordPress管理画面と独立PHPの復元入口、標準MySQL/MariaDBと簡易SQLiteの復旧経路。
新しい取得は目録v4です。旧v1・v2・v3の復旧経路も維持しています。バックアップの完了と、サイトとして復旧できることの確認は別です。
導入
このリポジトリをWordPressのwp-content/plugins/wordpress-r2-backupへ配置し、プラグインのルートで本番用依存物を構築します。
composer install --no-dev --no-scripts --no-plugins --prefer-dist
WordPress管理画面でプラグインを有効にし、専用の非公開R2バケット・バケット用キー・異なるage公開鍵2本を設定します。秘密鍵はサイト外に分けて保管し、両方の公開鍵で確認用データを復号できることを確認してください。復旧キットの作成と接続ファイルの扱いは独立復旧の手順を参照してください。
開発元と公開リポジトリ
開発元のリポジトリを正本とし、検証済みの版だけを明示的な公開操作でGitHubへ同期します。通常の開発コミットやサイトへの配備では公開しません。公開用のPUBLICATION.jsonに、元コミットと公開対象ファイルの照合値を記録します。修正は開発元へ反映してから再同期します。
管理画面と設定
左メニューの R2 Backup に、バックアップ、復元、ストレージ設定、保存範囲と除外設定、保存期間と容量があります。保存範囲はR2接続前にも設定でき、初回の接続設定へ引き継ぎます。
ストレージ設定には、CloudflareアカウントID、専用バケット、バケット専用のR2アクセスキー、異なるage公開鍵2本を登録します。ageは公開鍵でファイルを暗号化するツールです。Cloudflare全体のAPIトークンは使いません。OAuth(Cloudflareへログインして接続を許可する方式)は未実装です。
秘密アクセスキーはサイトの認証設定で暗号化し、画面へ再表示しません。サイトの認証用salt(暗号化に使うサイト固有の設定)を変更した場合は、接続設定を再登録します。復号用秘密鍵はWordPressへ送信せず、取得対象外の別々の場所に保管します。
バックアップ開始前には、公開画像の登録と保存元の実ファイルを参考検査できます。検査は除外設定の適用前の確認であり、外部画像を取得したり元データを変更したりしません。登録された画像でも保存元に実ファイルがなければ保存できず、記事内だけの参照・外部URL・個別除外による不足を網羅する保証もありません。
保存範囲と任意除外
プリセット(設定のひな型)は次の3種類です。
- 完全保存は、保存範囲内のファイルとDBを除外・値の加工なしで保存します。
wp-config.php、認証設定、WordPressユーザー、フォーム送信情報も含みます。 - フォーム送信情報を除外は、確認できた問い合わせ・申込の送信データ、添付、送信記録を除外します。フォーム定義、WordPressユーザー、システム設定は保持します。未知のプラグインの送信情報を網羅して検出する保証はありません。
- カスタムは、分類と個別ルールを使います。テーブル、フィールド、ファイル・フォルダー、
option_nameで選ぶ設定行、値の完全一致で選ぶ行を指定できます。SQL(DBの操作文)や設定の秘密値は入力しません。
新規設定の初期値は完全保存です。以前の設定は、旧来の固定除外も含めて「カスタム(以前の設定を継承)」へ移します。継承中の内容は画面に表示します。新しい明示的な「含める」は対応する旧除外や分類より優先し、「継承」に戻すと以前の設定が再び有効になります。
完全保存を選んで保存すると、任意除外、個別指定、以前の互換ルールをすべて解除します。過去の世代で除外された内容は復活しません。旧設定の継承中は保存元を従来のWordPressルートに保ち、新しい追加ルートを自動では加えません。
行と設定名の指定はテーブル指定より、テーブル指定は分類より優先します。ファイル・フォルダーの明示指定も分類より優先します。フィールドの「含める」だけでは、除外された行全体は復活しません。テーブルのデータを除外しても構造は保持します。
新しい設定では、未知の名前やメールらしい文字列を理由に勝手に除外しません。旧設定を継承した対象では、以前の未確認候補による停止も維持します。新しいフィールド除外でNULL(値がない状態)を安全に使えない場合は停止します。根拠なくremoved-Nや0へ置換しません。旧設定の置換動作は互換性のために保持します。
完全保存でも必要な安全条件
完全保存の範囲は、WordPress本体と構成上必要なファイルルート、および接続先の1つのDBです。親ディレクトリのwp-config.php、別の場所にあるコンテンツやメディアは、WordPressの設定から追加ルートとして記録します。OS全体の複製ではありません。
処理用領域、索引、秘密鍵の既知の保管場所が保存元ルートと重なる場合は、除外指定に関係なく停止します。含めるファイルから標準のage秘密鍵を検出した場合も停止します。除外ファイルの本文は読みません。その中に秘密鍵がないことを検出・保証する処理ではありません。
除外したログやキャッシュの変更、出現、消失は取得の照合対象にしません。保存対象の変更、危険な権限、保存元の外へ出るリンク、未対応のファイル種類は取得前または照合時に停止します。
取得と保存期限
通常の作業領域はOSの一時領域です。WebとCLIの一時領域が別々の場合は、WRB_LIVE_WORKSPACE_BASEに所有者専用の既存ディレクトリ、WRB_LIVE_PUBLIC_ROOTに公開領域を指定できます。どちらも正規の絶対パスを使い、作業領域は公開・保存対象と重ならないようにします。変更前の未完了ジョブは移行されないため、完了または取り消してから切り替えてください。
手動取得では「保守あり」と「保守なし」を選びます。保守ありは外部の定期処理や直接DB更新を停止したうえで一時的な保守状態とDBの読み取りロックを使います。保守なしは対応するDB条件で一貫した読み取りを使い、サイトを公開したまま取得しますが、DBとファイルの取得時点には差が残る場合があります。保存対象ファイルの前後照合を行い、検出した不整合があれば完了世代を公開しません。
取得後は保守状態を解除し、サーバー上のPHP CLI(画面と独立して動くPHP処理)で暗号文の転送を継続します。画面を閉じても処理は続き、中断後は「転送を再開」を使います。取得元の本文や生SQLを平文の作業ファイルへコピーせず、小分けにageへ渡します。暗号文と私有の処理記録は上記の作業領域に置きます。一時領域を失った未完了の取得はやり直します。
保存期間の初期値は30日で、1〜3650日を指定できます。期限対象の整理と世代指定の削除に対応し、他の世代が参照する暗号文は残します。サイトのR2キーを持つ主体による削除を防ぐ保証はありません。保存完了と、独立キットによる復旧の確認は別です。
保存容量の節約(世代間共有)は 保存期間と容量 画面でチェックを入れて有効にします。索引の保存場所は、実行ユーザーのホーム直下の非公開ディレクトリ(.wordpress-r2-backup-index、権限0700)を自動で選びます。ホームがウェブ公開領域・WordPress本体・OS一時領域に含まれる場合や、所有者専用として検証できない場合は、危険な候補へ切り替えず理由を示して停止します。その場合や保存場所を指定したい場合だけ、詳細設定でサイトとOSの一時領域の外の永続ディレクトリを絶対パスで入力します。配下に保存先・公開鍵ごとの索引を作成します。既存の設定では自動的に有効にしません。保存範囲と除外設定は、この設定と独立しています。
索引を失った場合や共有暗号文が破損した場合は停止します。管理端末の独立キットで索引を再構築するか、共有を明示的に無効にして新しい取得を行います。元サイトと索引がなくても、世代の目録と暗号文から復旧できます。除外付き取得で古いパックに対象外の内容が混在する場合は、今回の対象だけを新しく詰め直します。
新規保存・再利用・除外境界の詰め直しを、内容片の重複を除いた元データのバイト数とパック数で表示します。詰め直しは新規保存の内数です。R2へ転送した暗号文のサイズとは異なり、新しい明細ページと目録は毎世代保存します。
対応条件と制限
PHP 7.4以上、intl・mbstring・curl・openssl・dom拡張、WordPressのmysqli接続が必要です。Pythonは不要です。同梱の公式age 1.3.2はLinux amd64とDarwin arm64に対応し、照合値と実行権限を検査します。
DBは通常のテーブルと生成列に対応します。外部キー(テーブルどうしの参照制約)は、関連する両側のデータをすべて保持する場合、または両側を空にする場合に保持します。一般の部分除外には対応せず、取得前に停止します。VIEW(保存された問い合わせ)、トリガー、ルーチン、イベント、別DBへの依存、検証できない定義やロック権限不足も取得前に停止します。
v4は本文を最大1MiBずつ扱い、最大32MiBまたは512項目のパック(まとめた本文)に保存します。明細ページは最大1MiBまたは1,024記録です。保存元は合計500,000項目、復旧対象の本文は合計1TiBまでです。その他の上限と厳密な条件はv4形式仕様とsrc/V4Format.phpにあります。
復旧先は新しい専用ディレクトリです。v4は各保存元をdestination/roots/rNNNNへ戻し、元の絶対パスへ上書きしません。同じ内容の別ファイルも別の実体へ戻します。DBの照合と内容確認後に元の権限を適用し、対応するリンクは最後に作ります。実サイトのDB取込はSQLを書き出した後の別操作です。
v4は明細をページと分割した記録で処理し、全項目を1つのPHP配列に集めません。所要時間と必要容量・メモリは対象の件数と環境に依存します。旧v3の大規模復旧には別途メモリ指定が必要です。JavaScript依存の動作、外部連携、保存元に実ファイルがない外部参照画像の復旧は、バックアップ完了だけでは確認できません。
PHP標準のfflushと、利用できる環境のfsyncで書き出します。PHP 7.4で停電直前の更新が必ず残る保証はありません。処理中断、保存破損、OSやホストの障害は同じ保証ではありません。
定期バックアップ
管理画面で有効・頻度・開始時刻を設定します。時刻はWordPressのタイムゾーンを使い、毎時の場合は指定時刻の「分」を使います。初期状態では定期実行は無効です。
予定の保存だけではサーバーの定期実行は登録されません。サーバーのcron(定刻にコマンドを起動する仕組み)から、次のコマンドを毎分呼び出してください。実際のPHPとWordPressの絶対パスへ置き換えます。
* * * * * /path/to/php /path/to/wordpress/wp-content/plugins/wordpress-r2-backup/schedule.php /path/to/wordpress >/dev/null 2>&1
サーバーの起動確認は管理画面へ記録します。処理中・未完了のジョブがあれば新しい取得を重ねず、取り逃した予定を連続実行しません。転送が中断した場合は管理画面で状態を確認し、「転送を再開」を使ってください。定期処理による転送の自動再開はありません。現行の記録は、未完了ジョブによる開始拒否も起動失敗として表示します。
定期実行は現在、保守なし取得に対応する条件だけで開始します。保守ありの定期取得は、外部の書き込み停止を継続して証明する仕組みが未実装のため開始しません。保守中はWordPress管理画面へアクセスできず、その画面で進捗を見られない場合があります。
復旧
独立キットのCLI・PHP画面の手順を参照してください。元サイトへ秘密鍵を入力せず、新しい専用領域と空DBへ復旧します。既存サイトの上書きや公開切替は行いません。
標準MySQL/MariaDBに加え、v4にはSQLiteを使う簡易復旧があります。restore --sqlite-fileで新しいSQLiteファイルへ取り込み、--sqlite-site-configで原本とは別の起動用コピーへURL・DB・専用管理者を設定できます。SQLiteの復旧・起動にはpdo_sqliteとsqlite3拡張が必要です。SQLiteでは未対応の型・定義や値の損失を検出すると停止します。標準DBとの完全な互換性は保証しません。ローカル起動にはmacOSの隔離機能を使う--serve-local yes経路があります。
管理画面の復元操作には管理権限、nonce(操作の偽造を防ぐ確認値)、パスワードの再入力が必要です。専用領域は実行ユーザーのホームの.wordpress-r2-backup-restore(WRB_RESTORE_STATE_DIRで変更可)、MySQLの接続セットはWRB_RESTORE_MYSQL_CONNECTIONSで指定します。
開発時の検証
開発用依存物はcomposer install --no-scripts --no-plugins --prefer-distで構築します。PHPUnitの設定はphpunit.xmlです。DB・Web・R2の統合試験には、試験専用の環境と対応する実行ファイルが必要です。実サイトの接続設定や実データを試験環境へコピーしないでください。
管理画面の同時操作の試験は、PHP-FPM(複数のPHP処理を同時に動かす方式)とNginxを使います。WRB_TEST_FPM_BINとWRB_TEST_NGINX_BINへ実行ファイルの絶対パスを設定し、FPMのPHP版を試験実行PHPと合わせます。通常のプラグイン起動には不要です。
ライセンス
本プラグインはGNU GPL version 2またはそれ以降で提供します。LICENSEと同梱物の出典・ライセンスを参照してください。