静的化の設定

名称変更について

2025年3月に espar から espar vault (エスパーボルト)へ名称が変更されました。サービスの機能・仕様・価格に変更はありません。詳しくはこちらをご覧下さい。

本ページでは espar vault の静的化エンジンの設定について解説します。

追加取得パス

追加で取得したいページやファイルがある場合、そのパスを登録することができます。

espar vault のサイト全体の静的化は、CMS側のTOPページを取得してHTMLを解析し、サイト内ページを巡回しながら関連ファイルを取得していきます。HTML中に記述されている内容を解析しますので、HTLM中にそもそも記述のないものは取得されません。例えば、以下のものは取得されません。

HTML中に <a> タグでリンクされていないページや、PDF、動画、その他ファイル
HTLM中に <img> タグで指定されていない画像ファイル
HTML中に <link> タグで指定されていないCSSファイル
HTML中に <script> タグで指定されていないJavaScriptファイル

HTMLの中に記述がないものは存在しないものと見なされ静的化の対象となりません。結果として、画像の欠損やページの抜け等の現象が発生します。これを避けるため、静的化の対象外となってしまうファイルは、もれなく追加取得パスに登録する必要があります。(設定が必要な例を参照)

設定方法

espar vault 管理画面で [サイト反映]→[設定] をクリックします
[追加取得パス] のタブを開きます
テキストエリアに1行1パスで対象パスを入力します

パスを指定する際は必ずルート相対パスで記述して下さい。

設定が必要な例

追加取得パスに設定が必要な例を以下に紹介します。

クロール拒否ファイル

検索エンジンBOTや生成AIクローラー等にサイトをクロールしないように伝えるテキストファイルです。以下のようなファイルが該当します。

robots.txt
llms.txt

これらのファイルへのリンクをHTML中に記述されることはありませんので、明示的に追加取得パスで指定する必要があります。

広告関連ファイル

広告の計測や、なりすまし広告の防止のために設置されるテキストファイルです。以下のようなファイルが該当します。

ads.txt

リンクをHTML中に記述されることはありませんので、明示的に追加取得パスで指定する必要があります。

サイトマップファイル

サイトマップ用のXMLファイルです。サイトマップが階層化されて複数XMLファイルとして分割生成される場合、全てのXMLを追加しておく必要があります。

espar vault静的化エンジンはサイトマップ用XMLファイルの中身を解析することはできません。以下のようなサイトマップXMLファイル(index.xml)がある場合、

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="https://www.example.com/sitemap.xsl"?>
<sitemap>
    <loc>https://www.example.com/category.xml</loc>
    <lastmod>2025-03-23T22:07:59+00:00</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://www.example.com/posts.xml</loc>
    <lastmod>2025-03-23T22:07:59+00:00</lastmod>
  </sitemap>
</sitemapindex>

XML中に記載されている以下も個別に追加取得パスとして指定する必要があります。

/category.xml
/posts.xml
/sitemap.xsl

espar vault静的化エンジンは、将来サイトマップXMLの解析に対応する予定です。対応完了後はXML中のファイルを個別に追加取得パスに指定する必要はなくなります。(対応時期未定)

ドメイン認証用ファイル

サイトのドメインを保有しているかどうかを確認するために各サービスの事業者がサイトTOPの一致に設置することを要求するファイルです。具体的に以下のようなケースが該当します。

Search Console の利用開始
Let’s Encrypt 等の無償証明書の取得
iOSアプリの Universal Links の使用

いずれもHTLM中にリンクを記述するようなファイルではないため、明示的に追加取得パスに指定する必要があります。なお上記に限定されるものではありません。

JavaScriptからの参照ファイル

JavaScriptが動作して初めて読み込まれるファイルです。

JavaScriptコードにより形成される以下のタグや属性に指定されるファイル
- <img> タグの src 属性
- <link> タグの href 属性
- <script> タグの src 属性
- <a> タグの href 属性
- <iframe> タグの src 属性
- <video> タグの src 属性
- <audio> タグの src 属性
非同期通信で取得されるJSONファイルや、その中に記述された画像等のファイル

これらもHTML中に記載されない場合、明示的に追加取得パスに指定する必要があります。

追加取得パスの自動生成テクニック

サイトによっては、追加取得パスに個別ファイルを都度指定するのが難しい場合があります。

