How to Deploy a Craftcms Project
require 'recipe/craftcms.php';
Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Craftcms 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 Craftcms consists of:
- deploy:prepare – Prepares a new release
- deploy:info – Displays info about deployment
- deploy:setup – Prepares host for deploy
- deploy:lock – Locks deploy
- deploy:release – Prepares release
- deploy:update_code – Updates code
- deploy:env – Configure .env file
- deploy:shared – Creates symlinks for shared files and dirs
- deploy:writable – Makes writable dirs
- deploy:vendors – Installs vendors
The craftcms recipe is based on the common recipe.
Configuration
log_files
Default value
'storage/logs/*.log'
shared_dirs
Overrides shared_dirs from recipe/deploy/shared.php.
Default value
[
'storage',
'web/assets',
]
shared_files
Overrides shared_files from recipe/deploy/shared.php.
Default value
['.env']
writable_dirs
Overrides writable_dirs from recipe/deploy/writable.php.
Default value
[
'config/project',
'storage',
'web/assets',
'web/cpresources',
]
Tasks
craft:gc
Runs garbage collection.
Garbage collection
deploy
Deploys Craft CMS.
Main deploy
This task is group task which contains next tasks: