How to Deploy a Silverstripe Project

php

require 'recipe/silverstripe.php';

Source

Deployer is a free and open source deployment tool written in PHP. It helps you to deploy your Silverstripe 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 Silverstripe 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
silverstripe:buildflush – Rebuild database and cache
deploy:publish – Publishes the release
- deploy:symlink – Creates symlink to release
- deploy:unlock – Unlocks deploy
- deploy:cleanup – Cleanup old releases
- deploy:success – Deploys your project

The silverstripe recipe is based on the common recipe.

Configuration

shared_assets

Source

Path to the assets folder. Defaults to "public/assets" (or "assets" on older installations).

php

if (test('[ -d {{release_or_current_path}}/public ]') || test('[ -d {{deploy_path}}/shared/public ]')) {
return 'public/assets';
}
return 'assets';

shared_dirs

Source

Overrides shared_dirs from recipe/deploy/shared.php.

php

[
    '{{shared_assets}}',
]

writable_dirs

Source

Overrides writable_dirs from recipe/deploy/writable.php.

php

[
    '{{shared_assets}}',
]

silverstripe_sake

Source

Path to the sake binary. Defaults to "vendor/bin/sake", if it exists. :::info Autogenerated The value of this configuration is autogenerated on access. :::

silverstripe_cli_script

Source

Deprecated option, retained for backward compatibility. For Silverstripe 6 and above, use silverstripe_sake instead. :::info Autogenerated The value of this configuration is autogenerated on access. :::

Tasks

silverstripe:build {#silverstripe-build}

Source

Rebuild the database.

Helper tasks

silverstripe:buildflush {#silverstripe-buildflush}

Source

Rebuild database and cache.

deploy {#deploy}

Source

Deploys your project.

Main task

This task is group task which contains next tasks: