サイト全体の静的化

esparには幾つかの静的化方法が用意されています。

NO	方式	静的化の説明
1	サイト全体	サイトの全ページを静的化して反映します。
2	指定パスのみ	指定したページや、指定した画像等ファイルのみを反映します。複数可能。
3	テンプレート	静的化の種類とオプションを保存し、同じ設定を再利用して静的化します。

本ページでは上表のうち、サイト全体を静的化する方式について解説します。

1. サイト全体を静的化する

espar 導入後に最もよく使う基本的な操作となります。espar 静的化エンジンが CMS のトップページにアクセスし、リンクを辿りながらサイト全体の静的化を行います。原則、手動の操作となります。

operation_01-1-0

1-1. 仕組み

サイト全体の反映では、CMSサイトのトップページからリンクを1つずつ辿って全ページをHTMLファイル化します。併せて、各ページに必要な画像やCSSやJavaScript、PDF、動画ファイルなど、サイトを構成する全てのファイルを取得します。取得が完了すれば、公開用サーバに転送します。

manual_1-0-0

静的化エンジンはHTMLの内容のみを頼りに全ファイルをかき集めることに注意して下さい。HTMLの記述内容だけが頼りであり、従って以下のような関連ファイルは静的化の対象外となる可能性があります。

HTML中に <img src=".."> タグ等で記述のない画像
HTML中に <a href="..."> タグ等でリンクが貼られていないページやPDF,zipファイル等

espar 静的化エンジンに対してCMSが応答する時のHTML内に記述されている必要があります。HTML中にリンクや参照の記述が無いものは、静的化されず欠損しますので十分にご注意下さい。制作の留意点についてのページもご覧下さい。

1-2. 操作手順

espar の管理画面で以下の通り操作してください。(基本的なサイト更新にも記載しています)

CMSを操作して編集作業を行って下さい。
CMSを操作してプレビュー→更新(または公開)をして下さい。
espar 管理画面にログインして下さい。(ホスト名やパスワードはご発注時にお知らせします)
ログイン後の画面で「サイト全体を更新する」が選択されていることを確認し、一番下にある「反映」ボタンをクリックして下さい。
静的化が開始され以下のように「サイト更新中…」と表示されます。
静的化が完了すると以下のように「更新完了」と表示されます。

以上でサイト全体の静的化は完了となります。サイトのURLをブラウザで開き、CMSで行った編集結果が反映されているかを確認して下さい。

1-2-1. 停止

操作手順5で「反映」をクリックすると、ボタンが以下のように赤色の「停止」ボタンに変わります。

manual_2-0-x

万が一、静的化を中断したい場合は「停止」ボタンをクリックして下さい。数秒後にサイト全体の静的化が停止します。なお停止した場合、途中まで静的化されたものは破棄され公開サーバに反映されることはありません。

1-2-2. 経過ログ

操作手順5で「反映」ボタンをクリックした後、今どのページが静的化されているか…をリアルタイムに確認することができます。[詳細表示] のリンクをクリックして下さい。下図のように表示されます。

operation_02-2-2

ログ表示は約3秒ごとに更新されます。静的化が完了すると、下図のようにログ末尾に finish. と出力されます。万が一エラーが発生した場合にはエラーの内容が出力されます。

operation_02-2-3

1-3. 公開サーバへの転送時の挙動

サイト全体の静的化では、サイトの全ページと関連ファイルの取得が全て完了してから、取得したファイルを一括で公開サーバに転送します。具体的には以下のような挙動となります。

静的化エンジンは、サイト全ページをHTMLファイル化し、関連ファイルも全て取得
1.で取得したファイル一式を公開サーバの一時ディレクトリに転送する (上書き転送ではない)
既存の本ディレクトリを2.の一時ディレクトリを入れ替える (ここで初めて反映したことになる)

この挙動から、理解しておくべきポイントが3つあります。

esparの静的化エンジンが取得した全ファイルは、公開サーバに転送される際、一時ディレクトリに転送されます。既存の本ディレクトリ(閲覧者のアクセスに応答するファイルが配置されたディレクトリ)に上書き転送するわけではありません。一時ディレクトリへの転送が完了後、これを新たな本ディレクトリとします(切り替え)。そして既存の「元」本ディレクトリは破棄されます。

従って、直前の静的化の内容は保持されません。このような仕様の挙動となるため、サイト全体の静的化では、公開サーバの領域は一度全削除された後に一式転送されると考えて頂くと分かりやすいです。厳密にはディレクトリの入れ替えですので、サイト応答不可時間が発生するわけではありません。

1-4. オプション

1-4-1. 『一時的にクロールから除外するパスを指定してください』

サイト全体の静的化で、一時的に特定のページや関連ファイルを対象としなくない場合、明示的にそのパスを指定することで更新対象外とすることができます。具体的には以下のような場合に利用できます。

サイト全体を反映したいが、特定のページについては更新せずそのままにしておきたい
サイト全体を反映したいが、特定の画像ファイルだけは直前の状態のままにしておきたい

指定する際は、1行に1パスで指定して下さい。

本オプションで指定するパスには、正規表現が使用できます。パスに正規表現を使用する場合は、行頭に re: を付けて例えば以下のように指定して下さい。

re:/index_[0-9]

1-4-2. 『リンク切れしたページや画像等を削除しない』

公開サーバへの転送時の挙動 Point2 に記載の通り、静的化したファイル一式が公開サーバに転送される際、一度全削除された後に転送されるのと同じ挙動となります。

通常は問題ありませんが、この挙動では困る、つまり「一度静的化したものはずっと公開サーバ上に残しておいて欲しい」という要件がある場合、本オプションをONにして下さい。