マニュアル目次 > まず読む

はじめての設定

上から順にたどれば、公開までひと通り終わります。

この順番で進めます

サーバー側の準備(プラグインの導入・cron・公開先ディレクトリの用意)が済んでいることが前提です。まだの場合は先に インストールと配置cronの設定 を読んでください。

  1. 設定画面で場所を決める

    左メニュー「静的HTMLジェネレーター」>「設定」を開き、基本セクションの4つを入力します。詳しくは 基本・実行・全生成 を参照してください。

    • 静的生成の有効/無効 … チェックを入れます。ここがオフの間は何も動きません(記事を保存しても再生成されず、ダッシュボードのボタンも押せず、cron も処理しません)
    • 一時生成先パス … 既定のままで構いません(公開ディレクトリの外を指しています)
    • 公開先パス … 閲覧者に見せるディレクトリを入力します
    • 公開サイトURL … 公開先を見るときのURL。CMSと違うドメインなら必ず入力してください
  2. まず1ページだけ試す

    いきなり全ページ作ると、設定が間違っていたときに原因が分かりません。ダッシュボードの 差分生成 を押してから 今すぐキュー処理 を押し、ジョブ の画面で「完了」が並ぶか、HTTPステータスが 200 になっているかを確かめます。

    サーバーにログインできるなら、1URLだけを指定するほうが確実です。

    bin/cake hat_static_engine generate --url=/
    bin/cake hat_static_engine work
  3. 書き出し先にファイルができたか見る

    「一時生成先パス」に指定した場所に index.html ができていれば成功です。ここで何もできていない場合は、よくあるつまずき を確認してください。

  4. 全ページ再生成する

    ダッシュボードの 全ページ再生成 を押します。押した時点では対象を数えてキューに積むだけで、まだ1枚も作られていません。

    あとは cron が数分おきに少しずつ処理します。急ぐ場合は 今すぐキュー処理 を何回か押してください。進み具合は バッチ の画面で確認できます。

  5. 公開する

    全ページ再生成が「完了」になり、失敗が0件であれば、自動的に公開まで行われます。手動で公開したいときはダッシュボードの 公開 を押します。

    失敗が1件でもあると、公開は自動的に見送られます。中途半端な状態のサイトを公開しないためです。ジョブ で失敗の内容を確認し、直してから 失敗分を再試行 を押してください。

  6. 公開先をブラウザで見る

    「公開サイトURL」を開いて、トップページ・記事ページ・画像・CSSが正しく表示されるか確認します。リンクをいくつか辿ってみてください。

  7. 毎晩の全ページ再生成をcronに登録する

    設定画面の全生成セクションにcronの記述例が出ています。それをサーバーのcrontabへ登録すると、毎晩サイト全体が最新の状態になります(実行時刻はcron側で決めます)。詳しくは cronの設定

ここまでで運用できます

「毎晩まとめて最新にする」だけでよければ、設定はここで完了です。差分生成の設定は必須ではありません。

「記事を直したらすぐ公開サイトに反映したい」となってから、差分生成の詳細 を読んで設定してください。

最初につまずきやすいところ

症状まず見るところ
何も起きない 設定の「静的生成の有効/無効」がオフになっていないか。cron が動いているか(cronの設定)。
ジョブが失敗する ジョブ の画面でエラー内容を見ます。書き出し先ディレクトリの書き込み権限が無いことが多いです。
画像とCSSが出ない 設定の「静的ファイル同期」が有効か。有効でも公開されないときは 静的ファイル同期 を参照。
公開されない 失敗ジョブが残っていないか。公開先パスの書き込み権限があるか。