1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

さくらのレンタルサーバー(スタンダード)に、LaravelをGitHub Actionsから自動デプロイする。公開フォルダを分けて踏んだ4つの罠

1
Posted at

さくらのレンタルサーバー(スタンダード、SSHが使えるプラン)に、Laravelの小さなWebサービスを置いています。mainブランチにpushすると、GitHub Actionsがビルドして、SSHで本番に反映する形です。

この記事は、アプリ本体を公開フォルダの外に置く構成で、実際に踏んだ4つの罠と、その直し方の記録です。同じ構成を、ほかのサービスに転用するときの参考にしてください。

どんな用途か

  • 個人の事業で使う、診断ツール(無料の診断フォーム→結果画面→有料の詳細レポート(PDF)。決済のStripeは、まだテスト段階です)
  • Laravel、Vite(フロントのビルド)、MySQL、Stripe決済、PDF生成(barryvdh/laravel-dompdf)
  • 同じさくらのサーバーに、独自ドメインのサービスを複数、同居させている

構成: アプリ本体と公開フォルダを分ける

Laravelは、public/の中だけを、Webに見せる設計です。そこで、さくらのサーバー上では、次のように分けています。

~/apps/my-app/     ← アプリ本体(.env、vendor、storageなど。Webから見えない)
~/www/my-app/      ← 公開フォルダ(ドメインのドキュメントルート。public/の中身だけ)

こうしておくと、.envなどが、設定ミスでもWebに出ません。代わりに、public/index.phpを、本体の場所に合わせて書き換える必要があります。

deploy/public-index.php(抜粋)
// ~/www/my-app/index.php から見て、本体は ../../apps/my-app
$appBase = __DIR__.'/../../apps/my-app';

require $appBase.'/vendor/autoload.php';
$app = require_once $appBase.'/bootstrap/app.php';

// public/ の実体は、このファイルのあるフォルダ。public_path() をここに向ける
$app->usePublicPath(__DIR__);

$app->handleRequest(Request::capture());

デプロイの流れ(GitHub Actions)

  1. PHPとNodeを用意して、composer install --no-devとnpm ci && npm run buildでビルドする
  2. 本番用の.envを、GitHubのSecretsから生成する
  3. public/を一時フォルダにコピーして、index.phpだけ、上の分離用のものに差し替える
  4. SSHで、rsyncを2回する(本体→~/apps/、publicの中身→~/www/)
  5. SSHで、本番側でマイグレーションとキャッシュ生成をする
- name: アプリ本体を公開フォルダの外へ同期
  run: |
    rsync -az --delete \
      --exclude='.git' --exclude='.github' --exclude='node_modules' \
      --exclude='tests' --exclude='public' --exclude='deploy' \
      --exclude='storage/logs/*' \
      ./ ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:apps/my-app/

- name: publicの中身をドキュメントルートへ同期
  run: |
    rsync -az --delete \
      deploy/public-dist/ \
      ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:www/my-app/

- name: マイグレーション・キャッシュ生成をリモート実行
  run: |
    ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} '
      cd apps/my-app
      chmod -R 775 storage bootstrap/cache
      php artisan migrate --force
      php artisan config:cache
      php artisan route:cache
      php artisan view:cache
    '

ここから、踏んだ罠です。

罠1: CI用のSSH鍵の公開鍵を、サーバーに登録し忘れた

GitHub Actionsには、CI専用のSSH鍵の秘密鍵を、Secretsに登録しました。ところが、対になる公開鍵を、さくら側の~/.ssh/authorized_keysに追加するのを、忘れていました。接続が拒否されて、デプロイが止まります。

自分用の鍵とは別に、CI専用の鍵を作った場合は、公開鍵の登録も、別途必要です。

罠2: public_path()が、存在しない場所を向いた(Vite manifestエラー→500)

分離構成では、アプリ本体側(~/apps/my-app)にpublic/がありません。ところが、Laravelのpublic_path()は、本体側のpublic/を向きます。Viteのビルド結果(manifest.json)を探して見つからず、画面が500になりました。

直し方は、上のindex.phpにある、$app->usePublicPath(__DIR__);の1行です。公開フォルダの場所を、Laravelに教えます。

罠3: Secretsに貼ったAPIキーが、1文字欠けていた

決済(Stripe)のシークレットキーを、GitHub Secretsに貼りました。本番で試すと、Invalid API Keyのエラーです。調べると、コピペで、1文字欠けていました。

キーの不具合は、まず文字数を疑うのが早道でした。ログや画面に、キーそのものを出さずに、長さだけを確かめます。

罠4: config:cacheが、PDFのpublic_pathを、存在しない場所に固定した

罠2を直したあとも、PDFの生成だけが、「Cannot resolve public path」というエラーで失敗しました。

原因は、php artisan config:cacheです。キャッシュは、artisanを実行した時点の値で、設定を固定します。デプロイ時のartisanの実行では、public/が存在しません。PDFのパッケージのconfig/dompdf.phpにあるpublic_pathが、その時点の、存在しないパスで固定されてしまいました。usePublicPath()だけでは、config:cacheの分までは、直りません。

直し方は、PDFを作る直前に、リクエスト処理中の正しいpublic_path()で、設定を上書きすることです。

// config:cache済みの dompdf.public_path は、キャッシュ生成時の値のまま固定される。
// PDFを作る直前に、リクエスト中の正しい public_path() で上書きする。
config(['dompdf.public_path' => public_path()]);

分離構成のまま、storageやpublicのパスに依存するパッケージを、新しく入れるときは、同じ問題が起きうると考えています。

おまけ: 踏んだ小さな点

  • PDFのサイズ: 日本語のPDFで、フォントを埋め込むと、1通が10MBを超えて、実用になりませんでした。config/dompdf.phpの**enable_font_subsettingをtrue**にして、使う文字だけを埋め込むようにして解決しました
  • SSHのログインシェル: さくらのリモートのログインシェルは、bashではありませんでした。SSHで直接コマンドを打つときは、ssh host "bash -lc '...'"のように、bashを明示します。生のシェルに2>&1などを渡すと、Ambiguous output redirectエラーになりました(上のワークフローのコマンドは、リダイレクトを含まないので、そのままで動いています)
  • SSL(Let's Encrypt): 独自ドメインで無料SSLを発行するときは、www.付きの名前も、DNSで引ける必要がありました。www.付きのAレコードを足して、解決しました

まとめ

  • アプリ本体を公開フォルダの外に置く構成は、.envなどをWebに出さない点で安心。そのかわり、index.phpの差し替えと、usePublicPath()が要る
  • CIの鍵は、秘密鍵をSecretsに、公開鍵をサーバーに、両方登録する
  • config:cacheは、キャッシュ生成時の環境の値を固定する。分離構成では、publicやパスに依存する設定が、ずれることがある
  • 鍵が通らないときは、まず文字数を疑う
  • さくらのスタンダードで、SSHとGitHub Actionsによる自動デプロイは、問題なく動く

この記事はZennにも投稿しています。

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?