Version: 7.x

How to Deploy a Laravel Project

require 'recipe/laravel.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Laravel application to a server. It is very easy to use and has a lot of features.

Three main features of Deployer are:

Provisioning - provision your server for you.
Zero downtime deployment - deploy your application without a downtime.
Rollbacks - rollback your application to a previous version, if something goes wrong.

Additionally, Deployer has a lot of other features, like:

Easy to use - Deployer is very easy to use. It has a simple and intuitive syntax.
Fast - Deployer is very fast. It uses parallel connections to deploy your application.
Secure - Deployer uses SSH to connect to your server.
Supports all major PHP frameworks - Deployer supports all major PHP frameworks.

You can read more about Deployer in Getting Started.

The deploy task of Laravel consists of:

deploy:prepare – Prepares a new release
- deploy:info –
- deploy:setup – Prepares host for deploy
- deploy:lock – Locks deploy
- deploy:release – Prepares release
- deploy:update_code –
- deploy:shared – Creates symlinks for shared files and dirs
- deploy:writable – Makes writable dirs
deploy:vendors – Installs vendors
artisan:storage:link – Creates the symbolic links configured for the application
artisan:config:cache – Creates a cache file for faster configuration loading
artisan:route:cache – Creates a route cache file for faster route registration
artisan:view:cache – Compiles all of the application\'s Blade templates
artisan:event:cache – Discovers and cache the application\'s events and listeners
artisan:migrate – Runs the database migrations
deploy:publish – Publishes the release
- deploy:symlink – Creates symlink to release
- deploy:unlock – Unlocks deploy
- deploy:cleanup – Cleanup old releases
- deploy:success –

The laravel recipe is based on the common recipe.

Configuration

shared_dirs

Source

Overrides shared_dirs from recipe/deploy/shared.php.

Default value
['storage']

shared_files

Source

Overrides shared_files from recipe/deploy/shared.php.

Default value
['.env']

writable_dirs

Source

Overrides writable_dirs from recipe/deploy/writable.php.

Default value
[
    'bootstrap/cache',
    'storage',
    'storage/app',
    'storage/app/public',
    'storage/framework',
    'storage/framework/cache',
    'storage/framework/cache/data',
    'storage/framework/sessions',
    'storage/framework/views',
    'storage/logs',
]

log_files

Source

Default value

'storage/logs/*.log'

laravel_version

Source

Default value
$result = run('{{bin/php}} {{release_or_current_path}}/artisan --version');
preg_match_all('/(\d+\.?)+/', $result, $matches);
return $matches[0][0] ?? 5.5;