Skip to main content
Version: 8.x

How to Deploy a Magento Project

require 'recipe/magento.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Magento 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 Magento consists of:

The magento recipe is based on the common recipe.

Configuration

shared_dirs

Source

Overrides shared_dirs from recipe/deploy/shared.php.

Magento Configuration Magento shared dirs

Default value
['var', 'media']

shared_files

Source

Overrides shared_files from recipe/deploy/shared.php.

Magento shared files

Default value
['app/etc/local.xml']

writable_dirs

Source

Overrides writable_dirs from recipe/deploy/writable.php.

Magento writable dirs

Default value
['var', 'media']

Tasks

deploy:cache:clear

Source

Clears cache.

Clear cache

deploy:clear_version

Source

Remove files that can be used to compromise Magento

deploy

Source

Deploys your project.

Main task

This task is group task which contains next tasks: