Laravel Sail

• 简介
• 安装和设置
  • 将 Sail 安装到现有应用程序中
  • 重建 Sail 镜像
  • 配置 Shell 别名
• 启动和停止 Sail
• 执行命令
  • 执行 PHP 命令
  • 执行 Composer 命令
  • 执行 Artisan 命令
  • 执行 Node / NPM 命令
• 与数据库交互
  • MySQL
  • MongoDB
  • Redis
  • Meilisearch
  • Typesense
• 文件存储
• 运行测试
  • Laravel Dusk
• 预览电子邮件
• 容器 CLI
• PHP 版本
• Node 版本
• 共享您的站点
• 使用 Xdebug 进行调试
  • Xdebug CLI 用法
  • Xdebug 浏览器用法
• 自定义

简介

Laravel Sail 是一个轻量级的命令行界面，用于与 Laravel 的默认 Docker 开发环境进行交互。Sail 为使用 PHP、MySQL 和 Redis 构建 Laravel 应用程序提供了一个很好的起点，而无需事先的 Docker 经验。

它的核心是 docker-compose.yml 文件和存储在项目根目录的 sail 脚本。sail 脚本提供了一个 CLI，其中包含方便的方法，用于与 docker-compose.yml 文件定义的 Docker 容器进行交互。

macOS、Linux 和 Windows（通过 WSL2）都支持 Laravel Sail。

安装和设置

Laravel Sail 会自动安装在所有新的 Laravel 应用程序中，因此您可以立即开始使用它。要了解如何创建新的 Laravel 应用程序，请参阅 Laravel 针对您的操作系统的安装文档。在安装过程中，系统会要求您选择您的应用程序将与之交互的 Sail 支持的服务。

将 Sail 安装到现有应用程序中

如果您有兴趣将 Sail 与现有 Laravel 应用程序一起使用，您只需使用 Composer 包管理器安装 Sail 即可。当然，这些步骤假设您现有的本地开发环境允许您安装 Composer 依赖项

composer require laravel/sail --dev

安装 Sail 后，您可以运行 sail:install Artisan 命令。此命令会将 Sail 的 docker-compose.yml 文件发布到您的应用程序根目录，并使用连接到 Docker 服务所需的 环境变量修改您的 .env 文件

php artisan sail:install

最后，您可以启动 Sail。要继续学习如何使用 Sail，请继续阅读本文档的其余部分

./vendor/bin/sail up

添加其他服务

如果您想向现有的 Sail 安装添加其他服务，可以运行 sail:add Artisan 命令

php artisan sail:add

使用 Devcontainers

如果您想在 Devcontainer 中进行开发，您可以为 sail:install 命令提供 --devcontainer 选项。--devcontainer 选项会指示 sail:install 命令将默认的 .devcontainer/devcontainer.json 文件发布到您的应用程序根目录

php artisan sail:install --devcontainer

重建 Sail 镜像

有时您可能希望完全重建 Sail 镜像，以确保所有镜像的包和软件都是最新的。您可以使用 build 命令来完成此操作

docker compose down -v
 
sail build --no-cache
 
sail up

配置 Shell 别名

默认情况下，Sail 命令是使用所有新 Laravel 应用程序中包含的 vendor/bin/sail 脚本调用的

./vendor/bin/sail up

但是，您可以配置一个 shell 别名，以便更轻松地执行 Sail 的命令，而无需重复键入 vendor/bin/sail 来执行 Sail 命令

alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'

要确保它始终可用，您可以将其添加到主目录中的 shell 配置文件中，例如 ~/.zshrc 或 ~/.bashrc，然后重新启动您的 shell。

配置 shell 别名后，您只需键入 sail 即可执行 Sail 命令。本文档其余部分的示例将假设您已配置此别名

sail up

启动和停止 Sail

