We at amazee.io and Workshop Orange have built Sail:onLagoon because our team loves Laravel.

• Given that the amazee.io hosting platform began primarily hosting PHP-centric projects, Laravel hosting was one of the first project types we explicitly addressed early on.

• Practically every current and ex-PHP developer on our team has a story about the first time they experimented with or used Laravel and the accompanying experience of everything just working.

• We’ve had design meetings in which we’ve looked at documentation and branding in the Laravel ecosystem and invested time and effort into ensuring Laravel developers feel at home in our Platform — the same way they feel at home in the Laravel ecosystem itself.

• The speed at which you can move when writing Laravel has allowed us to build proof-of-concept implementations of several Lagoon subsystems.

• We suggest that junior developers read the Illuminate collections code as an example of what a beautifully designed API looks like.

• And, importantly, amazee.io has hosted and supported thousands of enterprise Laravel workloads for many years.

So we have a lot of personal, professional, and commercial investment in Laravel despite not actually being a Laravel dev team.

To use the package, the assumption is that you've already set up your Laravel development environment locally using Sail.

Once you have your Laravel site running locally, you can install Sail on Lagoon via composer:

composer require --dev uselagoon/sailonlagoon

Note that we install Sail:onLagoon as a dev dependency (with the --dev flag) as it simply creates and publishes configuration files, therefore, the package itself isn't required at run time.

To use Sail:onLagoon, run the following Artisan command:

php artisan sail:onlagoon [--projectName=my-lagoon-project] [--no-interaction]

This will read your sail-generated docker-compose.yml file and attempt to generate the required files for a Lagoon installation. You can, optionally, specify the name of your project and skip the interactive question. Specifying --no-interaction will skip any interaction (including warnings) and ready the project for running on the amazee.io platform.