docs/recipe/silverstripe.md
<!-- DO NOT EDIT THIS FILE! -->
<!-- Instead edit recipe/silverstripe.php -->
<!-- Then run bin/docgen -->
# How to Deploy a Silverstripe Project
```php
require 'recipe/silverstripe.php';
```
[Source](/recipe/silverstripe.php)
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](/docs/getting-started.md).
The [deploy](#deploy) task of **Silverstripe** consists of:
* [deploy:prepare](/docs/recipe/common.md#deployprepare) – Prepares a new release
* [deploy:info](/docs/recipe/deploy/info.md#deployinfo) – Displays info about deployment
* [deploy:setup](/docs/recipe/deploy/setup.md#deploysetup) – Prepares host for deploy
* [deploy:lock](/docs/recipe/deploy/lock.md#deploylock) – Locks deploy
* [deploy:release](/docs/recipe/deploy/release.md#deployrelease) – Prepares release
* [deploy:update_code](/docs/recipe/deploy/update_code.md#deployupdate_code) – Updates code
* [deploy:shared](/docs/recipe/deploy/shared.md#deployshared) – Creates symlinks for shared files and dirs
* [deploy:writable](/docs/recipe/deploy/writable.md#deploywritable) – Makes writable dirs
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors) – Installs vendors
* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripebuildflush) – Runs /dev/build?flush=all
* [deploy:publish](/docs/recipe/common.md#deploypublish) – Publishes the release
* [deploy:symlink](/docs/recipe/deploy/symlink.md#deploysymlink) – Creates symlink to release
* [deploy:unlock](/docs/recipe/deploy/lock.md#deployunlock) – Unlocks deploy
* [deploy:cleanup](/docs/recipe/deploy/cleanup.md#deploycleanup) – Cleanup old releases
* [deploy:success](/docs/recipe/common.md#deploysuccess) –
The silverstripe recipe is based on the [common](/docs/recipe/common.md) recipe.
## Configuration
### shared_assets
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L12)
```php title="Default value"
if (test('[ -d {{release_or_current_path}}/public ]') || test('[ -d {{deploy_path}}/shared/public ]')) {
return 'public/assets';
}
return 'assets';
```
### shared_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L21)
Overrides [shared_dirs](/docs/recipe/deploy/shared.md#shared_dirs) from `recipe/deploy/shared.php`.
Silverstripe shared dirs
```php title="Default value"
[
'{{shared_assets}}'
]
```
### writable_dirs
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L26)
Overrides [writable_dirs](/docs/recipe/deploy/writable.md#writable_dirs) from `recipe/deploy/writable.php`.
Silverstripe writable dirs
```php title="Default value"
[
'{{shared_assets}}'
]
```
### silverstripe_cli_script
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L31)
Silverstripe cli script
:::info Autogenerated
The value of this configuration is autogenerated on access.
:::
## Tasks
### silverstripe:build
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L47)
Runs /dev/build.
Helper tasks
### silverstripe:buildflush
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L52)
Runs /dev/build?flush=all.
### deploy
[Source](https://github.com/deployphp/deployer/blob/master/recipe/silverstripe.php#L60)
Deploys your project.
Main task
This task is group task which contains next tasks:
* [deploy:prepare](/docs/recipe/common.md#deployprepare)
* [deploy:vendors](/docs/recipe/deploy/vendors.md#deployvendors)
* [silverstripe:buildflush](/docs/recipe/silverstripe.md#silverstripebuildflush)
* [deploy:publish](/docs/recipe/common.md#deploypublish)