JavaScript中で記述されるファイルが動的に変化する
サイトマップ用ファイルが高頻度で追加されていく
TOPページから辿れないページが大量で且つ動的に変化する

こうした場合、espar vault静的化エンジン向けの専用ファイルを用意して追加取得パスに追加し、当該ファイルをPHP等で生成することによって運用を省力化するテクニックが使えます。

自動生成テクニックの手順

追加取得パスに/espar.htmlというパスを追加しておきます。
/espar.htmlを生成するプログラムを開発してCMS側サーバに設置します。/espar.html には espar vault 静的化エンジンに追加で取得させたいファイルを全て <a> タグで列挙します
```
<a href="/styles/dynamic.css">main.css</a>
<a href="/images/2025/01/20250101.jpg">20250101.jpg</a>
<a href="/images/2025/01/20250102.jpg">20250102.jpg</a>
<a href="/images/2025/01/20250103.jpg">20250103.jpg</a>
...(略)...
```
サイト更新の度に2.のプログラムが実行されるようにします。

自動生成テクニックのからくり

追加取得パスに/espar.htmlを設定することで、espar vault の静的化エンジンは以下のように挙動します。

(1) サイト全体の静的化の最後に追加取得パスにある /espar.html も取得する。
(2) /espar.html はHTMLなので中身を解析してリンク先を全て抽出する。
(3) (2)で抽出したリンク先のファイルを全て取得する。

/espar.html が最新の取得対象ファイル一覧になっていれば、個別のファイルを追加取得パスに指定する必要はなくなります。あとはプログラムで /espar.html が最新の一覧になるようにしておけば良い、というわけです。

以下は、静的化対象とならないファイルを格納した特定フォルダ内の画像一覧を /espar.html に出力する実装です。WordPressで投稿が保存された時や、メディア管理画面からファイルがアップロードされた時に発動します。

<?php
function generate_espar_html($post_id) {
    $directory = '/path/to/folder';
    $files = scandir($directory);

    $html = '<!DOCTYPE html><html><body>';
    foreach ($files as $file) {
        if ($file !== '.' && $file !== '..') {
            $ext = strtolower(pathinfo($file, PATHINFO_EXTENSION));
            if ($ext === 'jpg' || $ext === 'png') {
                $html .= '<a href="' . $directory . '/' . $file . '">' . $file . '</a><br>';
            }
        }
    }
    $html .= '</body></html>';
    file_put_contents(ABSPATH . 'espar.html', $html);
}
add_action('save_post', 'generate_espar_html');
add_action('add_attachment', 'generate_espar_html');
?>

本サンプルを適切な位置に実装すれば、常に最新の状態である /espar.html が追加取得パスとして扱われ、一覧内の画像がもれなく espar vault 静的化エンジンに取得されることになります。

(なお本サンプルそのまま使用することは避けて下さい。サイトに応じたセキュリティを考慮した実装が必要です。実装支援は致しかねますのであらかじめご了承下さい)

なお、サイト内からは /espar.html へ内部リンクをはらないようにして下さい。(一般閲覧者や検索エンジンBOTにその存在を明かす必要はないため)

クロール除外パス

特定のページやパスを静的化したくない場合に使用します。指定されたパスは処理対象には含まれませんので、サイト全体の静的化をデフォルトの設定で実施した場合、当該パスは公開サーバに存在しない(削除される)ことになります。詳しくはサイト全体の静的化の公開サーバへの転送時の挙動を確認して下さい。

サイトの反映

静的化が実行できないようにする設定です。

settings_3-0-0

この設定がONになっていると [サイト反映]→[条件を指定して反映] ページの最下部は以下のようになります。(デフォルトの表示)

チェックボックスがON
settings_3-0-1

「サイトの更新を反映する」の設定がOFFになっていると、ボタンが以下のように無効状態となり押せなくなります。

チェックボックスがOFF
settings_3-0-1

本設定は事故を回避するめ、お客様は変更ができないようになっています。変更が必要な場合、つまり一時的に静的化を禁止したい場合は、弊社担当者にお知らせ下さい。

設定内容の履歴

追加取得パスとクロール除外パスでは、設定内容の履歴を最大10世代前まで保持しています。「変更履歴」のリストボックスをクリックすると過去に設定を保存した日時が列挙されます。

settings_4-0-0

選択すると指定された日時の設定内容に切り替わります。過去の設定を確認する時に使用できます。