Laravel Sail 的 docker-compose.yml 文件定义了各种 Docker 容器，这些容器协同工作以帮助您构建 Laravel 应用程序。这些容器中的每一个都是您的 docker-compose.yml 文件中的 services 配置中的一个条目。laravel.test 容器是主要应用程序容器，它将为您的应用程序提供服务。

在启动 Sail 之前，您应确保本地计算机上没有其他 Web 服务器或数据库正在运行。要启动应用程序的 docker-compose.yml 文件中定义的所有 Docker 容器，您应执行 up 命令

sail up

要在后台启动所有 Docker 容器，您可以以“分离”模式启动 Sail

sail up -d

应用程序的容器启动后，您可以在 Web 浏览器中通过以下地址访问项目：http://localhost。

要停止所有容器，您可以只需按 Control + C 即可停止容器的执行。或者，如果容器在后台运行，您可以使用 stop 命令

sail stop

执行命令

使用 Laravel Sail 时，您的应用程序在 Docker 容器中执行，并与您的本地计算机隔离。但是，Sail 提供了一种方便的方式来针对您的应用程序运行各种命令，例如任意 PHP 命令、Artisan 命令、Composer 命令和 Node / NPM 命令。

在阅读 Laravel 文档时，您经常会看到对 Composer、Artisan 和 Node / NPM 命令的引用，但没有引用 Sail。这些示例假设这些工具已安装在您的本地计算机上。如果您使用 Sail 作为本地 Laravel 开发环境，则应使用 Sail 执行这些命令

# Running Artisan commands locally...
php artisan queue:work
 
# Running Artisan commands within Laravel Sail...
sail artisan queue:work

执行 PHP 命令

可以使用 php 命令执行 PHP 命令。当然，这些命令将使用为您的应用程序配置的 PHP 版本执行。要了解有关 Laravel Sail 可用的 PHP 版本的更多信息，请参阅PHP 版本文档

sail php --version
 
sail php script.php

执行 Composer 命令

可以使用 composer 命令执行 Composer 命令。Laravel Sail 的应用程序容器包含 Composer 安装

sail composer require laravel/sanctum

为现有应用程序安装 Composer 依赖项

如果您正在与团队一起开发应用程序，那么您可能不是最初创建 Laravel 应用程序的人。因此，在您将应用程序的存储库克隆到本地计算机后，不会安装应用程序的任何 Composer 依赖项，包括 Sail。

您可以通过导航到应用程序的目录并执行以下命令来安装应用程序的依赖项。此命令使用一个包含 PHP 和 Composer 的小型 Docker 容器来安装应用程序的依赖项。

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php84-composer:latest \
    composer install --ignore-platform-reqs

当使用 laravelsail/phpXX-composer 镜像时，您应该使用与您计划用于应用程序的 PHP 版本相同的版本（80、81、82、83 或 84）。

执行 Artisan 命令

可以使用 artisan 命令执行 Laravel Artisan 命令。

sail artisan queue:work

执行 Node / NPM 命令

可以使用 node 命令执行 Node 命令，而可以使用 npm 命令执行 NPM 命令。

sail node --version
 
sail npm run dev

如果您愿意，可以使用 Yarn 代替 NPM。

sail yarn

与数据库交互

MySQL

您可能已经注意到，您的应用程序的 docker-compose.yml 文件包含一个 MySQL 容器的条目。此容器使用 Docker 卷，以便即使停止和重新启动容器，存储在数据库中的数据也能持久保存。

此外，当 MySQL 容器首次启动时，它将为您创建两个数据库。第一个数据库使用您的 DB_DATABASE 环境变量的值命名，用于您的本地开发。第二个是名为 testing 的专用测试数据库，它将确保您的测试不会干扰您的开发数据。

启动容器后，您可以通过将应用程序的 .env 文件中的 DB_HOST 环境变量设置为 mysql 来连接到应用程序中的 MySQL 实例。

