uselagoon / sailonlagoon
Sail on Lagoon
Fund package maintenance!
uselagoon
Requires
- php: ^8.1
- illuminate/contracts: ^10.0||^11.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.8
- orchestra/testbench: ^8.8
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.5
- pestphp/pest-plugin-laravel: ^2.0
This package is auto-updated.
Last update: 2024-10-27 03:10:57 UTC
README
Sail:onLagoon is a Laravel extension that simplifies the process of Lagoonizing Laravel sites that are already using Laravel Sail to generate their docker-compose setup. This extension provides additional features and configurations tailored for Lagoon environments.
Installation
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 Lagoonize the project.
Requirements
There are very few requirements that aren't requirements for Sail directly, but they are:
- PHP >= 8.1
- Laravel >= 10
Supported Services
Sail:onLagoon currently supports the following service types:
MySQL
PostgreSQL
MariaDB
Redis
MeiliSearch
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Acknowledgements
Initial Laravel bootstrap code provided by Workshop Orange.
License
The MIT License (MIT). Please see License File for more information.