マニュアル目次 > 設定画面

公開設定

メニュー:静的HTMLジェネレーター > 設定 > 公開設定/rsync設定

このセクションで決めること

書き出し先にできたファイルを、どうやって公開先へ運ぶかの設定です。

公開設定

項目内容
公開方式初期値: ローカル ローカル:同じサーバー内の別ディレクトリへコピーします。コピー先は基本設定の「公開先パス」です。PHPだけで動くので、どの環境でも使えます。
rsync:SSH経由で別サーバーへ転送します。転送先は下の「rsync設定」で指定し、「公開先パス」は使いません。詳しくは 別サーバーへの配信
選ぶと、関係のある入力欄だけが表示されます(「rsync」なら公開先パスが隠れ、rsync設定が出ます)。
サーバーで proc_open が無効化されている場合(レンタルサーバーでよくある制限)、rsync は選べません。その旨が画面に表示されます。
差分生成のたびに公開する初期値: 有効 コンテンツの保存などで数ページだけ作り直したときも、その都度すぐ公開先へ反映します。オフにすると、全ページ再生成のときだけ反映します。
転送に時間がかかる構成(別サーバーへのrsync)で、保存のたびの転送が負担になる場合はオフにしてください。
公開先の余分なファイルを削除する初期値: 有効 書き出したファイル一式に含まれていないのに公開先に残っているファイルを、「CMSから消されたページ」とみなして公開先から削除します。
オフにすると、削除したページが公開サイトに残り続けます。
削除除外パターン 上の削除の対象から外したいファイルを1行1パターンで指定します。この欄は「公開先の余分なファイルを削除する」にチェックが入っているときだけ表示されます。
削除の安全ブレーキ(無くなったページの割合・%)初期値: 20 無くなったページの割合がこの値を超えたら発動し、その回の公開先の削除を見送ります(公開そのものは行います)。「20」なら、1,000ページのうち201ページ以上が無くなった回で発動します。0にすると無効になり、常に削除します。詳しくは下の「削除の安全ブレーキ」。
通知先メールアドレス 安全ブレーキが働いたとき、URLを1件も集められず全生成を中止したときに、ここへメールで知らせます。空の場合はサイト基本設定の管理者メールアドレスへ送ります。カンマ区切りで複数指定できます。
公開先へ手作業で置いたファイルも削除されます。 書き出したファイル一式に含まれないためです。このプラグイン専用のディレクトリを公開先に指定するか、下の削除除外パターンで守ってください。

削除除外パターン

公開先にしか置いていないファイルを残したいときに使います。公開先が別サーバーで、そこに固有のファイルがある場合に必要になります。

公開先の中でのパスを、先頭の「/」から書いてください。

よくある指定

/.well-known/**      … 証明書の自動更新などに使われるフォルダ
/google1234.html     … 検索エンジンの所有権確認ファイル
/.htaccess           … 公開サーバー固有の設定ファイル
書き出し先にも同じファイルがある場合は、この設定に関係なく上書きされます。 これは「削除だけを止める」設定です。更新まで止めたい場合は、そもそも書き出し先に同名のファイルを作らないようにしてください。

削除の安全ブレーキ

公開サイトが丸ごと空になる事故を防ぐための仕組みです。初期状態で有効になっています。

このプラグインは、CMSにページを取りに行って「見つからない」と返されたページを、削除されたものとして扱います。1ページずつ見れば正しい動きですが、次のような場合は全ページが同時に「見つからない」になります。

この状態でそのまま公開すると、公開サイトのファイルがすべて削除されます。そこで、全ページ再生成の結果を集計し、無くなったページの割合が設定値を超えていたら、その回は削除だけを見送ります

数値の意味

「無くなったページの割合」が設定値を超えたら発動します。残ったページ数を見ているのではありません。小さくするほど厳しく(少しの削除でも止まる)、大きくするほど緩くなります。

設定値1,000ページのサイトでの動き
551ページ以上が無くなったら発動。少しの削除でも止まります
20初期値201ページ以上が無くなったら発動
50501ページ以上(半分より多く)が無くなったら発動
0無効。どれだけ無くなっても、そのまま削除します
「無くなったページ」は次の2つで数えます。多いほうを判定に使います。
・CMSから「見つからない」「権限がない」と返されたページ(HTTPステータス 401・403・404・410)
・前回はあったのに、今回の再生成では一度も現れなかったURL

発動したときの動き

項目内容
止めるもの公開先の削除だけ。公開そのものは行います(作れたページの更新は公開サイトへ届きます)。消えたページは公開先に残るだけなので、リンク切れにはなりません。
知らせ方ダッシュボードに警告、ログに警告、そして管理者へメール。バッチ一覧の「公開」欄が「削除を保留」になります。
働かない場合ページ数が10件に満たないときは判定しません(数ページのサイトで1ページ消しただけで反応してしまうため)。
働いたあとCMS側の原因(アクセス制限・メンテナンス表示・URLの変更)を取り除いてから、もう一度「全ページ再生成」を実行してください。ページが取れるようになっていれば、そのときに削除も行われます。意図した削除でブレーキがかかった場合は下の注意を参照してください。
サイトを大きく作り替えたときにも働きます。 初期値の20なら、ページの2割を超えるページを一度に削除する改装で、意図した削除でもブレーキがかかります。 この場合、もう一度実行しても同じ判定になります(無くなったページは無くなったままなので)。 削除が意図どおりだと確認できたら、この値を一時的に大きくするか 0 にして全ページ再生成を1回実行し、 そのあと元の値に戻してください。 公開先から消えるファイルは、生成済みURL で「削除済み」を確認できます。
URLを1件も集められなかった全ページ再生成は、そもそも実行されません。 そのまま進めると、前回作ったページがすべて削除対象になるためです。この場合も管理者へメールで知らせ、 URL収集方法 を確認するよう促します。

公開が実行されるタイミング

タイミング条件
全ページ再生成の完了時失敗が0件のときだけ自動的に公開されます。1件でも失敗があると見送られ、ログに警告が残ります。
差分生成の処理後「差分生成のたびに公開する」が有効なとき。ただし全ページ再生成の実行中は、そちらの完了時にまとめて公開されます。
手動ダッシュボード公開 ボタン、またはコマンド。
公開の直前には、静的ファイル同期と sitemap.xml の生成が必ず実行されます。 「画像を同期し忘れたまま公開して、公開先の画像が全部消えた」という事故を防ぐためです。

転送量を抑える仕組み

生成したHTMLの内容が前回とまったく同じ場合は、書き出し自体を省略します。書き出さなければファイルの更新日時が変わらないので、公開転送からも自動的に外れます。設定は不要で、常に働きます。

ページ内にリクエストごとに変わる値が含まれていると、この仕組みは働きません。 内容が実質同じでもバイト列が変わるため、毎回すべてのページが再転送されます。心当たりがある場合は テーマ制作の注意点 を確認してください。

rsync設定

「公開方式」で rsync を選んだときに使います。項目の意味と設定手順は 別サーバーへの配信 にまとめてあります。