Laravel 11.x デプロイ

イントロダクションIntroduction

Laravelアプリケーションをプロダクションとしてデプロイする準備ができたら、アプリケーションをできるだけ確実かつ、効率的な実行を行うには、いくつか重要な手順を行う必要があります。このドキュメントでは、アプリケーションを確実にデプロイするため、重要なポイントを説明します。When you're ready to deploy your Laravel application to production, there are some important things you can do to make sure your application is running as efficiently as possible. In this document, we'll cover some great starting points for making sure your Laravel application is deployed properly.

サーバ要件Server Requirements

Laravelフレームワークにはいくつかのシステム要件があります。Webサーバへ確実に以下のPHP最低バージョンと拡張機能を用意してください。The Laravel framework has a few system requirements. You should ensure that your web server has the following minimum PHP version and extensions:

サーバ設定Server Configuration

NginxNginx

Nginxを実行しているサーバにアプリケーションをデプロイする場合は、以下の設定ファイルをWebサーバを設定するためのサンプルとして使用できます。大抵の場合、このファイルはサーバの設定に応じてカスタマイズする必要があります。サーバの管理についてサポートが必要な場合は、Laravel ForgeなどのファーストパーティのLaravelサーバ管理とデプロイサービスの使用を検討してください。If you are deploying your application to a server that is running Nginx, you may use the following configuration file as a starting point for configuring your web server. Most likely, this file will need to be customized depending on your server's configuration. If you would like assistance in managing your server, consider using a first-party Laravel server management and deployment service such as Laravel Forge[https://forge.laravel.com].

以下の設定のように、Webサーバがすべてのリクエストをアプリケーションのpublic/index.phpファイルへ確実に送信してください。プロジェクトルートからアプリケーションを提供すると、多くの機密性の高い設定ファイルがパブリックインターネットに公開されるため、index.phpファイルをプロジェクトのルートに移動しようとしないでください。Please ensure, like the configuration below, your web server directs all requests to your application's public/index.php file. You should never attempt to move the index.php file to your project's root, as serving the application from the project root will expose many sensitive configuration files to the public Internet:

server {
    listen 80;
    listen [::]:80;
    server_name example.com;
    root /srv/example.com/public;

    add_header X-Frame-Options "SAMEORIGIN";
    add_header X-Content-Type-Options "nosniff";

    index index.php;

    charset utf-8;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location = /favicon.ico { access_log off; log_not_found off; }
    location = /robots.txt  { access_log off; log_not_found off; }

    error_page 404 /index.php;

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        include fastcgi_params;
    }

    location ~ /\.(?!well-known).* {
        deny all;
    }
}

最適化Optimization

アプリケーションを本番環境にデプロイする際は、設定、イベント、ルート、ビューなど、キャッシュすべき様々なファイルがあります。Laravelはこれらのファイルをすべてキャッシュする便利なoptimize Artisanコマンドを提供しています。このコマンドは通常、アプリケーションのデプロイプロセスの一部として起動する必要があります：When deploying your application to production, there are a variety of files that should be cached, including your configuration, events, routes, and views. Laravel provides a single, convenient optimize Artisan command that will cache all of these files. This command should typically be invoked as part of your application's deployment process:

php artisan optimize

optimize:clearメソッドは、optimizeコマンドが生成したキャッシュファイルをすべて削除するために使います。The optimize:clear method may be used to remove all of the cache files generated by the optimize command:

php artisan optimize:clear

以下の文書では、optimizeコマンドが実行する、最適化コマンドの詳細それぞれについて説明します。In the following documentation, we will discuss each of the granular optimization commands that are executed by the optimize command.

設定のキャッシュCaching Configuration

アプリケーションをプロダクションへデプロイする場合、デプロイプロセスの中で、確実にconfig:cache Artisanコマンドを実行してください。When deploying your application to production, you should make sure that you run the config:cache Artisan command during your deployment process:

