SiteSync

SiteSync は rsync and SSHやFTP/FTPSを利用して、Movable Typeのインストールされたステージングサーバー(以下、転送元サーバー)と公開サーバー(以下、転送先サーバー)の間でコンテンツの同期を行う為のプラグインです。

プラグインの特徴

• rsync、FTP/FTPSを用いた配信、S3への配信が可能です。
• フォルダや拡張子を指定して配信除外設定ができます。
• 配信時にソース内の文字列を置換することができます。
• [NEW] プラグイン設定を他のサイト/ 子サイトへ読み込みができるようになりました。MTP8
• [NEW] プラグイン設定でプロトコルがFTPの場合、ポート番号を指定できるようになりました。MTP8
• [NEW] 同期時のメール通知を複数設定できるようになりました。MTP8
• [NEW] 同期時のメール通知のメールテンプレートをカスタマイズできるようになりました。MTP8
• [NEW] S3に同期する際にIAMロールにて同期できるようになりました。MTP8ソフトウェア版
• [NEW] 同期を定期実行できるようになりました。MTP8
• [NEW] Movable TypeクラウドでSSH配信（rsync over ssh）が出来るようになりました。MTP8

プラグイン利用開始前の初期設定

SiteSyncのご利用前の初期設定は以下の通りです。

転送先サーバーの設定

SiteSyncで同期を行う為には、転送先サーバー及び転送元サーバーの設定が必要となります。転送先サーバーでは、転送元サーバーから、サイト／子サイトのプラグイン設定にあるプロトコルで指定されたプロトコルで接続できる様、デーモンの設定、及びユーザーの追加、鍵認証の登録が必要になります。

rsync and SSHで接続する場合

1. プロトコルデーモンの設定
   SSHで接続できるよう、sshdが動作するようにしてください。
2. ユーザーの追加
   同期処理を行うためのSSH接続可能な同期処理用のユーザアカウントを作成してください。通常アカウントを使う事も可能ですが、セキュリティ上の問題から、専用のユーザアカウントを作る事をお勧めします。
3. 鍵認証の登録
   転送元サーバーで利用する秘密鍵とペアになるよう公開鍵を設定してください。
   ※ 秘密鍵はパスフレーズのないものをご利用ください。パスフレーズ付きの秘密鍵には対応しておりません。

FTP/FTPSで接続する場合

1. FTP/FTPSサーバーの設定
   FTP/FTPSで接続できるよう、FTP/FTPSサーバーを設定して下さい。
2. ユーザーの追加 / パスワード
   同期処理を行うためのFTP/FTPS接続可能な同期処理用のユーザアカウントを作成してください。通常アカウントを使う事も可能ですが、セキュリティ上の問題から、専用のユーザアカウントを作る事をお勧めします。

S3で接続する場合

配信先S3（バケット）の準備及びアクセスキー、シークレットアクセスキーをAWS管理画面より設定してください。

転送元サーバーの設定

rsync and SSHで接続する場合

SSHを利用して接続を行う場合は、転送元サーバーで、ssh及びrsyncコマンドが利用できるよう設定されている必要があります。

Movable Type クラウドでrsync and SSHで接続する場合

転送元サーバーで秘密鍵が必要になります。FTPSで Movable Type クラウドにアクセスし、/secret に秘密鍵を設置すると、/data/secret ディレクトリ内に同期されます。転送先サーバーに登録されている公開鍵とペアになるよう秘密鍵を設定してください。

また、SSHオプション 設定項目へ "-o StrictHostKeyChecking=no" を指定する必要がある場合があります。

FTP/FTPSで接続する場合

FTP/FTPSを利用して接続を行う場合は、転送元サーバーで、FTP/FTPS接続及び転送が出来るように設定されている必要があります。

ユーザーのロールに同期を行う権限を設定する

同期設定及び同期を行う場合、そのユーザーに設定されている［ロール］の［権限］に、［同期処理］内の［コンテンツの同期］が設定されている必要が有ります。権限が付与されていない場合には、同期設定、コンテンツの同期は行う事が出来ません。また、コンテンツを同期へのリンクも表示されません。

ユーザーの権限及びロールについて詳しくはMovable Typeのマニュアルをご覧下さい。
Movable Type 7 Manual

システムからプラグインの設定をする

システムからのSiteSync設定では、作業領域とログの設定、メール通知設定を行う事が出来ます。

1. システムダッシュボードのナビゲーションから［設定］をクリックし、サブメニューから［プラグイン］をクリックします。
2. ［SiteSync］をクリックし、［設定］をクリックします。
3. ［SiteSync］の設定画面が表示されるので、必要項目を入力・設定し、［変更を保存］ボタンをクリックします。

   

システムのSiteSync設定項目

システムからのSiteSync設定では、以下の設定項目を設定することが出来ます。

サイト/子サイトからプラグインの設定をする

サイト/子サイトからのSiteSync設定では、サイト/子サイトでのそれぞれの同期設定を行う事が出来ます。

1. サイト/子サイトのナビゲーションから ［設定］をクリックし、サブメニューから ［プラグイン］をクリックします。
2. ［SiteSync］をクリックし、［設定］をクリックします。
3. ［SiteSync］の設定画面が表示されるので、必要項目を入力し、［変更を保存］ボタンをクリックします。

   

サイト/子サイトのSiteSync設定項目

サイト/子サイトからのプラグイン設定では、以下の設定項目を設定することが出来ます。

AWS IAM Role を利用してAWS S3への同期設定をする

サイト/子サイトのプラグイン設定でプロトコル AWS S3 を選択してください。
[アクセスキー][シークレットアクセスキー] が入力されていない場合は、IAM Roleを利用するようになっています。
同期する際の条件は以下の通りです。

• Movable Type 動作環境内に、AWS CLI が導入されている事が必要になります。
• Movable Type 実行ユーザから、AWS CLI を実行するための適切なPATHや権限の設定が必要です。

同期タスクを作成する

設定が完了する事で、コンテンツの同期を行う為の、同期タスクの作成が出来る様になります。同期タスクの作成画面には以下の手順で移動する事が出来ます。

1. サイトダッシュボード、子サイトダッシュボードのナビゲーションから ［同期］をクリックし、サブメニューから［同期タスクの作成］をクリックします。
2. ［同期タスクの作成］の画面が表示されますので、右側の［同期設定］の内容を確認し、左側から、［同期対象］、［実行方法］、［同期する日時］を設定し、［同期する］ボタンをクリックします。

   

3. 同期タスクの作成 - 同期対象の図解

   

   

   

4. 2で設定した内容で同期タスクが登録されます。

同期タスクの作成画面と項目

右カラムは［同期設定］となります。ここには［サイト/子サイトからプラグインの設定をする］で行った設定内容の一部が表示されます。

左カラムは［同期タスクの設定］となります。コンテンツ同期を行うタスク設定として、［同期対象］、［実行方法］、［同期する日時］を設定し、同期タスクを登録します。右カラムで表示されている［同期設定］を、左カラムで行う［同期タスクの設定］の内容で、［同期タスク］を作成するという形になります。

同期タスクの管理をする

作成・登録した同期タスクは、同期タスクの管理画面で状態を確認する事が出来ます。同期タスクの管理画面には以下の手順で移動する事が出来ます。

1. サイトダッシュボード、子サイトダッシュボードのナビゲーションから［同期］をクリックし、サブメニューから［一覧］をクリックします。
2. 同期タスクの管理画面が表示されます。

   

同期タスクの一覧管理画面と項目

同期タスクの管理画面と項目についてご説明します。

同期タスクの管理画面では、登録されている同期タスクが一覧表示されます。
また、同期タスクの状態を確認したりする事が出来ます。

同期タスクの実行方法と同期処理について

ここでは、同期タスクの［実行方法］について、詳細と処理内容のご説明をします。

同期タスクの実行方法が［手動で同期する］の場合

［同期タスクの作成］の設定で［実行方法］が［手動で同期する］の場合には、Movable Typeの定期実行タスクを処理する run-periodic-tasks スクリプトが同期タスク設定後最初に起動/実行するタイミングで同期されます。自動で処理が行われるようにするには、予め、crontab に run-periodic-tasks スクリプトをスケジュール設定しておく必要が有ります。

同期タスクの実行方法が[日時を指定して同期する］の場合

［同期タスクの作成］の設定で［実行方法］が［日時を指定して同期する］の場合には、Movable Typeの定期実行タスクを処理する run-periodic-tasks スクリプトが公開および非公開時刻後 最初に起動/実行するタイミングで同期されます。自動で処理が行われるようにするには、予め、crontab に run-periodic-tasks スクリプトをスケジュール設定しておく必要が有ります。（詳しくはMovable Type製品別マニュアルの設定方法をご確認下さい）
また、以下の条件を満たす場合には同期タスク[日時を指定して同期する]が自動で作成されます。

• 記事もしくはウェブページを日時指定公開および指定日非公開で登録をする
• 登録された記事もしくはウェブページが紐づくサイトもしくは子サイトにSiteSyncの設定がされている

同期の定期実行 MTP8

同期を定期的に自動実行することができます。自動実行する場合は crontab に run-periodic-tasks スクリプトをスケジュール設定しておく必要が有ります。

メール通知について MTP7

メール通知機能が有効の場合、同期処理完了後には、同期処理が行われた事とその処理結果が、プラグインの設定項目の ［メール通知］で指定したメールアドレスにメールで通知されます。指定されていない場合には、同期処理を行ったサイトの管理者にメールで通知されます。

メール通知について MTP8

メール通知機能が有効の場合、同期処理完了後には、同期処理が行われた事とその処理結果が、プラグインの設定項目の ［メール通知］で指定したメールアドレスにメールで通知されます。指定されていない場合には、同期処理を行ったサイトの管理者にメールで通知されます。
メール通知機能はサイト/子サイト単位で設定できます。通知先のメールアドレスはカンマ区切りで複数設定できます。

メール通知テンプレート MTP8

メール通知のテンプレートは、システム > グローバルテンプレート内の [SiteSync からの通知] がメールテンプレートです。
メール通知のテンプレートサイト/子サイト毎に設定できます。

メール通知テンプレートはテンプレートモジュールで作成し、テンプレート名を [SiteSync Notification] としてください。子サイトにテンプレートがなければ親サイト、親サイトにテンプレートがない場合はシステムのテンプレートに沿ってメール通知をおこないます。

SiteSync - ウェブサイト/ブログの同期完了通知
【<$mt:BlogName$>】の<mt:if name="type_name" eq="MANUAL">手動同期<mt:elseif name="type_name" eq="SCHEDULE">スケジュール同期<mt:else>コマンドラインから同期</mt:if>が実行されました。

実行者: <$mt:var name="user_name"$>( <$mt:var name="user_id"$> )
指定日時: <$mt:var name="time_create"$>
開始時間: <$mt:var name="time_start_sync"$>
終了時間: <$mt:var name="time_end_sync"$>

内容：
<$mt:var name="message"$>

※詳細は同期ログまたはMovableTypeのログを参照してください。

テンプレートの一行目がメールの件名として通知されます。