Laravel Envoy is a task automation tool that simplifies deployment and task execution in Laravel applications. It allows you to define and run tasks using a simple syntax, making it easy to automate repetitive tasks such as deployments, running tests, and managing server processes.
Key Features
- Task Automation: Define and automate repetitive tasks using a straightforward syntax.
- SSH Support: Execute commands on remote servers over SSH, making it suitable for deployment processes.
- Simplified Syntax: Use a clean and expressive syntax for defining tasks, reducing complexity.
- Integration with Laravel: Seamlessly integrates with your Laravel application and environment.
- Parallel Execution: Execute tasks on multiple servers in parallel, improving efficiency.
Installation
To install Laravel Envoy, you can use Composer:
bash
1 |
composer global require laravel/envoy |
Ensure that the Composer vendor/bin
directory is in your system’s PATH to access the envoy
command easily.
Configuration
- Create an Envoy.blade.php File:In the root of your Laravel project, create a file named
Envoy.blade.php
. This file will contain your task definitions.bash
1touch Envoy.blade.php - Define Your Tasks:In
Envoy.blade.php
, you can define your tasks using the Blade syntax. Here’s an example of a basic deployment task:php
1234567@task('deploy', ['on' => 'server_name'])cd /path/to/your/projectgit pull origin maincomposer install --no-interaction --prefer-distphp artisan migrate --forcephp artisan config:cache@endtaskIn this example:
- The
@task
directive defines a task nameddeploy
. - The
['on' => 'server_name']
option specifies the server on which the task will run. - The commands inside the task will execute on the specified server.
- The
Running Tasks
To run a task, use the envoy run
command followed by the task name:
bash
1 |
envoy run deploy |
Using Multiple Servers
You can easily define tasks that run on multiple servers. For example:
php
1 2 3 4 5 6 7 8 9 10 11 12 |
@servers(['web' => 'user@webserver.com', 'database' => 'user@dbserver.com']) @task('deploy', ['on' => 'web']) cd /path/to/your/project git pull origin main composer install --no-interaction --prefer-dist @endtask @task('migrate', ['on' => 'database']) cd /path/to/your/project php artisan migrate --force @endtask |
In this example, you define two tasks, one for deploying on the web server and another for running migrations on the database server.
Parallel Execution
To execute tasks in parallel, you can use the @parallel
directive. Here’s an example:
php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
@task('deploy', ['on' => 'web']) cd /path/to/your/project git pull origin main composer install --no-interaction --prefer-dist @endtask @task('migrate', ['on' => 'database']) cd /path/to/your/project php artisan migrate --force @endtask @parallel deploy migrate @endparallel |
Conclusion
Laravel Envoy is an excellent tool for automating tasks and deployments in Laravel applications. Its simple syntax and support for SSH make it easy to manage your deployment process and automate repetitive tasks. By defining tasks in a clean and readable way, you can improve your workflow and ensure consistent deployments.
- Laravel Breeze – Simple authentication starter kit
- Laravel Jetstream – Scaffolding for Laravel apps
- Laravel Passport – API authentication via OAuth2
- Laravel Sanctum – Simple API authentication
- Spatie Laravel Permission – Role and permission management
- Laravel Cashier – Subscription billing with Stripe
- Laravel Scout – Full-text search using Algolia
- Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
- Laravel Excel – Excel import and export for Laravel
- Laravel Horizon – Redis queues monitoring
- Laravel Nova – Admin panel for Laravel
- Laravel Fortify – Backend authentication for Laravel
- Laravel Vapor – Serverless deployment on AWS
- Laravel Telescope – Debugging assistant for Laravel
- Laravel Dusk – Browser testing
- Laravel Mix – API for compiling assets
- Spatie Laravel Backup – Backup management
- Laravel Livewire – Building dynamic UIs
- Spatie Laravel Media Library – Manage media uploads
- Laravel Excel – Excel spreadsheet handling
- Laravel Debugbar – Debug tool for Laravel
- Laravel WebSockets – Real-time communication
- Spatie Laravel Sitemap – Generate sitemaps
- Laravel Spark – SaaS scaffolding
- Laravel Envoy – Task runner for deployment
- Spatie Laravel Translatable – Multilingual model support
- Laravel Backpack – Admin panel
- Laravel AdminLTE – Admin interface template
- Laravel Collective Forms & HTML – Simplified form and HTML generation
- Spatie Laravel Analytics – Google Analytics integration
- Laravel Eloquent Sluggable – Automatically create slugs
- Laravel Charts – Chart integration
- Laravel Auditing – Track changes in models
- Laravel JWT Auth – JSON Web Token authentication
- Laravel Queue Monitor – Monitor job queues
- Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
- Laravel Datatables – jQuery Datatables API
- Laravel Localization – Multilingual support for views and routes
- Laravel Acl Manager – Access control list manager
- Laravel Activity Log – Record activity in your app
- Laravel Roles – Role-based access control
- Spatie Laravel Tags – Tagging models
- Laravel Installer – CLI installer for Laravel
- Laravel Breadcrumbs – Generate breadcrumbs in Laravel
- Laravel Mailgun – Mailgun integration for Laravel
- Laravel Trustup Model History – Store model change history
- Laravel Deployer – Deployment automation tool
- Laravel Auth – Custom authentication guards
- Laravel CORS – Cross-Origin Resource Sharing (CORS) support
- Laravel Notifications – Send notifications through multiple channels
- Spatie Laravel Http Logger – Log HTTP requests
- Laravel Permission Manager – Manage permissions easily
- Laravel Stubs – Customize default stubs in Laravel
- Laravel Fast Excel – Speed up Excel exports
- Laravel Image – Image processing
- Spatie Laravel Backup Server – Centralize backups for Laravel apps
- Laravel Forge API – Manage servers through the Forge API
- Laravel Blade SVG – Use SVGs in Blade templates
- Laravel Ban – Ban/unban users from your application
- Laravel API Response – Standardize API responses
- Laravel SEO – Manage SEO meta tags
- Laravel Settings – Store and retrieve settings
- Laravel DOMPDF – Generate PDFs
- Laravel Turbo – Full-stack framework for building modern web apps
- Spatie Laravel Event Sourcing – Event sourcing implementation
- Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
- Laravel Envoy Tasks – Task automation
- Laravel Likeable – Like/dislike functionality
- Laravel GeoIP – Determine visitor’s geographic location
- Laravel Country State City – Dropdowns for country, state, and city
- Laravel Hashids – Generate short unique hashes
- Laravel Repository – Repository pattern for Laravel
- Laravel UUID – UUID generation for models
- Spatie Laravel Medialibrary Pro – Enhanced media management
- Laravel Queue Monitor – Monitor Laravel job queues
- Laravel User Activity – Monitor user activity
- Laravel DB Snapshots – Create database snapshots
- Laravel Twilio – Twilio integration
- Laravel Roles – Role-based permission handling
- Laravel Translatable – Add translations to Eloquent models
- Laravel Teamwork – Manage teams in multi-tenant apps
- Laravel Full Text Search – Add full-text search to Laravel models
- Laravel File Manager – File and media management
- Laravel User Timezones – Automatically detect user time zones
- Laravel ChartsJS – Render charts with ChartsJS
- Laravel Stripe – Stripe API integration
- Laravel PDF Generator – PDF generation
- Laravel Elasticsearch – Elasticsearch integration
- Laravel Simple Qrcode – Generate QR codes
- Laravel Timezone – Manage timezones and conversions
- Laravel Collective API – API management for Laravel
- Laravel Rest API Boilerplate – REST API starter kit
- Laravel Multi Auth – Multi-authentication functionality
- Laravel Voyager – Admin panel for Laravel
- Laravel Voyager Database – Database manager for Voyager
- Laravel Categories – Handle categories for models
- Laravel Multitenancy – Multi-tenancy implementation
- Laravel Access Control – Advanced access control for users
- Laravel Menus – Menu management
- Laravel Translatable Routes – Multilingual route handling