php artisan config:cache

このコマンドは、Laravelの全設定ファイルをキャッシュされる一つのファイルへまとめるため、設定値をロードする場合に、フレームワークがファイルシステムを数多くアクセスする手間を大いに減らします。This command will combine all of Laravel's configuration files into a single, cached file, which greatly reduces the number of trips the framework must make to the filesystem when loading your configuration values.

warning Warning! 開発時にconfig:cacheコマンドを実行する場合は、設定ファイルの中だけで、env関数を呼び出していることを確認してください。設定ファイルがキャッシュされてしまうと、.envファイルはロードされなくなり、.env変数に対するenv関数の呼び出し結果はすべてnullになります。[!WARNING]
If you execute the config:cache command during your deployment process, you should be sure that you are only calling the env function from within your configuration files. Once the configuration has been cached, the .env file will not be loaded and all calls to the env function for .env variables will return null.

イベントのキャッシュCaching Events

デプロイ処理中で、アプリケーションの自動検出イベントとリスナのマッピングをキャッシュする必要があります。これは、デプロイ中にevent:cache Artisan コマンドを呼び出すことで行えます。You should cache your application's auto-discovered event to listener mappings during your deployment process. This can be accomplished by invoking the event:cache Artisan command during deployment:

php artisan event:cache

ルートのキャッシュCaching Routes

多くのルートを持つ大きなアプリケーションを構築した場合、デプロイプロセス中に、route:cache Artisanコマンドを確実に実行すべきでしょう。If you are building a large application with many routes, you should make sure that you are running the route:cache Artisan command during your deployment process:

php artisan route:cache

このコマンドはキャッシュファイルの中の、一つのメソッド呼び出しへ全ルート登録をまとめるため、数百のルートを登録する場合、ルート登録のパフォーマンスを向上します。This command reduces all of your route registrations into a single method call within a cached file, improving the performance of route registration when registering hundreds of routes.

ビューのキャッシュCaching Views

実機環境へアプリケーションをデプロイする場合は、その手順の中でview:cache Artisanコマンドを実行すべきでしょう。When deploying your application to production, you should make sure that you run the view:cache Artisan command during your deployment process:

php artisan view:cache

このコマンドは全Bladeビューを事前にコンパイルし、要求ごとにコンパイルしなくて済むため、ビューを返すリクエストすべてでパフォーマンスが向上します。This command precompiles all your Blade views so they are not compiled on demand, improving the performance of each request that returns a view.

デバッグモードDebug Mode

config/app.php設定ファイルのdebugオプションは、エラーに関する情報を実際にユーザーへ表示する量を決定します。このオプションはデフォルトで、アプリケーションの.envファイルに格納している、APP_DEBUG環境変数の値を利用するように設定されています。The debug option in your config/app.php configuration file determines how much information about an error is actually displayed to the user. By default, this option is set to respect the value of the APP_DEBUG environment variable, which is stored in your application's .env file.

warning Warning! 実稼働環境下では、この値は常にfalseである必要があります。本番環境でAPP_DEBUG変数がtrueに設定されていると、機密性の高い設定値がアプリケーションのエンドユーザーに公開されるリスクがあります。[!WARNING]
In your production environment, this value should always be false. If the APP_DEBUG variable is set to true in production, you risk exposing sensitive configuration values to your application's end users.

ヘルスルートThe Health Route

Laravelは、アプリケーションのステータスを監視するために使用できる組み込みのヘルスチェックルートを用意しています。本番環境では、このルートを使用して、アプリケーションの状態をアップタイムモニタ、ロードバランサ、またはKubernetesのようなオーケストレーションシステムへ報告できます。Laravel includes a built-in health check route that can be used to monitor the status of your application. In production, this route may be used to report the status of your application to an uptime monitor, load balancer, or orchestration system such as Kubernetes.

ヘルスチェックのルートはデフォルトで、/upで提供しており、アプリケーションが例外なく起動した場合は 200 HTTPレスポンスを返します。そうでない場合は、500 HTTPレスポンスを返します。このルートのURIは、アプリケーションのbootstrap/appファイルで設定できます。By default, the health check route is served at /up and will return a 200 HTTP response if the application has booted without exceptions. Otherwise, a 500 HTTP response will be returned. You may configure the URI for this route in your application's bootstrap/app file:

->withRouting(
    web: __DIR__.'/../routes/web.php',
    commands: __DIR__.'/../routes/console.php',
    health: '/up', // [tl! remove]
    health: '/status', // [tl! add]
)

HTTPリクエストがこのルートへ行われると、Laravelは Illuminate\Foundation\Events\DiagnosingHealthイベントもディスパッチするため、アプリケーションに関連する追加のヘルスチェックを実行できます。このイベントのリスナ内で、アプリケーションのデータベースやキャッシュの状態をチェックできます。アプリケーションに問題が見つかった場合は、リスナから例外を投げるだけです。When HTTP requests are made to this route, Laravel will also dispatch a Illuminate\Foundation\Events\DiagnosingHealth event, allowing you to perform additional health checks relevant to your application. Within a listener[/docs/{{version}}/events] for this event, you may check your application's database or cache status. If you detect a problem with your application, you may simply throw an exception from the listener.

Forge／Vaporを利用する簡単なデプロイEasy Deployment With Forge / Vapor

Laravel ForgeLaravel Forge

自分のサーバ設定管理に準備不足であったり、堅牢なLaravelアプリケーション実行に必要な数多くのサービスすべての設定について慣れていなければ、Laravel Forgeは素晴らしい代替案です。If you aren't quite ready to manage your own server configuration or aren't comfortable configuring all of the various services needed to run a robust Laravel application, Laravel Forge[https://forge.laravel.com] is a wonderful alternative.

Laravel ForgeはDigitalOcean、Linode、AWSなど数多くのインフラプロバイダ上に、サーバを作成できます。それに加え、ForgeはNginx、MySQL、Redis、Memcached、Beanstalkなどのような、堅牢なLaravelアプリケーションを構築するために必要なツールを全部インストールし、管理します。Laravel Forge can create servers on various infrastructure providers such as DigitalOcean, Linode, AWS, and more. In addition, Forge installs and manages all of the tools needed to build robust Laravel applications, such as Nginx, MySQL, Redis, Memcached, Beanstalk, and more.

lightbulb Note: Laravel Forgeでデプロイするための完全なガイドが必要ですか？Laravel BootcampとLaracastsで視聴できるForgeのビデオシリーズをご覧ください。[!NOTE]
Want a full guide to deploying with Laravel Forge? Check out the Laravel Bootcamp[https://bootcamp.laravel.com/deploying] and the Forge video series available on Laracasts[https://laracasts.com/series/learn-laravel-forge-2022-edition].

Laravel VaporLaravel Vapor

Laravel向け完全サーバレスのオートスケーリング開発プラットフォームが必要な場合は、Laravel Vaporをチェックしてください。Laravel Vaporは、AWSで動作するLaravelのサーバレス開発プラットフォームです。Vapor上でLaravelインフラを起動し、サーバレスのスケーラブルなシンプルさに魅了されてください。Laravel Vaporは、Laravelの作成者によりフレームワークとシームレスに連携するように調整されているため、普段通りにLaravelアプリケーションを書き続けられます。If you would like a totally serverless, auto-scaling deployment platform tuned for Laravel, check out Laravel Vapor[https://vapor.laravel.com]. Laravel Vapor is a serverless deployment platform for Laravel, powered by AWS. Launch your Laravel infrastructure on Vapor and fall in love with the scalable simplicity of serverless. Laravel Vapor is fine-tuned by Laravel's creators to work seamlessly with the framework so you can keep writing your Laravel applications exactly like you're used to.