要从您的本地机器连接到您的应用程序的 MySQL 数据库，您可以使用图形数据库管理应用程序，例如 TablePlus。默认情况下，MySQL 数据库可以通过 localhost 端口 3306 访问，并且访问凭据对应于您的 DB_USERNAME 和 DB_PASSWORD 环境变量的值。或者，您可以作为 root 用户连接，该用户也使用您的 DB_PASSWORD 环境变量的值作为其密码。

MongoDB

如果您在安装 Sail 时选择安装 MongoDB 服务，您的应用程序的 docker-compose.yml 文件将包含一个 MongoDB Atlas Local 容器的条目，该容器提供具有 Atlas 功能（如 搜索索引）的 MongoDB 文档数据库。此容器使用 Docker 卷，以便即使停止和重新启动容器，存储在数据库中的数据也能持久保存。

启动容器后，您可以通过将应用程序的 .env 文件中的 MONGODB_URI 环境变量设置为 mongodb://mongodb:27017 来连接到应用程序中的 MongoDB 实例。默认情况下禁用身份验证，但您可以设置 MONGODB_USERNAME 和 MONGODB_PASSWORD 环境变量以在启动 mongodb 容器之前启用身份验证。然后，将凭据添加到连接字符串。

MONGODB_USERNAME=user
MONGODB_PASSWORD=laravel
MONGODB_URI=mongodb://${MONGODB_USERNAME}:${MONGODB_PASSWORD}@mongodb:27017

为了将 MongoDB 与您的应用程序无缝集成，您可以安装 MongoDB 维护的官方软件包。

要从您的本地机器连接到您的应用程序的 MongoDB 数据库，您可以使用图形界面，例如 Compass。默认情况下，MongoDB 数据库可以通过 localhost 端口 27017 访问。

Redis

您的应用程序的 docker-compose.yml 文件还包含一个 Redis 容器的条目。此容器使用 Docker 卷，以便即使停止和重新启动容器，存储在 Redis 数据中的数据也能持久保存。启动容器后，您可以通过将应用程序的 .env 文件中的 REDIS_HOST 环境变量设置为 redis 来连接到应用程序中的 Redis 实例。

要从您的本地机器连接到您的应用程序的 Redis 数据库，您可以使用图形数据库管理应用程序，例如 TablePlus。默认情况下，Redis 数据库可以通过 localhost 端口 6379 访问。

Meilisearch

如果您在安装 Sail 时选择安装 Meilisearch 服务，您的应用程序的 docker-compose.yml 文件将包含这个强大的搜索引擎的条目，该搜索引擎已与 Laravel Scout 集成。启动容器后，您可以通过将您的 MEILISEARCH_HOST 环境变量设置为 http://meilisearch:7700 来连接到应用程序中的 Meilisearch 实例。

从您的本地机器，您可以通过在 Web 浏览器中导航到 http://localhost:7700 来访问 Meilisearch 基于 Web 的管理面板。

Typesense

如果您在安装 Sail 时选择安装 Typesense 服务，您的应用程序的 docker-compose.yml 文件将包含这个闪电般快速的开源搜索引擎的条目，该搜索引擎与 Laravel Scout 原生集成。启动容器后，您可以通过设置以下环境变量来连接到应用程序中的 Typesense 实例。

TYPESENSE_HOST=typesense
TYPESENSE_PORT=8108
TYPESENSE_PROTOCOL=http
TYPESENSE_API_KEY=xyz

从您的本地机器，您可以通过 http://localhost:8108 访问 Typesense 的 API。

文件存储

如果您计划在生产环境中运行应用程序时使用 Amazon S3 存储文件，您可能希望在安装 Sail 时安装 MinIO 服务。MinIO 提供一个与 S3 兼容的 API，您可以使用它在本地使用 Laravel 的 s3 文件存储驱动程序进行开发，而无需在生产 S3 环境中创建“测试”存储桶。如果在安装 Sail 时选择安装 MinIO，则 MinIO 配置部分将添加到应用程序的 docker-compose.yml 文件中。

