Installation
Install the package with Composer:
composer require mozex/laravel-compose
The service provider registers itself through package discovery. Run the install command when you want to change a default:
php artisan compose:install
That writes config/compose.php. The Configuration page explains every key.
What the server needs
- Docker Engine with the Compose plugin, version 2.17 or newer, so
docker compose versionworks. Ploi's Docker server type and Forge's Docker install both provide it; on a plain Ubuntu box, follow Docker's own install guide and adddocker-compose-plugin. - The user that runs your deploy in the
dockergroup. Without it, every command fails withpermission deniedon the daemon socket.
Run the doctor after installing to confirm both:
php artisan compose:doctor
Hosts without Docker
Nothing here requires Docker to be present. A stack whose enabled() returns false is skipped, and COMPOSE_ENABLED=false skips every stack on a host. CI, local machines that use a natively installed service instead, and staging boxes without Docker all run the same deploy script unchanged.
Next step
Scaffold your first stack with php artisan compose:make {name} and read Defining a Stack.