Laravel Deployer – Deployment automation tool

Laravel Deployer is a deployment automation tool designed to simplify and automate the deployment of Laravel applications. It allows you to deploy code to your server seamlessly and efficiently, with support for features like atomic deployments, parallel execution, and rollbacks.

Key Features:

1. Zero-Downtime Deployments: Ensure your application stays online while deploying new code.
2. Automated Tasks: Automate common deployment tasks like updating dependencies, running migrations, and clearing caches.
3. Rollback Support: Easily roll back to a previous release if something goes wrong.
4. Parallel Execution: Run tasks across multiple servers in parallel for speed and efficiency.

Installation and Setup

1. Install Deployer

You can use Deployer via Composer by installing it as a dependency in your Laravel project:

Alternatively, you can install it globally:

2. Initialize Deployer

To set up Deployer in your Laravel project, run the following command to create the deploy.php file, which contains the configuration for your deployment:

This command will prompt you to select the type of deployment you want. Choose Laravel from the list of templates.

3. Configure Deployment

The deploy.php file will be created in the root of your Laravel project. It contains all the configurations and tasks that will be executed during deployment.

Here’s an example configuration file:

Deployment Workflow

A typical deployment with Laravel Deployer involves the following steps:

1. Clone the repository: Deployer will pull the latest code from your Git repository.
2. Install dependencies: Composer dependencies will be installed on the server.
3. Run migrations: Laravel database migrations will be executed to keep the database schema up to date.
4. Symlink the new release: The new release is symlinked to the current directory to make it live.
5. Clear cache: Laravel’s cache will be cleared to ensure the application runs with the latest configurations and data.

Running Deployments

Once your deploy.php configuration is ready, you can run the deployment process with:

This will execute the deployment to the server specified in the deploy.php configuration.

Rollbacks

If something goes wrong during deployment, you can quickly roll back to the previous version using the following command:

This will restore the symlink to point to the previous release, effectively rolling back the application.

Custom Tasks

You can also define custom tasks in the deploy.php file. For example, if you want to clear the cache after deployment, you can create a custom task like this:

Then, hook it into the deployment process:

Additional Features

• Parallel Execution: Deployer can run tasks across multiple servers in parallel for faster deployment.
• Zero-Downtime Deployments: By using atomic symlinking, Deployer ensures that your application remains available during deployment.
• Notifications: You can integrate notifications (Slack, Telegram, etc.) to notify your team when deployments succeed or fail.

Conclusion

Laravel Deployer simplifies the process of deploying Laravel applications by automating repetitive tasks and providing features like rollback and zero-downtime deployments. With minimal configuration, you can quickly set up automated deployments, ensuring your application is consistently deployed and available.

Output

The output of using Laravel Deployer is generally seen during and after the deployment process.

1. Command-Line Output During Deployment

When you run the deployment command (dep deploy), Deployer will output the progress of each task in the terminal:

Example command:

The command-line output will look something like this:

2. Error Output

If there are any issues during deployment, Deployer will show error messages in the terminal. For example, if there’s a problem with permissions on the server, you might see an error like this:

3. Log Files on the Server

Deployer creates a releases directory on the server where it stores all the release versions of your application. Each release has its own directory named with a timestamp. You can view logs for each release by checking the deployment log files (if logging is enabled) or looking at Laravel’s logs in the storage/logs/laravel.log file.

4. Rollback Output

If you perform a rollback with:

The output will show the rollback steps:

This confirms that the symlink has been switched back to the previous release.

5. After Deployment: Viewing the Deployed App