默认情况下，您的应用程序的 filesystems 配置文件已经包含一个用于 s3 磁盘的磁盘配置。除了使用此磁盘与 Amazon S3 交互之外，您还可以通过简单地修改控制其配置的相关环境变量，使用它与任何与 S3 兼容的文件存储服务（如 MinIO）进行交互。例如，当使用 MinIO 时，您的文件系统环境变量配置应定义如下：

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 路径中包含存储桶名称。

AWS_URL=http://localhost:9000/local

您可以通过 MinIO 控制台创建存储桶，该控制台可在 http://localhost:8900 访问。MinIO 控制台的默认用户名是 sail，而默认密码是 password。

运行测试

Laravel 提供了开箱即用的出色测试支持，您可以使用 Sail 的 test 命令来运行应用程序的 功能和单元测试。Pest / PHPUnit 接受的任何 CLI 选项也可以传递给 test 命令。

sail test
 
sail test --group orders

Sail 的 test 命令等效于运行 test Artisan 命令。

sail artisan test

默认情况下，Sail 将创建一个专用的 testing 数据库，以便您的测试不会干扰您数据库的当前状态。在默认的 Laravel 安装中，Sail 还会配置您的 phpunit.xml 文件，以便在执行测试时使用此数据库。

<env name="DB_DATABASE" value="testing"/>

Laravel Dusk

Laravel Dusk 提供了一个富有表现力、易于使用的浏览器自动化和测试 API。借助 Sail，您可以在本地计算机上运行这些测试，而无需安装 Selenium 或其他工具。要开始使用，请取消注释应用程序的 docker-compose.yml 文件中的 Selenium 服务。

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 条目。

depends_on:
    - mysql
    - redis
    - selenium

最后，您可以通过启动 Sail 并运行 dusk 命令来运行 Dusk 测试套件。

sail dusk

Apple Silicon 上的 Selenium

如果您的本地计算机包含 Apple Silicon 芯片，您的 selenium 服务必须使用 selenium/standalone-chromium 镜像。

selenium:
    image: 'selenium/standalone-chromium'
    extra_hosts:
        - 'host.docker.internal:host-gateway'
    volumes:
        - '/dev/shm:/dev/shm'
    networks:
        - sail

预览电子邮件

Laravel Sail 的默认 docker-compose.yml 文件包含一个 Mailpit 的服务条目。Mailpit 会拦截您的应用程序在本地开发期间发送的电子邮件，并提供一个方便的 Web 界面，以便您可以在浏览器中预览您的电子邮件消息。当使用 Sail 时，Mailpit 的默认主机是 mailpit，并且可以通过端口 1025 访问。

MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_ENCRYPTION=null

当 Sail 运行时，您可以在以下位置访问 Mailpit Web 界面：http://localhost:8025

容器 CLI

有时，您可能希望在应用程序的容器中启动 Bash 会话。您可以使用 shell 命令连接到应用程序的容器，允许您检查其文件和已安装的服务，以及在容器内执行任意 shell 命令。

sail shell
 
sail root-shell

要启动新的 Laravel Tinker 会话，您可以执行 tinker 命令。

sail tinker

PHP 版本

Sail 当前支持通过 PHP 8.4、8.3、8.2、8.1 或 PHP 8.0 服务您的应用程序。Sail 使用的默认 PHP 版本当前为 PHP 8.4。要更改用于服务您的应用程序的 PHP 版本，您应该更新应用程序的 docker-compose.yml 文件中 laravel.test 容器的 build 定义。

# PHP 8.4
context: ./vendor/laravel/sail/runtimes/8.4
 
# 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
 
# PHP 8.0
context: ./vendor/laravel/sail/runtimes/8.0

