Introduction

Sail provides a Docker powered local development experience for Laravel that is compatible with macOS, Windows (WSL2), and Linux. Other than Docker, no software or libraries are required to be installed on your local computer before using Sail. Sail's simple CLI means you can start building your Laravel application without any previous Docker experience.

Note

This fork has been modified to include some extra ease-of-life features like an Nginx proxy for custom domains, Imagick support etc.

Official Documentation

Documentation for Sail can be found on the Laravel website.

Unofficial Documentation

Compatibility

The release of packages is handled by repo.laser.red, therefore the versions are managed independently of the official Laravel Sail package. The following table shows the compatibility of the versions:

Version	L6	L7	L8	L9	L10	L11
1.1.0	✅	✅	✅	✅	✅	❌
2.0.0	❌	❌	❌	✅	✅	✅

Installation

Before installing, you need to configure composer to use our remote repository:

composer config repositories.repolaserred composer https://repo.laser.red

Now you can install Sail as normal by running:

composer require laravel/sail --dev

When configuring a new site and running php artisan sail:install, set the --host option to the domain you'd like to use (without the protocol), otherwise it will default to laravel.test. Don't forget to also add your chosen domain (or the default) to your hosts file and point it to 127.0.0.1. For example:

php artisan sail:install --with=mysql,redis,mailpit --host=my-site.local

Aero Configuration

Ensure you have the correct version of the Aero CLI tool installed globally:

composer global require aerocommerce/cli

In order to create a new Aero project you will need first to register it with Aero Commerce Agora. Go the projects and create a new project, giving it a name and a domain. Once this has been completed you should be provided with a username and password.

Now you can install Aero:

aero new --no-install --next

The --next flag is currently required to get the latest Laravel base.

Tip

If this responds with command not found it likely means you don't have your global composer path in exported in your $PATH. You can find this path with composer config --list --global | grep home and then prepend that path so you have something like ~/.composer/vendor/bin/aero new --no-install --next

Now you can install Sail as normal by running:

composer config repositories.repolaserred composer https://repo.laser.red

composer require laravel/sail --dev

Note

This may show an error message about tables not being found, ignore this as we just haven't installed aero yet.

When setting up Sail, ensure you add the --aero flag so it adds the correct services:

php artisan sail:install --aero --host=my-site.local

Depending on your base Laravel version, check that the docker-compose.yml is provisioned with the correct php version for the application by altering the lines:

context: ./vendor/laravel/sail/runtimes/8.2
...
image: sail-8.2/app

Update your .env to include:

DB_HOST=mysql
REDIS_HOST=redis
ELASTICSEARCH_HOST=elasticsearch
CACHE_DRIVER=redis
SESSION_DRIVER=redis

If the variable APP_SERVICE hasn't been added, add that manually with the value of line 4 in your docker-compose.yml e.g.

APP_SERVICE=aero-test.local

Important

From this point onwards you must run all composer commands inside the container, e.g. sail composer install.

Now you have all the defaults configured, you can start Sail:

sail up -d

Start the Aero install from inside the container:

sail artisan aero:install

When prompted, enter the username and password from the project you set up earlier in Agora, this will install a fresh instance of aero.

In order to create a theme for our project, we will need to install some prerequisites:

sail composer require aerocommerce/theme-ui aerocargo/listing-collections aerocommerce/account-area aerocommerce/components

Now install the skeleton theme and answer yes when prompted to activate:

sail artisan theme:install aero/skeleton --name=skeleton

If you would like to import some test products into your application for testing purposes you can run the following command.

sail artisan aero:import:products:csv https://aero-data.s3.eu-west-2.amazonaws.com/furniture.csv