イントロダクションIntroduction
Laravel Sail(セイル、帆、帆船)は、LaravelのデフォルトのDocker開発環境を操作するための軽量コマンドラインインターフェイスです。 Sailは、Dockerの経験がなくても、PHP、MySQL、Redisを使用してLaravelアプリケーションを構築するための優れた出発点を提供します。Laravel Sail[https://github.com/laravel/sail] is a light-weight command-line interface for interacting with Laravel's default Docker development environment. Sail provides a great starting point for building a Laravel application using PHP, MySQL, and Redis without requiring prior Docker experience.
Sailの本質は、docker-compose.yml
ファイルとプロジェクトのルートに保存されているsail
スクリプトです。sail
スクリプトは、docker-compose.yml
ファイルで定義されたDockerコンテナを操作するための便利なメソッドをCLIで提供します。At its heart, Sail is the docker-compose.yml
file and the sail
script that is stored at the root of your project. The sail
script provides a CLI with convenient methods for interacting with the Docker containers defined by the docker-compose.yml
file.
Laravel Sailは、macOS、Linux、Windows(WSL2を使用)に対応しています。Laravel Sail is supported on macOS, Linux, and Windows (via WSL2[https://docs.microsoft.com/en-us/windows/wsl/about]).
インストールと準備Installation and Setup
Laravel Sailはいつも、新しいLaravelアプリケーションとともに自動的にインストールされるため、すぐ使用を開始できます。新しいLaravelアプリケーションを作成する方法については、使用しているオペレーティングシステム用のLaravelインストールドキュメントを参照してください。インストール時には、アプリケーションで操作するSailサポートサービスを選択するよう求められます。Laravel Sail is automatically installed with all new Laravel applications so you may start using it immediately. To learn how to create a new Laravel application, please consult Laravel's installation documentation[/docs/{{version}}/installation#docker-installation-using-sail] for your operating system. During installation, you will be asked to choose which Sail supported services your application will be interacting with.
既存アプリケーションへのSailインストールInstalling Sail Into Existing Applications
既存のLaravelアプリケーションでSailを使うことに興味を持っている場合は、Composerパッケージマネージャを使用してSailをインストールできます。もちろん、以降の手順は、既存のローカル開発環境で、Composerの依存関係をインストールできると仮定しています。If you are interested in using Sail with an existing Laravel application, you may simply install Sail using the Composer package manager. Of course, these steps assume that your existing local development environment allows you to install Composer dependencies:
composer require laravel/sail --dev
Sailをインストールしたら、sail:install
Artisanコマンドを実行します。このコマンドはSailのdocker-compose.yml
ファイルをアプリケーションのルートに発行し、.env
ファイル中でDockerサービスに接続するために必要な環境変数を変更します:After Sail has been installed, you may run the sail:install
Artisan command. This command will publish Sail's docker-compose.yml
file to the root of your application and modify your .env
file with the required environment variables in order to connect to the Docker services:
php artisan sail:install
最後に、Sailを立ち上げましょう。Sailの使い方を学び続けるには、このドキュメントの残りを続けてお読みください。Finally, you may start Sail. To continue learning how to use Sail, please continue reading the remainder of this documentation:
./vendor/bin/sail up
Warning! Linux用のDocker Desktopを使用している場合は、
docker context use default
コマンドを実行して、default
Dockerコンテキストを使用する必要があります。[!WARNING]
If you are using Docker Desktop for Linux, you should use thedefault
Docker context by executing the following command:docker context use default
.
サービスの追加Adding Additional Services
既存のSailのインストールにサービスを追加したい場合は、sail:add
Artisanコマンドを実行してください。If you would like to add an additional service to your existing Sail installation, you may run the sail:add
Artisan command:
php artisan sail:add
Devcontainerの使用Using Devcontainers
もし、Devcontainer内で開発したい場合は、--devcontainer
オプションをsail:install
コマンドで指定してください。--devcontainer
オプションは、sail:install
コマンドに、デフォルトの.devcontainer/devcontainer.json
ファイルをアプリケーションのルートにリソース公開するように指示します。If you would like to develop within a Devcontainer[https://code.visualstudio.com/docs/remote/containers], you may provide the --devcontainer
option to the sail:install
command. The --devcontainer
option will instruct the sail:install
command to publish a default .devcontainer/devcontainer.json
file to the root of your application:
php artisan sail:install --devcontainer
Sailイメージの再構築Rebuilding Sail Images
すべてのパッケージやソフトウェアが最新であることを確認するために、sailイメージを完全に作り直したいと思うこともあるでしょう。それには、build
コマンドを使用します。Sometimes you may want to completely rebuild your Sail images to ensure all of the image's packages and software are up to date. You may accomplish this using the build
command:
docker compose down -v
sail build --no-cache
sail up
シェルエイリアスの設定Configuring A Shell Alias
デフォルトでSailコマンドは、すべての新しいLaravelアプリケーションに含まれているvendor/bin/sail
スクリプトを使用して起動します。By default, Sail commands are invoked using the vendor/bin/sail
script that is included with all new Laravel applications:
./vendor/bin/sail up
しかし、Sailコマンドを実行するため、vendor/bin/sail
、と繰り返しタイプする代わりに、Sailのコマンドをより簡単に実行できるようなシェルエイリアスを設定したいと思うでしょう。However, instead of repeatedly typing vendor/bin/sail
to execute Sail commands, you may wish to configure a shell alias that allows you to execute Sail's commands more easily:
alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'
これを常に利用できるようにするには、ホームディレクトリにあるシェルの設定ファイル、例えば ~/.zshrc
や ~/.bashrc
へ追加後、シェルを再起動するとよいでしょう。To make sure this is always available, you may add this to your shell configuration file in your home directory, such as ~/.zshrc
or ~/.bashrc
, and then restart your shell.
シェルエイリアスを設定すると、sail
と入力するだけで、Sailコマンドを実行できます。このドキュメントの残りの例では、このエイリアスを設定済みであることを前提にしています。Once the shell alias has been configured, you may execute Sail commands by simply typing sail
. The remainder of this documentation's examples will assume that you have configured this alias:
sail up
Sailの開始と停止Starting and Stopping Sail
Laravel Sailのdocker-compose.yml
ファイルは、Laravelアプリケーションの構築を支援するために連携するさまざまなDockerコンテナを定義します。これらの各コンテナは、docker-compose.yml
ファイルのservices
設定内のエントリです。laravel.test
コンテナは、アプリケーションを提供するメインのアプリケーションコンテナです。Laravel Sail's docker-compose.yml
file defines a variety of Docker containers that work together to help you build Laravel applications. Each of these containers is an entry within the services
configuration of your docker-compose.yml
file. The laravel.test
container is the primary application container that will be serving your application.
Sailを開始する前に、ローカルコンピューターで他のWebサーバまたはデータベースが実行されていないことを確認する必要があります。アプリケーションのdocker-compose.yml
ファイルで定義されているすべてのDockerコンテナを起動するには、up
コマンドを実行する必要があります。Before starting Sail, you should ensure that no other web servers or databases are running on your local computer. To start all of the Docker containers defined in your application's docker-compose.yml
file, you should execute the up
command:
sail up
すべてのDockerコンテナをバックグラウンドで起動するには、Sailを「デタッチ(detached)」モードで起動します。To start all of the Docker containers in the background, you may start Sail in "detached" mode:
sail up -d
アプリケーションのコンテナが開始されると、Webブラウザ(http:// localhost)でプロジェクトにアクセスできます。Once the application's containers have been started, you may access the project in your web browser at: http://localhost[http://localhost].
すべてのコンテナを停止するには、単にControl+Cキーを押してコンテナの実行を停止してください。あるいは、コンテナをバックグラウンドで実行している場合は、stop
コマンドを使ってください。To stop all of the containers, you may simply press Control + C to stop the container's execution. Or, if the containers are running in the background, you may use the stop
command:
sail stop
コマンドの実行Executing Commands
Laravel Sailを使用する場合、アプリケーションはDockerコンテナ内で実行され、ローカルコンピューターから分離されます。さらにSailは、任意のPHPコマンド、Artisanコマンド、Composerコマンド、Node / NPMコマンドなど、アプリケーションに対してさまざまなコマンドを実行するための便利な方法も提供します。When using Laravel Sail, your application is executing within a Docker container and is isolated from your local computer. However, Sail provides a convenient way to run various commands against your application such as arbitrary PHP commands, Artisan commands, Composer commands, and Node / NPM commands.
**Laravelのドキュメントを読むと、Sailを参照しないComposer、Artisan、Node/NPMコマンドの参照をよく目にするでしょう。**こうした実行例は、これらのツールがローカルコンピューターにインストールされていることを前提としています。ローカルのLaravel開発環境にSailを使用している場合は、Sailを使用してこれらのコマンドを実行する必要があります。When reading the Laravel documentation, you will often see references to Composer, Artisan, and Node / NPM commands that do not reference Sail. Those examples assume that these tools are installed on your local computer. If you are using Sail for your local Laravel development environment, you should execute those commands using Sail:
# Artisanコマンドをローカル環境で実行
php artisan queue:work
# Laravel Sailの中でArtisanコマンドを実行
sail artisan queue:work
PHPコマンドの実行Executing PHP Commands
PHPコマンドは、php
コマンドを使用して実行します。もちろん、これらのコマンドは、アプリケーション用に構成されたPHPバージョンを使用して実行されます。Laravel Sailで利用可能なPHPバージョンの詳細については、PHPバージョンのドキュメントを参照してください。PHP commands may be executed using the php
command. Of course, these commands will execute using the PHP version that is configured for your application. To learn more about the PHP versions available to Laravel Sail, consult the PHP version documentation[#sail-php-versions]:
sail php --version
sail php script.php
Composerコマンドの実行Executing Composer Commands
Composerコマンドはcomposer
コマンドで実行できます。Laravel Sailのアプリケーションコンテナには、Composerのインストールが入っています。Composer commands may be executed using the composer
command. Laravel Sail's application container includes a Composer installation:
sail composer require laravel/sanctum
既存アプリケーションでComposer依存関係のインストールInstalling Composer Dependencies for Existing Applications
チームでアプリケーションを開発している場合、最初にLaravelアプリケーションを作成するのは自分ではないかもしれません。そのため、アプリケーションのリポジトリをローカルコンピュータにクローンした後、Sailを含むアプリケーションのComposer依存関係は一切インストールされていません。If you are developing an application with a team, you may not be the one that initially creates the Laravel application. Therefore, none of the application's Composer dependencies, including Sail, will be installed after you clone the application's repository to your local computer.
アプリケーションの依存関係をインストールするには、アプリケーションのディレクトリに移動し、次のコマンドを実行します。このコマンドは、PHPとComposerを含む小さなDockerコンテナを使用して、アプリケーションの依存関係をインストールします。You may install the application's dependencies by navigating to the application's directory and executing the following command. This command uses a small Docker container containing PHP and Composer to install the application's dependencies:
docker run --rm \
-u "$(id -u):$(id -g)" \
-v "$(pwd):/var/www/html" \
-w /var/www/html \
laravelsail/php82-composer:latest \
composer install --ignore-platform-reqs
laravelsail/phpXX-composer
イメージを使用する場合、アプリケーションで使用する予定のPHPと同じバージョン(80
、81
, または 82
)を使用する必要があります。When using the laravelsail/phpXX-composer
image, you should use the same version of PHP that you plan to use for your application (80
, 81
, 82
, or 83
).
Artisanコマンドの実行Executing Artisan Commands
Laravel Artisanコマンドは、artisan
コマンドを使用して実行します。Laravel Artisan commands may be executed using the artisan
command:
sail artisan queue:work
Node/NPMコマンドの実行Executing Node / NPM Commands
Nodeコマンドはnpm
コマンドを使用して実行し、NPMコマンドはnpm
コマンドを使用して実行します。Node commands may be executed using the node
command while NPM commands may be executed using the npm
command:
sail node --version
sail npm run dev
ご希望であれば、NPMの代わりにYarnを使用できます。If you wish, you may use Yarn instead of NPM:
sail yarn
データベース操作Interacting With Databases
MySQLMySQL
お気づきかもしれませんが、アプリケーションのdocker-compose.yml
ファイルには、MySQLコンテナのエントリが含まれています。このコンテナはDockerボリュームを使用しているため、コンテナを停止して再起動しても、データベースに保存されているデータは保持されます。As you may have noticed, your application's docker-compose.yml
file contains an entry for a MySQL container. This container uses a Docker volume[https://docs.docker.com/storage/volumes/] so that the data stored in your database is persisted even when stopping and restarting your containers.
さらに、MySQLコンテナの初回起動時に、2つのデータベースが作成されます。最初のデータベースは、環境変数DB_DATABASE
の値で命名され、ローカル開発用に使用するものです。もうひとつは、testing
という名前のテスト専用データベースで、テストが開発データに干渉しないようにするためのものです。In addition, the first time the MySQL container starts, it will create two databases for you. The first database is named using the value of your DB_DATABASE
environment variable and is for your local development. The second is a dedicated testing database named testing
and will ensure that your tests do not interfere with your development data.
コンテナを起動したら、アプリケーションの.env
ファイル内のDB_HOST
環境変数をmysql
に設定することで、アプリケーション内のMySQLインスタンスに接続できます。Once you have started your containers, you may connect to the MySQL instance within your application by setting your DB_HOST
environment variable within your application's .env
file to mysql
.
ローカルマシンからアプリケーションのMySQLデータベースに接続するには、TablePlusのようなグラフィカルなデータベース管理アプリケーションを使用する方が多いでしょう。デフォルトでは、MySQLデータベースへはlocalhost
の3306ポートでアクセスでき、アクセス資格情報はDB_USERNAME
とDB_PASSWORD
環境変数の値に対応します。あるいは、DB_PASSWORD
環境変数値をパスワードとして、root
ユーザーとして接続することもできます。To connect to your application's MySQL database from your local machine, you may use a graphical database management application such as TablePlus[https://tableplus.com]. By default, the MySQL database is accessible at localhost
port 3306 and the access credentials correspond to the values of your DB_USERNAME
and DB_PASSWORD
environment variables. Or, you may connect as the root
user, which also utilizes the value of your DB_PASSWORD
environment variable as its password.
RedisRedis
アプリケーションのdocker-compose.yml
ファイルには、Redisコンテナのエントリも含まれています。このコンテナはDockerボリュームを使用しているため、コンテナを停止して再起動しても、Redisデータに保存されているデータは保持されます。コンテナを起動したら、アプリケーションの.env
ファイル内のREDIS_HOST
環境変数をredis
に設定することで、アプリケーション内のRedisインスタンスに接続できます。Your application's docker-compose.yml
file also contains an entry for a Redis[https://redis.io] container. This container uses a Docker volume[https://docs.docker.com/storage/volumes/] so that the data stored in your Redis data is persisted even when stopping and restarting your containers. Once you have started your containers, you may connect to the Redis instance within your application by setting your REDIS_HOST
environment variable within your application's .env
file to redis
.
ローカルマシンからアプリケーションのRedisデータベースに接続するには、TablePlusなどのグラフィカルデータベース管理アプリケーションを使用できます。デフォルトでは、Redisデータベースはlocalhost
のポート6379でアクセスできます。To connect to your application's Redis database from your local machine, you may use a graphical database management application such as TablePlus[https://tableplus.com]. By default, the Redis database is accessible at localhost
port 6379.
MeilisearchMeilisearch
Sailのインストール時にMeilisearchサービスのインストールを選択した場合、アプリケーションのdocker-compose.yml
ファイルにはLaravel Scoutと統合した、この強力な検索エンジンのエントリを用意してあります。コンテナを起動したら、MEILISEARCH_HOST
環境変数をhttp://meilisearch:7700
に設定し、アプリケーション内でMeilisearchインスタンスに接続できます。If you chose to install the Meilisearch[https://www.meilisearch.com] service when installing Sail, your application's docker-compose.yml
file will contain an entry for this powerful search engine that is integrated with Laravel Scout[/docs/{{version}}/scout]. Once you have started your containers, you may connect to the Meilisearch instance within your application by setting your MEILISEARCH_HOST
environment variable to http://meilisearch:7700
.
ローカルマシンから、Webブラウザのhttp://localhost:7700
に移動して、MeilisearchのWebベース管理パネルへアクセスできます。From your local machine, you may access Meilisearch's web based administration panel by navigating to http://localhost:7700
in your web browser.
TypesenseTypesense
Sailインストール時に、Typesenseサービスのインストールを選択した場合、これとネイティブに統合済みで、光のように速いオープンソース検索エンジンであるLaravel Scoutのエントリが含まれます。コンテナを起動したら、以下の環境変数を設定することで、アプリケーション内からTypesenseインスタンスへ接続できます。If you chose to install the Typesense[https://typesense.org] service when installing Sail, your application's docker-compose.yml
file will contain an entry for this lightning fast, open-source search engine that is natively integrated with Laravel Scout[/docs/{{version}}/scout#typesense]. Once you have started your containers, you may connect to the Typesense instance within your application by setting the following environment variables:
TYPESENSE_HOST=typesense
TYPESENSE_PORT=8108
TYPESENSE_PROTOCOL=http
TYPESENSE_API_KEY=xyz
ローカルマシンから、http://localhost:8108
により、TypesenseのAPIへアクセスできます。From your local machine, you may access Typesense's API via http://localhost:8108
.
ファイルストレージFile Storage
本番環境でアプリケーションを実行する際に、Amazon S3を使用してファイルを保存する予定であれば、Sailをインストールする際にMinIOサービスをインストールするとよいでしょう。MinIOはS3互換のAPIを提供しており、本番のS3環境で「テスト」ストレージバケットを作成せずに、Laravelのs3
ファイルストレージドライバを使ってローカルに開発するために使用できます。Sailのインストール時にMinIOのインストールを選択すると、アプリケーションのdocker-compose.yml
ファイルにMinIOの設定セクションが追加されます。If you plan to use Amazon S3 to store files while running your application in its production environment, you may wish to install the MinIO[https://min.io] service when installing Sail. MinIO provides an S3 compatible API that you may use to develop locally using Laravel's s3
file storage driver without creating "test" storage buckets in your production S3 environment. If you choose to install MinIO while installing Sail, a MinIO configuration section will be added to your application's docker-compose.yml
file.
アプリケーションのデフォルトfilesystems
設定ファイルには、s3
ディスクのディスク設定がすでに含まれています。このディスクを使ってAmazon S3と連携するだけでなく、その構成を制御する関連環境変数を変更するだけで、MinIOなどのS3互換のファイルストレージサービスと連携することができます。例えば、MinIOを使用する場合、ファイルシステムの環境変数の設定は次のように定義します。By default, your application's filesystems
configuration file already contains a disk configuration for the s3
disk. In addition to using this disk to interact with Amazon S3, you may use it to interact with any S3 compatible file storage service such as MinIO by simply modifying the associated environment variables that control its configuration. For example, when using MinIO, your filesystem environment variable configuration should be defined as follows:
FILESYSTEM_DISK=s3
AWS_ACCESS_KEY_ID=sail
AWS_SECRET_ACCESS_KEY=password
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=local
AWS_ENDPOINT=http://minio:9000
AWS_USE_PATH_STYLE_ENDPOINT=true
LaravelのFlysystemインテグレーションで、MinIOを使用している場合、適切なURLを生成するには、AWS_URL
環境変数を定義してアプリケーションのローカルURLと一致させ、URLパスにバケット名を含める必要があります:In order for Laravel's Flysystem integration to generate proper URLs when using MinIO, you should define the AWS_URL
environment variable so that it matches your application's local URL and includes the bucket name in the URL path:
AWS_URL=http://localhost:9000/local
http://localhost:8900
のMinIOコンソールからバケットを作成できます。MinIOコンソールのデフォルトユーザー名はsail
、パスワードはpassword
です。You may create buckets via the MinIO console, which is available at http://localhost:8900
. The default username for the MinIO console is sail
while the default password is password
.
Warning! MinIOを使用している場合の、
temporaryUrl
メソッドによる一時保存用URL生成はサポートしていません。[!WARNING]
Generating temporary storage URLs via thetemporaryUrl
method is not supported when using MinIO.
テスト実行Running Tests
Sailのtest
コマンドを使って、アプリケーションの機能テストやユニットテストを実行できます。Pest/PHPUnitのCLIオプションも、test
コマンドへ渡せます。Laravel provides amazing testing support out of the box, and you may use Sail's test
command to run your applications feature and unit tests[/docs/{{version}}/testing]. Any CLI options that are accepted by Pest / PHPUnit may also be passed to the test
command:
sail test
sail test --group orders
Sailのtest
コマンドは、test
Artisanコマンドを実行するのと同じです。The Sail test
command is equivalent to running the test
Artisan command:
sail artisan test
デフォルトでSailは、テストがデータベースの現在の状態に影響を与えないよう、専用のtesting
データベースを作成します。Laravelのデフォルトインストールは、Sailがテストを実行するときにこのデータベースを使用するように、phpunit.xml
ファイルを構成します。By default, Sail will create a dedicated testing
database so that your tests do not interfere with the current state of your database. In a default Laravel installation, Sail will also configure your phpunit.xml
file to use this database when executing your tests:
<env name="DB_DATABASE" value="testing"/>
Laravel DuskLaravel Dusk
Laravel Duskは、表現力豊かで使いやすいブラウザ自動化およびテストのAPIを提供します。Sailのおかげで、Seleniumやその他のツールをローカルコンピューターにインストールしなくても、これらのテストを実行できます。使い始めるには、アプリケーションのdocker-compose.yml
ファイルでSeleniumサービスのコメントを解除します。Laravel Dusk[/docs/{{version}}/dusk] provides an expressive, easy-to-use browser automation and testing API. Thanks to Sail, you may run these tests without ever installing Selenium or other tools on your local computer. To get started, uncomment the Selenium service in your application's docker-compose.yml
file:
selenium:
image: 'selenium/standalone-chrome'
extra_hosts:
- 'host.docker.internal:host-gateway'
volumes:
- '/dev/shm:/dev/shm'
networks:
- sail
次に、アプリケーションのdocker-compose.yml
ファイルのlaravel.test
サービスにselenium
のdepends_on
エントリがあることを確認します。Next, ensure that the laravel.test
service in your application's docker-compose.yml
file has a depends_on
entry for selenium
:
depends_on:
- mysql
- redis
- selenium
最後に、Sailを起動してdusk
コマンドを実行することにより、Duskテストスイートを実行できます。Finally, you may run your Dusk test suite by starting Sail and running the dusk
command:
sail dusk
Apple Silicon上のSeleniumSelenium on Apple Silicon
ローカルマシンに Apple Silicon チップが搭載されている場合、selenium
サービスにはselenium/standalone-chromium
イメージを使用する必要があります。If your local machine contains an Apple Silicon chip, your selenium
service must use the selenium/standalone-chromium
image:
selenium:
image: 'selenium/standalone-chromium'
extra_hosts:
- 'host.docker.internal:host-gateway'
volumes:
- '/dev/shm:/dev/shm'
networks:
- sail
メールのプレビューPreviewing Emails
Laravel Sailのデフォルトのdocker-compose.yml
ファイルは、Mailpitのサービスエントリを含んでいます。Mailpitは、ローカル開発中にアプリケーションが送信したメールを傍受し、ブラウザでメールメッセージをプレビューできるように、便利なWebインタフェースを提供します。Sailを使用している場合、Mailpitのデフォルトのホストは、mailpit
で、ポート1025経由で利用可能です。Laravel Sail's default docker-compose.yml
file contains a service entry for Mailpit[https://github.com/axllent/mailpit]. Mailpit intercepts emails sent by your application during local development and provides a convenient web interface so that you can preview your email messages in your browser. When using Sail, Mailpit's default host is mailpit
and is available via port 1025:
MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_ENCRYPTION=null
Sailが起動している場合、http://localhost:8025で、MailpitのWebインターフェイスにアクセスできます:When Sail is running, you may access the Mailpit web interface at: http://localhost:8025[http://localhost:8025]
コンテナCLIContainer CLI
アプリケーションのコンテナ内でBashセッションを開始したい場合があるでしょう。shell
コマンドを使用してアプリケーションのコンテナに接続し、ファイルとインストールされているサービスを検査したり、コンテナ内で任意のシェルコマンドを実行したりできます。Sometimes you may wish to start a Bash session within your application's container. You may use the shell
command to connect to your application's container, allowing you to inspect its files and installed services as well as execute arbitrary shell commands within the container:
sail shell
sail root-shell
新しいLaravelTinkerセッションを開始するには、tinker
コマンドを実行します。To start a new Laravel Tinker[https://github.com/laravel/tinker] session, you may execute the tinker
command:
sail tinker
PHPバージョンPHP Versions
Sailは現在、PHP8.3、PHP8.2、PHP8.1、PHP8.0を利用したアプリケーションの実行をサポートしています。SailのデフォルトPHPバージョンは8.3です。アプリケーションの実行に使用するPHPバージョンを変更するには、アプリケーションのdocker-compose.yml
ファイル内のlaravel.test
コンテナのbuild
定義を更新してください。Sail currently supports serving your application via PHP 8.3, 8.2, 8.1, or PHP 8.0. The default PHP version used by Sail is currently PHP 8.3. To change the PHP version that is used to serve your application, you should update the build
definition of the laravel.test
container in your application's docker-compose.yml
file:
# PHP 8.3
context: ./vendor/laravel/sail/runtimes/8.3
# PHP 8.2
context: ./vendor/laravel/sail/runtimes/8.2
# PHP 8.1
context: ./vendor/laravel/sail/runtimes/8.1
# PHP8.0
context: ./vendor/laravel/sail/runtimes/8.0
さらに、アプリケーションで使用するPHPのバージョンを反映するために、image
名を更新することもできます。このオプションも、アプリケーションのdocker-compose.yml
ファイルで定義されています。In addition, you may wish to update your image
name to reflect the version of PHP being used by your application. This option is also defined in your application's docker-compose.yml
file:
image: sail-8.2/app
アプリケーションのdocker-compose.yml
ファイルを更新した後、コンテナイメージを再構築する必要があります。After updating your application's docker-compose.yml
file, you should rebuild your container images:
sail build --no-cache
sail up
NodeバージョンNode Versions
SailはデフォルトでNode20をインストールします。イメージをビルドする際にインストールするNodeバージョンを変更するには、アプリケーションのdocker-compose.yml
ファイル中の、laravel.test
サービスのbuild.args
定義を変更してください。Sail installs Node 20 by default. To change the Node version that is installed when building your images, you may update the build.args
definition of the laravel.test
service in your application's docker-compose.yml
file:
build:
args:
WWWGROUP: '${WWWGROUP}'
NODE_VERSION: '18'
アプリケーションのdocker-compose.yml
ファイルを更新した後、コンテナイメージを再構築する必要があります。After updating your application's docker-compose.yml
file, you should rebuild your container images:
sail build --no-cache
sail up
サイトの共有Sharing Your Site
同僚のためにサイトをプレビューしたり、アプリケーションとのWebhook統合をテストしたりするために、サイトを公開して共有する必要がある場合があります。サイトを共有するには、 share
コマンドを使用します。このコマンドを実行すると、アプリケーションへのアクセスに使用するランダムなlaravel-sail.site
URLが発行されます。Sometimes you may need to share your site publicly in order to preview your site for a colleague or to test webhook integrations with your application. To share your site, you may use the share
command. After executing this command, you will be issued a random laravel-sail.site
URL that you may use to access your application:
sail share
share
コマンドを使用してサイトを共有する場合は、アプリケーションのbootstrap/app.php
ファイルにあるtrustProxies
ミドルウェアメソッドを使用して、アプリケーションが信頼するプロキシを設定する必要があります。そうしないと、url
やroute
などのURL生成ヘルパが、URL生成時に使用する正しいHTTPホストを判断できなくなります。When sharing your site via the share
command, you should configure your application's trusted proxies using the trustProxies
middleware method in your application's bootstrap/app.php
file. Otherwise, URL generation helpers such as url
and route
will be unable to determine the correct HTTP host that should be used during URL generation:
->withMiddleware(function (Middleware $middleware) {
$middleware->trustProxies(at: '*');
})
共有サイトでサブドメインを選択する場合は、share
コマンドを実行するときにsubdomain
オプションを指定します。If you would like to choose the subdomain for your shared site, you may provide the subdomain
option when executing the share
command:
sail share --subdomain=my-sail-site
Note:
share
コマンドは、BeyondCodeによるオープンソースのトンネリングサービスであるExposeにより提供しています。[!NOTE]
Theshare
command is powered by Expose[https://github.com/beyondcode/expose], an open source tunneling service by BeyondCode[https://beyondco.de].
XdebugによるデバッグDebugging With Xdebug
LaravelSailのDockerの設定には、PHP用の人気で強力なデバッガであるXdebugをサポートしています。XDebugを有効にするには、Xdebugを設定するために、アプリケーションの.env
ファイルに変数を追加する必要があります。XDebugを有効にするには、Sailを開始する前に適切なモードを設定する必要があります。Laravel Sail's Docker configuration includes support for Xdebug[https://xdebug.org/], a popular and powerful debugger for PHP. In order to enable Xdebug, you will need to add a few variables to your application's .env
file to configure Xdebug[https://xdebug.org/docs/step_debug#mode]. To enable Xdebug you must set the appropriate mode(s) before starting Sail:
SAIL_XDEBUG_MODE=develop,debug,coverage
LinuxホストIP設定Linux Host IP Configuration
内部的には、XDEBUG_CONFIG
環境変数をclient_host=host.docker.internal
として定義しているため、XdebugはMacとWindows(WSL2)で適切に設定されます。ローカルマシンがLinuxで、Docker20.10以降を使っている場合は、host.docker.internal
が利用できるので、手作業での設定は不要です。Internally, the XDEBUG_CONFIG
environment variable is defined as client_host=host.docker.internal
so that Xdebug will be properly configured for Mac and Windows (WSL2). If your local machine is running Linux and you're using Docker 20.10+, host.docker.internal
is available, and no manual configuration is required.
20.10より古いバージョンのDockerでは、Linux上のhost.docker.internal
はサポートされていないため、手作業でホストIPを定義する必要があります。これを行うには、docker-compose.yml
ファイルでカスタムネットワークを定義して、コンテナに静的IPを設定します。For Docker versions older than 20.10, host.docker.internal
is not supported on Linux, and you will need to manually define the host IP. To do this, configure a static IP for your container by defining a custom network in your docker-compose.yml
file:
networks:
custom_network:
ipam:
config:
- subnet: 172.20.0.0/16
services:
laravel.test:
networks:
custom_network:
ipv4_address: 172.20.0.2
静的IPを設定したら、アプリケーションの.envファイルでSAIL_XDEBUG_CONFIG変数を定義します。Once you have set the static IP, define the SAIL_XDEBUG_CONFIG variable within your application's .env file:
SAIL_XDEBUG_CONFIG="client_host=172.20.0.2"
Xdebug CLI使用法Xdebug CLI Usage
Artisanのコマンドを実行する際に、sail debug
コマンドを使ってデバッグセッションを開始することができます。A sail debug
command may be used to start a debugging session when running an Artisan command:
# Xdebugなしでartisanコマンドを実行
sail artisan migrate
# Xdebugでartisanコマンドを実行
sail debug migrate
Xdebug ブラウザ使用法Xdebug Browser Usage
Webブラウザでアプリケーションを操作しながらデバッグするには、WebブラウザからXdebugセッションを開始するためのXdebugが提供する手順に従ってください。To debug your application while interacting with the application via a web browser, follow the instructions provided by Xdebug[https://xdebug.org/docs/step_debug#web-application] for initiating an Xdebug session from the web browser.
PhpStormを使用している場合は、設定なしのデバッグに関するJetBrainのドキュメントを確認してください。If you're using PhpStorm, please review JetBrains' documentation regarding zero-configuration debugging[https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging.html].
Warning! Laravel Sailはアプリケーション提供を
artisan serve
に依存しています。artisan serve
コマンドは、Laravelバージョン8.53.0以降では、XDEBUG_CONFIG
とXDEBUG_MODE
変数のみを受け付けます。古いバージョンのLaravel(8.52.0以下)では、これらの変数をサポートしていないため、デバッグ接続を受け付けません。[!WARNING]
Laravel Sail relies onartisan serve
to serve your application. Theartisan serve
command only accepts theXDEBUG_CONFIG
andXDEBUG_MODE
variables as of Laravel version 8.53.0. Older versions of Laravel (8.52.0 and below) do not support these variables and will not accept debug connections.
SailカスタマイズCustomization
Sailは単なるDockerであるため、Sailに関するほぼすべてを自由にカスタマイズできます。Sail独自のDockerfileをリソース公開するには、sail:publish
コマンドを実行します。Since Sail is just Docker, you are free to customize nearly everything about it. To publish Sail's own Dockerfiles, you may execute the sail:publish
command:
sail artisan sail:publish
このコマンドを実行すると、Laravel Sailが使用するDockerfileとその他の設定ファイルが、アプリケーションのルートディレクトリ内のdocker
ディレクトリに配置されます。Sailのインストールをカスタマイズした後、アプリケーションの docker-compose.yml
ファイル内のアプリケーションコンテナのイメージ名を変更したいと思うことでしょう。それを行ったら、build
コマンドを使用してアプリケーションのコンテナを再構築してください。アプリケーション・イメージに一意な名前を割り当てることは、Sailを使用して1台のマシンで複数のLaravelアプリケーションを開発する場合に特に重要です。After running this command, the Dockerfiles and other configuration files used by Laravel Sail will be placed within a docker
directory in your application's root directory. After customizing your Sail installation, you may wish to change the image name for the application container in your application's docker-compose.yml
file. After doing so, rebuild your application's containers using the build
command. Assigning a unique name to the application image is particularly important if you are using Sail to develop multiple Laravel applications on a single machine:
sail build --no-cache