Skip to content

A library for quickly Lagoonizing Sail based Laravel apps

License

Notifications You must be signed in to change notification settings

Workshop-Orange/sailonlagoon

 
 

Repository files navigation

Sail:onLagoon

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

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 uselagoon/sailonlagoon

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.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

A library for quickly Lagoonizing Sail based Laravel apps

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • PHP 60.1%
  • Shell 22.2%
  • Dockerfile 17.7%