ホーム > PowerCMS > ドキュメント > PowerSync >

PowerSync ユーザーガイド

※ この機能は PowerSync をご購入の場合のみご利用可能です

概要

PowerSync プラグインは、PowerCMS プロフェッショナル版以上に同梱されている Copy2Public プラグインよるステージ環境・公開環境への同期機能をより強化するとともに、利便性を向上させるものです。

PowerSync プラグインによる同期の場合も、Copy2Public プラグインによる同期と基本的な仕組みは同じです。そのため、同様の留意事項があります。必ず Copy2Public プラグインのドキュメントを参照してください。

本項では、重複を避けるため、Copy2Public プラグインの解説で足りる部分は省略し、PowerSync プラグインに固有の解説のみを行います。

PowerSync 1.28 における変更点

削除するファイルを手動で指定する機能を追加しました
予約時点のファイルを同期する機能を追加しました
リモートサーバへ転送した Zip アーカイブの展開日時を指定するを追加しました
do-synchronize スクリプトを do-synchronize-time-reserved へ変更しました
- PowerSync 1.27 以下から PowerSync 1.28 以降へアップグレードする場合はリモートサーバーの do-synchronize スクリプトを do-synchronize-time-reserved へ置き換え、設定を行ってください
- 本ドキュメントの内容は最新版がベースになっています。旧バージョンをご利用の場合、do-synchronize-time-reserved と記載所部分は do-synchronize へ読み替えてください

動作環境

PowerCMS 4.0 以降、もしくは Movable Type 6.0 以降がインストールされ、正常に動作している環境

その他、Copy2Public プラグインの動作要件を満たしている必要があります。

サポート情報

サポートサイト

最新バージョンはサポートサイトからダウンロードすることができます。

PowerCMS を導入いただいている場合は、「PowerSync-(バージョン番号)-forPowerCMS.zip」を、そうでない場合は「PowerSync-(バージョン番号)-forMT.zip」をダウンロードしてご利用ください。

初めてサポートサイトをご利用いただく前にまずサインアップを行ってください。

本ユーザーガイドで使用する約束事

用語

MT_DIR: Movable Type/PowerCMS をインストールしたアプリケーションディレクトリのパスを表します。通常はここに mt.cgi や mt-config.cgi などが含まれています。
ウェブサイト/ブログ: PowerCMS 6 以降では、表記が「ワークスペース/スペース」に変更されています。

この他、PowerCMS と共通の用語もありますので下記ページも参照してください。

本ユーザーガイド内の用語や記法

パッケージ構成

PowerSync パッケージは以下のディレクトリで構成されています。

mt/plugins/PowerSync : PowerSync プラグイン一式
mt/plugins/Abs2Rel : Abs2Rel プラグイン一式
mt/plugins/Copy2PublicPlus : Copy2PublicPlus プラグイン一式
mt/mt-static : PowerSync プラグインで使用する静的ファイル一式
mt/tools : CMS サーバーおよびリモートサーバーで利用するスクリプト群

インストール

mt ディレクトリ内の各ファイルおよびディレクトリをご利用環境の $MT_DIR にコピーします。
リモートサーバーへの転送を行う場合、tools/do-synchronize-time-reserved を設定します。Copy2Public のドキュメント『リモートサーバへの同期』を参照してください。
ブラウザで CMS 管理画面へアクセスし、アップグレードを実行する

追加プラグインのインストールに際しては、ドキュメント『プラグインのインストール』を合わせて参照してください。

Copy2Public プラグインを運用されていた環境へ導入する場合

Copy2Public プラグインを削除してから PowerSync プラグインをインストールしてください。両方が設置されていると問題が発生する場合があります(無効化ではなく、サーバ上から取り除く必要があります)。

プラグインの設置完了後、管理画面にアクセスするとアップグレードが行われます。アップグレード処理によって Copy2Public プラグインの設定が引き継がれますので、Copy2Public へ行っていたプラグイン設定を再度行う必要はありません。
Copy2Public 用の環境変数がそのまま使えます。環境変数の設定を再度行う必要はありません。
予約済みの同期タスク、Copy2PublicPlus との組み合わせもそのまま動作します。
PowerCMS 導入済みの環境では Abs2Rel プラグイン、Copy2PublicPlus プラグインが上書きとなる場合があります。これらのプラグインは PowerCMS に同梱されているものと同じものですので、上書きしていただいてかまいません。上書きせず、設置済みのものをそのままご利用いただいてもかまいません。

環境変数

Copy2Public の環境変数については、Copy2Public プラグインのドキュメントを参照してください。