此外，您可能希望更新您的 image 名称以反映您的应用程序使用的 PHP 版本。此选项也在您的应用程序的 docker-compose.yml 文件中定义。

image: sail-8.2/app

更新应用程序的 docker-compose.yml 文件后，您应该重建您的容器镜像。

sail build --no-cache
 
sail up

Node 版本

Sail 默认安装 Node 20。要更改构建镜像时安装的 Node 版本，您可以更新应用程序的 docker-compose.yml 文件中 laravel.test 服务的 build.args 定义。

build:
    args:
        WWWGROUP: '${WWWGROUP}'
        NODE_VERSION: '18'

更新应用程序的 docker-compose.yml 文件后，您应该重建您的容器镜像。

sail build --no-cache
 
sail up

共享您的站点

有时，您可能需要公开共享您的站点，以便为同事预览您的站点或测试与应用程序的 Webhook 集成。要共享您的站点，您可以使用 share 命令。执行此命令后，您将获得一个随机的 laravel-sail.site URL，您可以使用该 URL 来访问您的应用程序。

sail share

当通过 share 命令共享您的站点时，您应该使用应用程序的 bootstrap/app.php 文件中的 trustProxies 中间件方法配置您应用程序的受信任代理。否则，URL 生成助手（如 url 和 route）将无法确定在 URL 生成期间应使用的正确 HTTP 主机。

->withMiddleware(function (Middleware $middleware) {
    $middleware->trustProxies(at: '*');
})

如果您想为共享站点选择子域名，您可以在执行 share 命令时提供 subdomain 选项。

sail share --subdomain=my-sail-site

使用 Xdebug 进行调试

Laravel Sail 的 Docker 配置包括对 Xdebug 的支持，Xdebug 是一个流行的且功能强大的 PHP 调试器。为了启用 Xdebug，您需要在应用程序的 .env 文件中添加一些变量，以便 配置 Xdebug。要启用 Xdebug，您必须在启动 Sail 之前设置适当的模式。

SAIL_XDEBUG_MODE=develop,debug,coverage

Linux 主机 IP 配置

在内部，XDEBUG_CONFIG 环境变量定义为 client_host=host.docker.internal，以便为 Mac 和 Windows (WSL2) 正确配置 Xdebug。如果您的本地机器运行的是 Linux 并且您使用的是 Docker 20.10+，则 host.docker.internal 可用，并且不需要手动配置。

对于低于 20.10 版本的 Docker，Linux 系统不支持 host.docker.internal，您需要手动定义主机 IP。为此，请在您的 docker-compose.yml 文件中定义自定义网络，为您的容器配置静态 IP。

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 变量。

SAIL_XDEBUG_CONFIG="client_host=172.20.0.2"

Xdebug CLI 用法

当运行 Artisan 命令时，可以使用 sail debug 命令启动调试会话。

# Run an Artisan command without Xdebug...
sail artisan migrate
 
# Run an Artisan command with Xdebug...
sail debug migrate

Xdebug 浏览器用法

要在通过 Web 浏览器与应用程序交互时调试应用程序，请按照 Xdebug 提供的 说明，从 Web 浏览器启动 Xdebug 会话。

如果您使用的是 PhpStorm，请查看 JetBrains 关于 零配置调试 的文档。

自定义

由于 Sail 只是 Docker，您可以自由地自定义几乎所有内容。要发布 Sail 自己的 Dockerfile，您可以执行 sail:publish 命令。

sail artisan sail:publish

运行此命令后，Laravel Sail 使用的 Dockerfile 和其他配置文件将放置在您的应用程序根目录下的 docker 目录中。自定义 Sail 安装后，您可能希望在应用程序的 docker-compose.yml 文件中更改应用程序容器的镜像名称。完成此操作后，请使用 build 命令重建应用程序的容器。如果您在单台机器上使用 Sail 开发多个 Laravel 应用程序，则为应用程序镜像分配唯一的名称尤其重要。

sail build --no-cache