Laravel Envoy is a simple and elegant task runner for deploying PHP applications. It allows you to define deployment scripts in a clean syntax and easily automate tasks such as deploying code, clearing caches, running migrations, and more. Envoy is particularly useful for streamlining the deployment process, ensuring consistency, and reducing human error.
Key Features of Laravel Envoy:
- Simple Syntax: Define tasks using a straightforward and expressive syntax, making it easy to read and write.
- SSH Support: Execute tasks on remote servers via SSH, allowing for seamless deployment to production environments.
- Flexible Configuration: Customize tasks and configurations to suit your specific deployment needs.
- Built-in Helpers: Comes with built-in methods for common deployment tasks, like running Artisan commands, uploading files, and more.
- Environment Variables: Manage environment variables easily for different deployment stages.
Installation
To get started with Laravel Envoy, follow these steps:
- Install Envoy: You can install Laravel Envoy globally using Composer:
1composer global require laravel/envoy - Ensure Global Composer Bin is in Your PATH: Make sure that the Composer global bin directory is in your system’s PATH. You can check this by running:
1echo $PATH~/.composer/vendor/bin
or~/.config/composer/vendor/bin
- Create an Envoy.blade.php File: In the root of your project, create an
Envoy.blade.php
file. This file will contain your deployment tasks.
Defining Tasks
Here’s how you can define tasks in your Envoy.blade.php
file:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
@task('deploy', ['on' => 'server']) echo 'Deploying the application...'; // Navigate to the application directory cd /path/to/your/application; // Pull the latest changes from the repository git pull origin main; // Install dependencies composer install --no-dev; // Run migrations php artisan migrate --force; // Clear caches php artisan cache:clear; echo 'Deployment completed successfully!'; @endtask |
Running Tasks
To run a defined task, you can use the Envoy command in your terminal:
1 |
envoy run deploy |
Configuring SSH Connections
You can configure your SSH connections within the Envoy.blade.php
file by using the @on
directive. Here’s an example:
1 2 3 4 5 6 7 8 9 10 11 12 13 |
@setup $servers = [ 'production' => [ 'host' => 'your-server.com', 'user' => 'your-username', 'identityFile' => '/path/to/your/private/key', ], ]; @endsetup @task('deploy', ['on' => 'production']) // Your deployment tasks here @endtask |
Example of Multiple Tasks
You can also define multiple tasks and execute them in sequence:
1 2 3 4 5 6 7 8 9 10 |
@task('build', ['on' => 'production']) echo 'Building the assets...'; npm install; npm run production; @endtask @task('deploy', ['on' => 'production']) // Your deployment tasks here @include('build'); @endtask |
Conclusion
Laravel Envoy is a powerful tool that simplifies the deployment process for PHP applications. Its elegant syntax, combined with SSH support and flexible configuration options, makes it an excellent choice for developers looking to automate their deployment tasks efficiently.
Additional Considerations
- Documentation: For more detailed instructions and advanced features, refer to the official Laravel Envoy documentation.
- Error Handling: Consider implementing error handling within your tasks to manage failures gracefully during deployment.
- 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