Once deployment is completed, you can view your live application by visiting the domain associated with your server (e.g., https://your-app.com). The changes from the new release will be live, and any deployment tasks like database migrations, cache clearing, or asset compilation will have taken effect.

Summary of Outputs:

• Terminal Output: During deployment, the terminal provides real-time feedback on tasks being executed.
• Error Output: If something fails, error messages are shown in the terminal.
• Server Log Files: Check the storage/logs/laravel.log for detailed logs about your application after deployment.
• Application: You’ll see the final deployed version of your Laravel app by visiting your server or domain.

1. Laravel Breeze – Simple authentication starter kit
2. Laravel Jetstream – Scaffolding for Laravel apps
3. Laravel Passport – API authentication via OAuth2
4. Laravel Sanctum – Simple API authentication
5. Spatie Laravel Permission – Role and permission management
6. Laravel Cashier – Subscription billing with Stripe
7. Laravel Scout – Full-text search using Algolia
8. Laravel Socialite – OAuth authentication (Google, Facebook, etc.)
9. Laravel Excel – Excel import and export for Laravel
10. Laravel Horizon – Redis queues monitoring
11. Laravel Nova – Admin panel for Laravel
12. Laravel Fortify – Backend authentication for Laravel
13. Laravel Vapor – Serverless deployment on AWS
14. Laravel Telescope – Debugging assistant for Laravel
15. Laravel Dusk – Browser testing
16. Laravel Mix – API for compiling assets
17. Spatie Laravel Backup – Backup management
18. Laravel Livewire – Building dynamic UIs
19. Spatie Laravel Media Library – Manage media uploads
20. Laravel Excel – Excel spreadsheet handling
21. Laravel Debugbar – Debug tool for Laravel
22. Laravel WebSockets – Real-time communication
23. Spatie Laravel Sitemap – Generate sitemaps
24. Laravel Spark – SaaS scaffolding
25. Laravel Envoy – Task runner for deployment
26. Spatie Laravel Translatable – Multilingual model support
27. Laravel Backpack – Admin panel
28. Laravel AdminLTE – Admin interface template
29. Laravel Collective Forms & HTML – Simplified form and HTML generation
30. Spatie Laravel Analytics – Google Analytics integration
31. Laravel Eloquent Sluggable
    Advertisement
    – Automatically create slugs
32. Laravel Charts – Chart integration
33. Laravel Auditing – Track changes in models
34. Laravel JWT Auth – JSON Web Token authentication
35. Laravel Queue Monitor – Monitor job queues
36. Spatie Laravel Query Builder – Filter, sort, and include relationships in Eloquent queries
37. Laravel Datatables – jQuery Datatables API
38. Laravel Localization – Multilingual support for views and routes
39. Laravel Acl Manager – Access control list manager
40. Laravel Activity Log – Record activity in your app
41. Laravel Roles – Role-based access control
42. Spatie Laravel Tags – Tagging models
43. Laravel Installer – CLI installer for Laravel
44. Laravel Breadcrumbs – Generate breadcrumbs in Laravel
45. Laravel Mailgun – Mailgun integration for Laravel
46. Laravel Trustup Model History – Store model change history
47. Laravel Deployer – Deployment automation tool
48. Laravel Auth – Custom authentication guards
49. Laravel CORS – Cross-Origin Resource Sharing (CORS) support
50. Laravel Notifications – Send notifications through multiple channels
51. Spatie Laravel Http Logger – Log HTTP requests
52. Laravel Permission Manager – Manage permissions easily
53. Laravel Stubs – Customize default stubs in Laravel
54. Laravel Fast Excel – Speed up Excel exports
55. Laravel Image – Image processing
56. Spatie Laravel Backup Server – Centralize backups for Laravel apps
57. Laravel Forge API – Manage servers through the Forge API
58. Laravel Blade SVG – Use SVGs in Blade templates
59. Laravel Ban – Ban/unban users from your application
60. Laravel API Response – Standardize API responses
61. Laravel SEO – Manage SEO meta tags
62. Laravel Settings – Store and retrieve settings
63. Laravel DOMPDF – Generate PDFs
64. Laravel Turbo – Full-stack framework for building modern web apps
65. Spatie Laravel Event Sourcing – Event sourcing implementation
66. Laravel Jetstream Inertia – Jetstream’s Inertia.js integration
67. Laravel Envoy Tasks – Task automation
68. Laravel Likeable – Like/dislike functionality
69. Laravel GeoIP – Determine visitor’s geographic location
70. Laravel Country State City – Dropdowns for country, state, and city
71. Laravel Hashids – Generate short unique hashes
72. Laravel Repository – Repository pattern for Laravel
73. Laravel UUID – UUID generation for models
74. Spatie Laravel Medialibrary Pro – Enhanced media management
75. Laravel Queue Monitor – Monitor Laravel job queues
76. Laravel User Activity – Monitor user activity
77. Laravel DB Snapshots – Create database snapshots
78. Laravel Twilio – Twilio integration
79. Laravel Roles – Role-based permission handling
80. Laravel Translatable – Add translations to Eloquent models
81. Laravel Teamwork – Manage teams in multi-tenant apps
82. Laravel Full Text Search – Add full-text search to Laravel models
83. Laravel File Manager – File and media management
84. Laravel User Timezones – Automatically detect user time zones
85. Laravel ChartsJS – Render charts with ChartsJS
86. Laravel Stripe – Stripe API integration
87. Laravel PDF Generator – PDF generation
88. Laravel Elasticsearch – Elasticsearch integration
89. Laravel Simple Qrcode – Generate QR codes
90. Laravel Timezone – Manage timezones and conversions
91. Laravel Collective API – API management for Laravel
92. Laravel Rest API Boilerplate – REST API starter kit
93. Laravel Multi Auth – Multi-authentication functionality
94. Laravel Voyager – Admin panel for Laravel
95. Laravel Voyager Database – Database manager for Voyager
96. Laravel Categories – Handle categories for models
97. Laravel Multitenancy – Multi-tenancy implementation
98. Laravel Access Control – Advanced access control for users
99. Laravel Menus – Menu management
100. Laravel Translatable Routes – Multilingual route handling