環境変数	解説	初期値
AllowPowerSyncStagingRoot	Copy2Public の環境変数 AllowCopy2PublicStagingRoot と同じです。
AllowPowerSyncPublishRoot	Copy2Public の環境変数 AllowCopy2PublicPublishRoot と同じです。
AllowPowerSyncDirectSync	Copy2Public の環境変数 AllowCopy2PublicDirectSync と同じです。
PowerSyncScheduledIsDefault	Copy2Public の環境変数 Copy2PublicScheduledIsDefault と同じです。
PowerSyncFollowSymLinks	Copy2Public の環境変数 Copy2PublicFollowSymLinks と同じです。
PowerSyncTransferProtocol	Copy2Public の環境変数 Copy2PublicTransferProtocol と同じです。

プラグイン設定

設定はシステム/各ウェブサイト/ブログの [設定]-[プラグイン]-[PowerSync] の設定で行います。

基本的には Copy2Public プラグインにおける設定と同じです。ここでは、PowerSync に固有の設定のみ記載しています。

設定項目	解説	設定例
ステージ環境のURL (PowerSync 1.27 以降)	「ステージ環境のパス」に対応する URL を指定すると同期結果の画面でリンクを表示できます	https://stage.example.com/
公開環境のURL (PowerSync 1.27 以降)	「公開環境のパス」に対応する URL を指定すると同期結果の画面でリンクを表示できます	https://www.example.com/
同期先から削除するファイルを選択する (PowerSync 1.28 以降)	選択したファイルのみが削除されるようにします。
日時指定した時点のファイルを同期する (PowerSync 1.28 以降)	日時指定した時点でのファイル/ディレクトリをアーカイブして保存しておき、同期時にコピーします。この設定を利用する場合は「同期先から削除するファイルを選択する」も有効になります。
ページタイトルの表示文字数 (PowerSync 1.28 以降)	ページタイトルは、ファイルを選択する画面で表示されます。

転送の実行について

基本的な操作については Copy2Public プラグインのドキュメント『同期の実行について』を参照してください。

PowerSync では、ウェブサイト/ブログ公開パス以下のフォルダ/ファイルのリストが表示され、同期する対象を選択する際に、フォルダを開いて下層のフォルダ/ファイルを個別に指定することが可能です。

同期元でファイルが削除されている場合

同期元環境のフォルダ/ファイルが一覧表示されるため、削除されているファイルは表示されません。ファイルが削除されていることを同期する場合、削除されたファイルの上位のフォルダを指定してください。
第一階層について削除されていることを同期する場合、「第一階層のファイルが削除されていた場合、同期先からも削除する」のチェックボックスにチェックを入れてください。
ファイル名の先頭に「.」があるファイルは、同期する対象のファイル一覧には表示されません。

削除するファイルを手動で指定する機能 (PowerSync 1.28 以降)

PowerSync プラグイン設定オプション内の「同期先から削除するファイルを選択する」にチェックを入れる事で、同期先環境から削除するファイルを選択ことが可能になり、より安全な運用が可能になりました。

これまでは前述の通り対象を内包するディレクトリを同期対象として指定する必要があったため、対象の削除だけでなくそれ以外のファイルがコピーされる可能性があることに注意が必要でしたが、同期先環境から削除するファイルを手動で選択することができるようになりました。

※ 設定により従来の動作を維持することも可能です

予約時点のファイルを同期する機能 (PowerSync 1.28 以降)

PowerSync プラグイン設定オプション内の「日時指定した時点のファイルを同期する」にチェックを入れる事で、予約時点のファイルを同期することが可能になります。

日時指定による同期の予約を行う場合、これまでは、同期処理時点で同期元環境と同期先環境のファイルの更新日の比較を行い、同期元環境のほうが新しい場合のみファイルがコピーされていました。更新日の比較は自動で行われるので、対象として毎回全体を指定するような運用では CMS 任せにできるのですが、その反面、リビジョンを駆使して同じファイルを何度も同期する場面では、同期処理時点でファイルがどういう内容になっているか注意が必要でした。

※ 設定により従来の動作を維持することも可能です
※ この機能によって同期を行う場合、ファイルの更新日の新旧に関わらず、必ずファイルのコピーが行われ、同期先環境のファイル更新日は同期実行時点のものになります
※日時指定した時点のファイルを同期するだけのチェックは入れることはできません

リモートサーバへ転送した Zip アーカイブの展開日時を指定する (PowerSync 1.28 以降)

これまで、リモートサーバーにおいては、cron 登録された do-synchronize が動作するタイミングで即時に Zip アーカイブが展開されることを考慮して同期の日時を指定する必要がありましたが、同期操作の際に Zip アーカイブを展開する日時を指定することができるようになります。これにより、安全な事前同期が可能になります。

※ リモートサーバーへは、展開日時を指定する機能をご利用の場合は、これまでの do-synchronize に変わり、do-synchronize-time-reserved の設置が必要になります